apptive_grid_grid_builder library Null safety

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
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
ApptiveGridAuthenticator
Class for handling authentication related methods for ApptiveGrid
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
ApptiveGridUri
Base class used to represent Objects with a Uri
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
AttachmentProcessor
Processor for Attachments. Handles uploading attachments, creating attachments, scaling images
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
DirectFormUri
A FormUri for a Form represented by a direct Link
DistanceApptiveGridSorting
ApptiveGridSorting that sorts items by distance to a specific Geolocation
EntitiesResponse<T>
Response when loading entities of a Grid with ApptiveGridClient.loadEntities
EntityUri
A Uri representation used for performing Grid based Api Calls
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
FormAction
Model for a Action inside a Form
FormComponent<T extends DataEntity>
Data Object that represents a entry in a Form
FormComponentOptions
FormComponentOptions for Text Based Components
FormData
Model for FormData
FormUri
A Uri representation used for performing Form based Api Calls
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
GridUri
A Uri representation used for performing Grid based Api Calls
GridViewUri
A Uri representing a GridView
HttpHeaders
HttpHeaders Used in ApptiveGrid Requests These are normally part of dart:io which would limit the functionality for the web
IAuthenticator
Interface to provide common functionality for authorization operations
IntegerDataEntity
DataEntity representing int Objects
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
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
ProcessedAttachmentProgressEvent
Event indicating that an Attachment has been processed
RedirectFormUri
A FormUri for a Form represented by a redirect Link
RenameAttachmentAction
Implementation of an AttachmentAction for AttachmentActionType.delete
SharedSpace
A Space shared with a User
Space
Model for a Space
SpaceUri
A Uri representation used for performing Space based Api Calls
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
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

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

ApptiveLinkX
Extension for ApptiveLinks
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

Enums

ApptiveGridEnvironment
Possible Stages/Environment ApptiveGrid can point to
ApptiveGridLayout
Defines the Layout of an Entity that is returned by ApptiveGrid
ApptiveLinkType
Available Links
AttachmentActionType
Attachment actions that can be performed before uploading an attachment to apptive grid
CreatedByType
Different types that have created a specific entity
DataType
The Data Types that are available in ApptiveGrid
SortOrder
Order that entities can be sorted
UriType
The type that a ApptiveGridUri is pointing to

Typedefs

LinkMap = Map<ApptiveLinkType, ApptiveLink>
A Map of Links
UserReference = CreatedBy
Deprecated Object representing a CreatedBy Field
@Deprecated('Use CreatedBy instead')
UserReferenceDataEntity = CreatedByDataEntity
Deprecated DataEntity representing CreatedBys
@Deprecated('Use CreatedByDataEntity instead')
UserReferenceType = CreatedByType
Deprecated types that have created a specific entity
@Deprecated('Use CreatedByType instead')