amplify_datastore_plugin_interface library

Classes

AuthRule
BeginsWithQueryOperator
BetweenQueryOperator<T extends Comparable<Object?>>
ConflictData
ConflictResolutionDecision
ContainsQueryOperator
DataStoreExceptionMessages
Commonly used cross-category error messages.
DataStoreHubEvent
DataStore periodically publishes state notifications onto Amplify's Hub. You can subscribe to the Hub to gain insight into the internal state of the DataStore.
DataStoreHubEventPayload
DataStoreSyncExpression
Sync expression to configure DataStore plugin with. These expressions include query predicates which specify filters for selectively persisting a subset of data to the local device
EqualModelIdentifierQueryOperator<T extends ModelIdentifier<Model>>
EqualQueryOperator<T>
GreaterOrEqualQueryOperator<T extends Comparable<Object?>>
GreaterThanQueryOperator<T extends Comparable<Object?>>
HubEventElement<M extends Model>
The model associated with a DataStore outboxMutationEnqueued or outboxMutationProcessed Hub event.
HubEventElementWithMetadata<M extends Model>
The model and metadata associated with a DataStore outboxMutationProcessed Hub event.
LessOrEqualQueryOperator<T extends Comparable<Object?>>
LessThanQueryOperator<T extends Comparable<Object?>>
Model
ModelField
ModelFieldDefinition
ModelFieldType
ModelIdentifier<T extends Model>
Model identifier presentation
ModelProviderInterface
ModelSchema
ModelSchemaDefinition
ModelSyncedEvent
ModelType<T extends Model>
NetworkStatusEvent
NotEqualModelIdentifierQueryOperator<T extends ModelIdentifier<Model>>
NotEqualQueryOperator<T>
ObserveQueryThrottleOptions
Options for throttling events emitted from ObserveQuery during the sync process
OutboxMutationEvent
OutboxStatusEvent
QueryByIdentifierOperation
QueryField<T>
A field used to query models.
QueryFieldOperator<T>
QueryFieldOperatorSingleValue<T>
QueryPagination
QueryPredicate<T extends Model>
Represents individual conditions or groups of conditions that are used to query data
QueryPredicateGroup
QueryPredicateOperation
QuerySnapshot<T extends Model>
A snapshot consisting of the items in the local store when the snapshot was generated and a boolean value to indicate if this model has finished syncing data over the network.
QuerySortBy
Represents a model field and an order to sort by (ascending or descending), used to specify the order of results from a query operation
SortedList<E>
An Object that holds a list that maintains a specifc sort order
SubscriptionDataProcessedEvent<M extends Model>
SubscriptionEvent<T extends Model>
An event containing the details of mutations that have occurred on the backend
SyncQueriesStartedEvent
TemporalDate
Represents a valid extended ISO-8601 Date string, with an optional timezone offset. YYYY-MM-DD±hh:mm:ss (ISO_OFFSET_DATE) or YYYY-MM-DD (ISO_LOCAL_DATE) https://docs.aws.amazon.com/appsync/latest/devguide/scalars.html#appsync-defined-scalars
TemporalDateTime
Represents a valid extended ISO-8601 DateTime string. The time zone offset is compulsory. YYYY-MM-DDThh:mm:ss.sssZ (ISO_OFFSET_DATE_TIME) https://docs.aws.amazon.com/appsync/latest/devguide/scalars.html#appsync-defined-scalars
TemporalTime
Represents a valid extended ISO-8601 Time string, with an optional timezone offset. hh:mm:ss.sss±hh:mm:ss hh:mm:ss.sss https://docs.aws.amazon.com/appsync/latest/devguide/scalars.html#appsync-defined-scalars
TemporalTimestamp
The Temporal.Timestamp scalar type represents the number of seconds that have elapsed since 1970-01-01T00:00Z. Timestamps are serialized and deserialized as numbers. Negative values are also accepted and these represent the number of seconds til 1970-01-01T00:00Z.

Enums

AuthModeStrategy
Represents different auth strategies supported by a client interfacing with an AppSync backend
AuthRuleProvider
AuthStrategy
DataStoreHubEventType
The type of the DataStore Hub event.
EventType
The different type of mutations that may be observed
ModelFieldTypeEnum
ModelOperation
QueryFieldOperatorType
QueryPredicateConstantType
QueryPredicateGroupType
QuerySortOrder
ResolutionStrategy

Functions

getFieldName(String fieldName) → String
Removes the model name that is pre-pended to id fields.
not(QueryPredicate<Model> predicate) → QueryPredicateGroup

Exceptions / Errors

DataStoreException
Exception thrown from DataStore Category