apptive_grid_grid_builder library

Classes

ActionItem
Wrapper class to use in ApptiveGridCache
ActorFilter
Filter to use with DataType.createdBy to filter for a Specific ActorFilterableMixin
AddAttachmentAction
Implementation of an AttachmentAction for AttachmentActionType.add
AfterSubmitAction
The AfterSubmitAction class represents an action to be taken after a form is submitted.
AllOfFilter
Filter to check if a CollectionDataEntity contains all of the values in value
AndFilterComposition
Creates a Filter that checks that all conditions are true
AnyOfFilter
Filter to check if a CollectionDataEntity contains any of the values in value
ApptiveGrid
A Base Widget needed to add general ApptiveGrid functionality to a Flutter App
ApptiveGridApiKey
Model to Handle Api Key Authentication
ApptiveGridAuthenticationOptions
Model for authentication options
ApptiveGridCache
Cache for saving Actions to a cache to enable sending them later
ApptiveGridClient
Api Client to communicate with the ApptiveGrid Backend
ApptiveGridFilter
Filter to load a Grid with a specific Filter
ApptiveGridGridBuilder
Builder for building Widgets that use Grid as the Data Source
ApptiveGridGridBuilderState
State of a ApptiveGridGridBuilder Widget
ApptiveGridOptions
Configuration options for ApptiveGrid
ApptiveGridSorting
Basic Sorting operation
A Link that is found in the _links section of a response
Attachment
Model for Attachment
AttachmentAction
Abstract class describing an Attachment Action
AttachmentCompleteProgressEvent
Event indicating that all Attachments have been processed
AttachmentConfiguration
Configuration for ApiEndpoints to support Attachments
AttachmentDataEntity
DataEntity representing an array of Attachments
BooleanDataEntity
DataEntity representing boolean Objects
CreatedBy
Object representing a CreatedBy Field
CreatedByDataEntity
DataEntity representing CreatedBys
CrossReferenceDataEntity
DataEntity representing an Object CrossReferencing to a different Grid
CurrencyDataEntity
DataEntity to display a currency
CurrencyGridField
A GridField for DataType.currency
DataEntity<T, S>
Model representing a DataEntry from ApptiveGrid
DataUser
A User Object that is held in a UserDataEntity
DateDataEntity
DataEntity representing a Date Internally this is using DateTime ignoring the Time Part
DateTimeDataEntity
DataEntity representing DateTime Objects
DecimalDataEntity
DataEntity representing double Objects
DeleteAttachmentAction
Implementation of an AttachmentAction for AttachmentActionType.delete
DistanceApptiveGridSorting
ApptiveGridSorting that sorts items by distance to a specific Geolocation
EmailDataEntity
DataEntity representing an email
EntitiesResponse<T>
Response when loading entities of a Grid with ApptiveGridClient.loadEntities
EnumCollectionDataEntity
DataEntity representing an enum like Object
EnumDataEntity
DataEntity representing an enum like Object
EqualsFilter
Filter to check if a GridField's value is equal to value
ErrorProgressEvent
Event indicating that a Form Submission has failed
FormComponent<T extends DataEntity>
Data Object that represents a entry in a Form
FormComponentOptions
FormComponentOptions for Text Based Components
FormData
Model for FormData
FormDataProperties
Additional properties for the FormData
FormFieldProperties
Additional properties of a form field (FormComponent)
FormTextBlock
A freeform text block inside of a form
FormulaDataEntity
DataEntity representing a Formula
FormulaField
A GridField for DataType.formula
FormWidgetConfiguration
A Configuration for FormWidgets needed for certain DataTypes with apptive_grid_form
Geolocation
Object representing a Geolocation by latitude and longitude
GeolocationDataEntity
DataEntity representing Geolocations
GreaterThanFilter
Filter to check if a value is greater than value
Grid
Model for GridData
GridEntry
Model for a Cell Entry in a Grid
GridField
Model representing a Field in a Grid
GridRow
Model for a Row in a Grid
IntegerDataEntity
DataEntity representing int Objects
Invitation
A Object representing a Invitation
IsEmptyFilter
Filter to check if a Field is Empty
LesserThanFilter
Filter to check if a value is lesser than value
LoggedInUser
Filter columns by the logged in user This works for DataType.createdBy and DataType.assignee If filtering for a field with DataType.createdBy you should combine it with ActorFilter
LookUpDataEntity
DataEntity representing a LookUp
LookUpGridField
A GridField for DataType.lookUp
MultiCrossReferenceDataEntity
DataEntity representing a list of objects CrossReferencing to a different Grid
NoneOfFilter
Filter to check if a CollectionDataEntity contains none of the values in value
NotFilter
Filter to negate a specific filter
OrFilterComposition
Creates a Filter that checks that one FilterCondition in conditions is true
PageMetaData
A class representing a response containing the paging meta data.
PhoneNumberDataEntity
DataEntity representing an email
ProcessedAttachmentProgressEvent
Event indicating that an Attachment has been processed
ReducedLookUpDataEntity
DataEntity representing a SumUp
ReducedLookUpField
A GridField for DataType.reducedLookUp
RenameAttachmentAction
Implementation of an AttachmentAction for AttachmentActionType.delete
Share
A Object representing a Share
SharedSpace
A Space shared with a User
SignatureDataEntity
DataEntity representing a signature
Space
Model for a Space
StringDataEntity
DataEntity representing String Objects
SubmitCompleteProgressEvent
Event indicating that a Form has been completed
SubmitFormProgressEvent
An Event indicating that a Form Submission has progressed
SubstringFilter
Filter to check for a Substring
SView
A class for a Statefull View
SViewSlot
A slot of a sview
Today
Filter Columns with Type DataType.date to today.
UploadFormProgressEvent
Event indicating that a Form Submission is send to ApptiveGrid
UriDataEntity
DataEntity to representing a Uri
User
Model for a User
UserDataEntity
DataEntity representing a DataUser
ValueType
The result type of the formula

Enums

AfterSubmitActionTrigger
The trigger of an AfterSubmitAction.
AfterSubmitActionType
The type of an AfterSubmitAction.
ApptiveGridEnvironment
Possible Stages/Environment ApptiveGrid can point to
ApptiveGridHalVersion
Enumeration of possible HalVersion to be used to enable specific features/formats of responses
ApptiveGridLayout
Defines the Layout of an Entity that is returned by ApptiveGrid
ApptiveLinkType
Available Links
CreatedByType
Different types that have created a specific entity
DataType
The Data Types that are available in ApptiveGrid
FormTextBlockStyle
Styles of the text blocks in a form
Role
A collection of all possible roles users can have in a share
SortOrder
Order that entities can be sorted
SViewType
Available View Types

Mixins

ActorFilterableMixin
Mixin for Filtering on DataType.createdBy to check if they have been created by a specific Actor
CollectionFilterableMixin
Mixin for DataEntities that support Collection Filters like AnyOfFilter, AllOfFilter and NoneOfFilter
ComparableFilterableMixin
Mixin for DataEntities that support Comparison Filters like LesserThanFilter and GreaterThanFilter
FilterableMixin
Mixin for DataEntities that can be used in Filters

Extensions

LinkMapX
Extensions for LinkMap

Functions

attachmentConfigurationMapFromConfigString(String configString) Map<ApptiveGridEnvironment, AttachmentConfiguration?>
Converts a configString to an actual map of ApptiveGridEnvironment and ApptiveGridConfiguration
enableWebAuth(ApptiveGridOptions options) Future<void>
Enable Authentication on the Web This is using a conditional import to listen for Authentication on the Web
linkMapFromJson(Map<String, dynamic>? json) LinkMap
Parses json into a LinkMap The keys in json are expected to be the name of a ApptiveLinkType If the name does not match a know ApptiveLinkType the entry will be ignored

Typedefs

LinkMap = Map<ApptiveLinkType, ApptiveLink>
A Map of Links