amplify_core
library
Classes
AmplifyAuthProvider
AmplifyAuthProviderRepository
AmplifyAuthProviderToken <T extends AmplifyAuthProvider >
An identifier to use as a key in an AmplifyAuthProviderRepository so that
a retrieved auth provider can be typed more accurately.
AmplifyCategory <P extends AmplifyPluginInterface >
Base functionality for Amplify categories.
AmplifyClass
Amplify singleton class.
AmplifyConfig
The configuration for Amplify libraries.
AmplifyDependencyManager
A DependencyManager for Amplify plugins initialized with default Amplify
dependencies.
AmplifyExceptionMessages
Commonly used cross-category error messages.
AmplifyHttpClient
Base client for Amplify HTTP operations.
AmplifyHub
Amplify Hub provides realtime notifications to events in the different
categories.
AmplifyLogger
A logging utility providing the ability to emit log entries, configure the
level at which entries are emitted, and register plugins which can handle
log entries as they're emitted.
AmplifyOutputs
The amplify outputs generated by Amplify Gen 2 for
Amplify libraries to communicate with backend services.
AmplifyPluginConfig
Plugins must implement this class before they can be registered with
AmplifyPluginRegistry .
AmplifyPluginConfigFactory <T extends AmplifyPluginConfig >
A class for building plugins of type T.
AmplifyPluginConfigMap
A map of Amplify Plugin names to their typed representations.
AmplifyPluginInterface
Base class for all Amplify plugins.
AmplifyPluginKey <P extends AmplifyPluginInterface >
A plugin identifier which can be passed to a category's getPlugin method
to retrieve a plugin-specific category wrapper.
AmplifyPluginRegistry
A registry for AmplifyPluginConfig types. Used for serializing and
deserializing plugin configurations.
AmplifyUserAgent
Aggregates user agent values throughout the Amplify categories.
AnalyticsCategory
AnalyticsConfig
The Analytics category configuration.
AnalyticsEvent
AnalyticsPluginInterface
APIAuthProvider
Handles the retrieval of authentication tokens for third-party providers.
APICategory
ApiConfig
The API category configuration.
ApiHubEvent
ApiHubEventPayload
ApiKeyAmplifyAuthProvider
ApiKeyAuthProviderOptions
APIPluginInterface
ApnsPlatformOptions
Holds Apple Push Notification service (APNS) specific options for push notifications.
AppPathProvider
AttributeExistsQueryOperator <T >
AuthCategory
Auth
The Amplify Auth category provides an interface for authenticating a user.
AuthCodeDeliveryDetails
Auth
Details on where a confirmation code has been delivered.
AuthConfig
The Auth category configuration.
AuthDevice
Auth
Common interface for devices tracked by an authentication provider.
AuthHubEvent
Auth
The base class for hub events of the Auth category.
AuthNextSignInStep
Auth
AuthNextSignUpStep
Auth
AuthNextStep
Auth
AuthNextUpdateAttributeStep
Auth
This wraps all the details around the next step in the user attribute update process.
AuthPluginInterface
A plugin for the Amplify Auth category.
AuthPluginKey <Plugin extends AuthPluginInterface >
A plugin identifier which can be passed to the Auth category's getPlugin
method to retrieve a plugin-specific Auth category wrapper.
AuthProvider
Auth
AuthProviderOptions
AuthRule
AuthSession
Auth
AuthUser
Auth
AuthUserAttribute
Auth
The key and value for a user attribute.
AuthUserAttributeKey
Auth
A user attribute identifier.
AWSApiConfig
AWSApiPluginConfig
The AWS API plugin configuration.
AWSBaseHttpClient
An AWSHttpClient which supports modifying requests before sending and,
optionally, modifying responses before being returned from send .
AWSBaseHttpRequest
A parameterized HTTP request.
AWSBaseHttpResponse
A parameterized HTTP response.
AWSConfigMap <T extends AWSSerializable <Object ? > >
A map of AWS configuration names to their typed representations.
AWSCredentials
A set of credentials used for accessing AWS services.
AWSCredentialsProvider
A utility for retrieving AWS credentials at runtime.
AWSCredentialsProviderChain
Attempts to load AWS credentials from a chain of credentials providers, in order.
AWSCustomHttpClient
Base class for all implementations of AWSHttpClient .
AWSErrorResult <V extends Object ? , E extends Exception >
A failed AWSResult .
AWSFile
A cross-platform abstraction over a read-only file.
Headers used in AWS requests.
AWSHttpClient
An HTTP client with support for HTTP/1.1, HTTP/2, and cancelable requests.
AWSHttpOperation <ResponseType extends AWSBaseHttpResponse >
A wrapper over a CancelableOperation with progress monitoring support for
in-flight HTTP requests sent with an AWSHttpClient .
AWSHttpRequest
A parameterized HTTP request.
AWSHttpResponse
A parameterized HTTP response.
AWSIamAmplifyAuthProvider
AWSLogger
A logging utility providing the ability to emit log entries, configure the
level at which entries are emitted, and register plugins which can handle
log entries as they're emitted.
AWSLoggerPlugin
A plugin to an AWSLogger which handles log entries emitted at the
LogLevel of the logger instance.
AWSOperation <T extends Object ? >
A wrapper over a CancelableOperation .
AWSProfile
A collection of AWS configuration properties.
AWSProfileBuilder
AWSProfileFile
A collection of AWS configuration profiles.
AWSProfileFileBuilder
AWSProperty
A property from an AWS configuration profile.
AWSPropertyBuilder
AWSResult <V extends Object ? , E extends Exception >
The result of an operation that may throw an exception.
AWSService
The enumeration of AWS services.
AWSStreamedHttpRequest
A streaming HTTP request.
AWSStreamedHttpResponse
A streaming HTTP response.
AWSSuccessResult <V extends Object ? , E extends Exception >
A successful AWSResult .
BeginsWithQueryOperator
BetweenQueryOperator <T extends Comparable <Object ? > >
BucketInfo
Presents a storage bucket information.
Cancelable
An operation which can be canceled while pending or in progress.
CancelableCompleter <T >
A completer for a CancelableOperation .
CancelableOperation <T >
An asynchronous operation that can be cancelled.
CaseInsensitiveMap <V >
Creates a case-insensitive Map using equalsIgnoreAsciiCase and
hashIgnoreAsciiCase for comparison.
CaseInsensitiveSet
Creates a case-insensitive Set using equalsIgnoreAsciiCase and
hashIgnoreAsciiCase for comparison.
Closeable
Interface for objects which need cleanup before GC, usually to prevent
memory leaks.
CognitoAppSyncConfig
CognitoAuthConfig
CognitoIdentityCredentialsProvider
CognitoIdentityManager
CognitoOAuthConfig
The Cognito HostedUI configuration.
CognitoPinpointAnalyticsConfig
CognitoPinpointTargetingConfig
CognitoPluginConfig
The AWS Cognito plugin configuration.
CognitoUserAttributeKey
Auth
User attributes available for configuring via Amplify.Auth.signUp,
or updating via Amplify.Auth.updateUserAttribute and
Amplify.Auth.updateUserAttributes.
CognitoUserAttributeKeyConverter
CognitoUserAttributeKeyToUpperCaseConverter
CognitoUserAttributeMapConverter
CognitoUserPoolConfig
ConfigMap <T extends AWSSerializable <Object ? > >
A map of configuration names to their typed representations.
ConfirmResetPasswordOptions
Auth
The shared confirm reset password options among all Auth plugins.
ConfirmSignInOptions
Auth
Options for Amplify.Auth.confirmSignIn.
ConfirmSignUpOptions
Auth
Options passed to Amplify.Auth.confirmSignUp.
ConfirmUserAttributeOptions
Auth
Options passed to Amplify.Auth.confirmUserAttribute
ConfirmUserAttributeResult
Auth
Wraps the result of a confirm user attribute operation.
ConflictData
ConflictResolutionDecision
ContainsQueryOperator
CopyBuckets
Presents storage buckets for a copy operation.
CredentialsProviders
CustomProperties
Provides key/value storage of typed property values of String, Double, Bool, and Int.
DartEnvironmentCredentialsProvider
Creates an AWSCredentialsProvider for credentials injected via the Dart
environment.
DataStoreCategory
Interface for DataStore category. This expose all the APIs that
are supported by this category's plugins. This class will accept plugins to
be registered and configured and then subsequent API calls will be forwarded
to those plugins.
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
DataStorePluginInterface
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
DefaultCredentialsProviderChain
Uses the default chain to try loading credentials from the following
sources, in order:
DependencyManager
Service locator for state machine dependencies.
Emitter <S extends StateMachineState <Object > >
Interface for emitting a state from a state machine.
EnvironmentCredentialsProvider
Creates an AWSCredentialsProvider for credentials injected
via the platform-specific environment.
EqualModelIdentifierQueryOperator <T extends ModelIdentifier <Model > >
EqualQueryOperator <T >
EventCompleter <Event extends StateMachineEvent <Object , Object > , State extends StateMachineState <Object > >
A Completer for Events in a state machine, used to signal processing
of a particular event which otherwise would be fired and forgotten.
FcmPlatformOptions
Holds Firebase Cloud Messaging (FCM) specific options for push notifications.
FetchAuthSessionOptions
Auth
Options for Amplify.Auth.fetchAuthSession.
FetchUserAttributesOptions
Auth
The shared fetch user attributes options among all Auth plugins.
FunctionAuthProvider
Handles the retrieval of tokens for Custom Function-protected API calls.
GetCurrentUserOptions
Auth
Options for Amplify.Auth.getCurrentUser.
GraphQLOperation <T >
A wrapper over a CancelableOperation specific to GraphQLResponse .
GraphQLRequest <T >
A GraphQL request with a few extra properties used to decode the response or use the correct API if the backend has multiple.
GraphQLResponse <T >
A GraphQL response from the server. See https://graphql.org/learn/serving-over-http/#response
GraphQLResponseError
Contains an error produced via a GraphQL invocation. Corresponds to one
entry in the errors field on a GraphQL response.
GraphQLResponseErrorLocation
Represents a location in the GraphQL request document where an error occurred.
line and column correspond to the beginning of the syntax element associated
with the error.
GraphQLSubscriptionOperation <T >
GraphQLSubscriptionOptions
Configuration options for GraphQL subscriptions and their WebSockets.
GreaterOrEqualQueryOperator <T extends Comparable <Object ? > >
GreaterThanQueryOperator <T extends Comparable <Object ? > >
HttpPayload
An HTTP request's payload.
HubEvent <HubEventPayload >
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.
IamAuthProviderOptions
Options required by IAM to sign any given request at runtime.
LessOrEqualQueryOperator <T extends Comparable <Object ? > >
LessThanQueryOperator <T extends Comparable <Object ? > >
LogEntry
A discrete log event emitted by an AWSLogger .
Model
ModelAssociation
ModelField
ModelFieldDefinition
ModelFieldType
ModelIdentifier <T extends Model >
Model identifier presentation
ModelIndex
Describes an index that is created by @primaryKey or @index directive,
and is listed in ModelSchemaDefinition.indexes .
ModelProviderInterface
ModelSchema
ModelSchemaDefinition
ModelSyncedEvent
ModelType <T extends Model >
NetworkStatusEvent
NotEqualModelIdentifierQueryOperator <T extends ModelIdentifier <Model > >
NotEqualQueryOperator <T >
NotificationsCategory
Top-Level Category for Notifications.
NotificationsConfig
The Notifications category configuration.
NotificationsPinpointPluginConfig
The AWS Pinpoint plugin configuration.
ObserveQueryThrottleOptions
Options for throttling events emitted from ObserveQuery during
the sync process
OIDCAuthProvider
Handles the retrieval of tokens for OIDC-protected API calls.
OutboxMutationEvent
OutboxStatusEvent
PaginatedModelType <T extends Model >
The modelType for decoding list query requests.
PaginatedResult <T extends Model >
PasswordProtectionSettings
PinpointAnalytics
PinpointPluginConfig
The AWS Pinpoint plugin configuration.
PinpointTargeting
ProfileCredentialsProvider
Creates an AWSCredentialsProvider for credentials from an AWS shared
credentials file.
PushNotificationMessage
The Push Notification message that represents both the FCM and APNS Native notification types.
PushNotificationsCategory
PushNotificationsPluginInterface
QueryByIdentifierOperation
QueryField <T >
A field used to query models.
QueryFieldOperator <T >
QueryFieldOperatorSingleValue <T >
QueryModelIdentifier <T extends ModelIdentifier <Model > >
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
ResendSignUpCodeOptions
Auth
The shared resend sign up code options among all Auth plugins.
ResendSignUpCodeResult
Auth
ResetPasswordOptions
Auth
The shared reset password options among all Auth plugins.
ResetPasswordResult
Auth
The result of a password reset request.
ResetPasswordStep
Auth
The next step required for resetting a user's password.
RestOperation
A wrapper over a CancelableOperation specific to AWSHttpResponse .
RetryOptions
Object holding options for retrying a function.
S3PluginConfig
The AWS S3 plugin configuration.
S3TransferUtility
SendUserAttributeVerificationCodeOptions
Auth
The shared send user attribute verification code options among all Auth
plugins.
SendUserAttributeVerificationCodeResult
Auth
Wraps the result of a send user verification code operation.
SerializableMap <V >
A Map which conforms to AWSSerializable .
ServiceConfiguration
A description of an AWSSigV4Signer configuration.
ServiceProviderClient
A base class for new service providers to implement and add functionality
SignInDetails
Auth
Details about how a user signed in.
SignInOptions
Auth
Options for Amplify.Auth.signIn.
SignInResult
Auth
SignInWithWebUIOptions
Auth
Options for Amplify.Auth.signInWithWebUI.
SignOutOptions
Auth
The shared sign out options among all Auth plugins.
SignOutResult
Auth
The result of a call to Amplify.Auth.signOut.
SignUpOptions
Auth
Options for Amplify.Auth.signUp.
SignUpResult
Auth
SimpleLogPrinter
An AWSLoggerPlugin which prints log messages to the console when
running in debug mode.
SortedList <E >
An Object that holds a list that maintains a specifc sort order
StateMachine <Event extends ManagerEvent , State extends ManagerState , ManagerEvent extends StateMachineEvent <Object , Object > , ManagerState extends StateMachineState <Object > , Manager extends StateMachineManager <ManagerEvent , ManagerState , Manager > >
Base class for state machines.
StateMachineEvent <EventType extends Object , StateType extends Object >
Base class for discrete events of a state machine.
StateMachineManager <E extends StateMachineEvent <Object , Object > , S extends StateMachineState <Object > , Manager extends StateMachineManager <E , S , Manager > >
Service locator for state machines to ease communication between the
different layers.
StateMachineState <StateType extends Object >
Base class for the discrete states of a state machine.
StateMachineToken <Event extends ManagerEvent , State extends ManagerState , ManagerEvent extends StateMachineEvent <Object , Object > , ManagerState extends StateMachineState <Object > , Manager extends StateMachineManager <ManagerEvent , ManagerState , Manager > , M extends StateMachine <Event , State , ManagerEvent , ManagerState , Manager > >
A marker for state machine types to improve DX with generic functions.
StaticCredentialsProvider
Creates an AWSCredentialsProvider for a set of static, compile-time AWS
credentials.
StoppableTimer
A Timer that can be stopped and started again.
StorageBucket
Presents a storage bucket.
StorageCategory
The Amplify Storage category provides an interface for interacting with
a storage plugin.
StorageConfig
The Storage category configuration.
StorageCopyOperation <Request extends StorageCopyRequest <StorageItem > , Result extends StorageCopyResult <StorageItem > >
Presents a storage copy operation.
StorageCopyOptions
Configurable options for Amplify.Storage.copy.
StorageCopyPluginOptions
Plugin-specific options for Amplify.Storage.copy.
StorageCopyRequest <Item extends StorageItem >
Presents a storage copy request.
StorageCopyResult <Item extends StorageItem >
Presents the result of a StorageCopyOperation .
StorageDataPayload
A data payload to be uploaded by the Storage category.
StorageDownloadDataOperation <Request extends StorageDownloadDataRequest , Result extends StorageDownloadDataResult <StorageItem > >
A storage download data operation interface.
StorageDownloadDataOptions
Configurable options for Amplify.Storage.downloadData.
StorageDownloadDataPluginOptions
Plugin-specific options for Amplify.Storage.downloadData.
StorageDownloadDataRequest
A storage download data request.
StorageDownloadDataResult <Item extends StorageItem >
The result of a StorageDownloadDataOperation .
StorageDownloadFileOperation <Request extends StorageDownloadFileRequest , Result extends StorageDownloadFileResult <StorageItem > >
A storage download data operation interface.
StorageDownloadFileOptions
Configurable options for Amplify.Storage.downloadFile.
StorageDownloadFilePluginOptions
Plugin-specific options for Amplify.Storage.downloadFile.
StorageDownloadFileRequest
A storage download file request.
StorageDownloadFileResult <Item extends StorageItem >
The result of a StorageDownloadFileOperation .
StorageGetPropertiesOperation <Request extends StorageGetPropertiesRequest , Result extends StorageGetPropertiesResult <StorageItem > >
Presents a storage copy operation.
StorageGetPropertiesOptions
Configurable options for Amplify.Storage.getProperties.
StorageGetPropertiesPluginOptions
Plugin-specific options for Amplify.Storage.getProperties.
StorageGetPropertiesRequest
Presents a storage get properties request.
StorageGetPropertiesResult <Item extends StorageItem >
Presents the result of a StorageGetPropertiesOperation .
StorageGetUrlOperation <Request extends StorageGetUrlRequest , Result extends StorageGetUrlResult >
Presents a storage get url operation.
StorageGetUrlOptions
Configurable options for Amplify.Storage.getUrl.
StorageGetUrlPluginOptions
Plugin-specific options for Amplify.Storage.downloadData.
StorageGetUrlRequest
Presents a storage get url request.
StorageGetUrlResult
Presents the result of a StorageGetUrlOperation .
StorageItem
Presents a storage object.
StorageListOperation <Request extends StorageListRequest , Result extends StorageListResult <StorageItem > >
Presents a storage list operation.
StorageListOptions
Configurable options for Amplify.Storage.list.
StorageListPluginOptions
Plugin-specific options for Amplify.Storage.list.
StorageListRequest
Presents a storage list request.
StorageListResult <Item extends StorageItem >
Presents the result of a StorageListOperation .
StoragePath
The full remote path of a storage item.
StoragePluginInterface
Defines Amplify Storage plugin interface.
StoragePluginKey <P extends StoragePluginInterface >
StorageRemoveManyOperation <Request extends StorageRemoveManyRequest , Result extends StorageRemoveManyResult <StorageItem , Object > >
Presents a storage remove many operation.
StorageRemoveManyOptions
Configurable options for Amplify.Storage.removeMany.
StorageRemoveManyPluginOptions
Plugin-specific options for Amplify.Storage.removeMany.
StorageRemoveManyRequest
Presents a storage remove many request.
StorageRemoveManyResult <Item extends StorageItem , ErrorT extends Object >
Presents the result of a StorageRemoveManyOperation .
StorageRemoveOperation <Request extends StorageRemoveRequest , Result extends StorageRemoveResult <StorageItem > >
Presents a storage remove many operation.
StorageRemoveOptions
Configurable options for Amplify.Storage.remove.
StorageRemovePluginOptions
Plugin-specific options for Amplify.Storage.remove.
StorageRemoveRequest
Presents a storage copy request.
StorageRemoveResult <Item extends StorageItem >
Presents the result of a StorageRemoveOperation .
StorageTransferProgress
The progress of a storage transfer operation.
StorageUploadDataOperation <Request extends StorageUploadDataRequest , Result extends StorageUploadDataResult <StorageItem > >
Presents a storage upload data operation.
StorageUploadDataOptions
Configurable options for Amplify.Storage.uploadData.
StorageUploadDataPluginOptions
Plugin-specific options for Amplify.Storage.uploadData.
StorageUploadDataRequest
Presents a storage upload data request.
StorageUploadDataResult <Item extends StorageItem >
Presents the result of a StorageUploadDataOperation .
StorageUploadFileOperation <Request extends StorageUploadFileRequest , Result extends StorageUploadFileResult <StorageItem > >
Presents a upload file operation.
StorageUploadFileOptions
Configurable options for Amplify.Storage.uploadFile.
StorageUploadFilePluginOptions
Plugin-specific options for Amplify.Storage.uploadFile.
StorageUploadFileRequest
Presents a storage upload data request.
StorageUploadFileResult <Item extends StorageItem >
Presents the result of a StorageUploadFileOperation .
SubscriptionDataProcessedEvent <M extends Model >
SubscriptionDetails
SubscriptionEvent <T extends Model >
An event containing the details of mutations that have occurred on the backend
SubscriptionHubEvent
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.
Token <T extends Object >
An identifier for T and its dependencies.
TokenAmplifyAuthProvider
TokenIdentityAmplifyAuthProvider
TotpSetupDetails
The TOTP secret code and QR code, used to set up an authenticator for
TOTP MFA.
TotpSetupOptions
Options for Amplify.Auth.verifyTotpSetup.
TotpSetupPluginOptions
Plugin-specific options for Amplify.Auth.setUpTotp.
Transition <E extends StateMachineEvent <Object , Object > , S extends StateMachineState <Object > >
A state machine transition from one state to the next.
TypeToken <T extends Object >
A token identified by a Type .
UnknownPluginConfig
A plugin configuration for unknown plugins. Delegates to a Map .
UpdatePasswordOptions
Auth
The shared update password options among all Auth plugins.
UpdatePasswordResult
Auth
The result of an update password request.
UpdateUserAttributeOptions
Auth
The shared update user attribute options among all Auth plugins.
UpdateUserAttributeResult
Auth
Wraps the result of an update user attribute operation.
UpdateUserAttributesOptions
Auth
The shared update user attributes options among all Auth plugins.
UserMfaPreference
The MFA preferences for the user, returned from Amplify.Auth.fetchMfaPreference.
UserProfile
User specific data.
UserProfileLocation
Location data of a user.
UUID
VerifyTotpSetupOptions
Options for Amplify.Auth.verifyTotpSetup.
VerifyTotpSetupPluginOptions
Plugin-specific options for Amplify.Auth.verifyTotpSetup.
X509Certificate
X509Certificate represents an SSL certificate, with accessors to
get the fields of the certificate.
Functions
$checkedConvert <T > (Map map , String key , T castFunc (dynamic ), {Object ? readValue (Map , String )? })
→ T
Helper function used in generated code when
JsonSerializableGenerator.checked is true.
$checkedCreate <T > (String className , Map map , T constructor (S <S >(String , S (Object ? ), {Object ? readValue (Map , String )? }) ), {Map <String , String > fieldKeyMap = const {} })
→ T
Helper function used in generated code when
JsonSerializableGenerator.checked is true.
$checkedNew <T > (String className , Map map , T constructor (), {Map <String , String > ? fieldKeyMap })
→ T
Helper function used in generated code when
JsonSerializableGenerator.checked is true.
$checkKeys (Map map , {List <String > ? allowedKeys , List <String > ? requiredKeys , List <String > ? disallowNullValues })
→ void
Helper function used in generated fromJson code when
JsonSerializable.disallowUnrecognizedKeys is true for an annotated type or
JsonKey.required is true for any annotated fields.
$enumDecode <K extends Enum , V > (Map <K , V > enumValues , Object ? source , {K? unknownValue })
→ K
Returns the key associated with value source from enumValues, if one
exists.
$enumDecodeNullable <K extends Enum , V > (Map <K , V > enumValues , Object ? source , {Enum ? unknownValue })
→ K?
Returns the key associated with value source from enumValues, if one
exists.
enumFromString <T extends Enum > (String ? key , List <T > values )
→ T?
enumToString (Enum ? obj )
→ String ?
getFieldName (String fieldName )
→ String
Removes the model name that is pre-pended to id fields.
isEnum (dynamic value )
→ bool
check whether an dynamic type value is an enum
not (QueryPredicate <Model > predicate )
→ QueryPredicateGroup
prettyPrintJson (Object ? json )
→ String
Encodes json with indentation for easier debugging.
safePrint (Object ? o )
→ void
Prints o in debug-mode only.
uuid ({bool secure = false })
→ String
Generates a UUID (v4).
Typedefs
APIAuthProviderRefresher
= Future <void > Function([APIAuthorizationType <AmplifyAuthProvider > ? ])
Refreshes the token for a given type or all registered types if none is passed.
BadCertificateCallback
= bool Function(X509Certificate , String host , int port )
Callback for VM clients when an SSL handshake fails due to an untrusted
certificate chain.
CognitoIdentityPoolConfig
= CognitoIdentityCredentialsProvider
DataStoreConflictHandler
= ConflictResolutionDecision Function(ConflictData )
DependencyBuilder <T extends Object >
= T Function(DependencyManager )
Factory for a type T with dependencies.
HubEventListener <E extends HubEvent <Object ? > >
= void Function(E event )
A HubEvent listener, passed to AmplifyHub.listen .
OnRemoteMessageCallback
= FutureOr <void > Function(PushNotificationMessage remotePushMessage )
Type definition for the callback functions provided to the onNotificationReceivedInBackground API
StateMachineBuilder <E extends StateMachineEvent <Object , Object > , S extends StateMachineState <Object > , Manager extends StateMachineManager <E , S , Manager > >
= StateMachine <StateMachineEvent <Object , Object > , StateMachineState <Object > , StateMachineEvent <Object , Object > , StateMachineState <Object > , StateMachineManager <StateMachineEvent <Object , Object > , StateMachineState <Object > , dynamic > > Function(Manager )
Factory for a state machine under a Manager.