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.
AmplifyExceptionMessages
Commonly used cross-category error messages.
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.
AnalyticsCategory
AnalyticsEvent
APIAuthProvider
Handles the retrieval of authentication tokens for third-party providers.
APICategory
ApiHubEvent
ApiHubEventPayload
ApiKeyAmplifyAuthProvider
ApiKeyAuthProviderOptions
ApnsPlatformOptions
Holds Apple Push Notification service (APNS) specific options for push notifications.
AppPathProvider
AuthCategory Auth
The Amplify Auth category provides an interface for authenticating a user.
AuthCodeDeliveryDetails Auth
Details on where a confirmation code has been delivered.
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.
AuthProvider Auth
AuthProviderOptions
AuthRule
AuthSession Auth
AuthUser Auth
AuthUserAttribute Auth
The key and value for a user attribute.
AuthUserAttributeKey Auth
A user attribute identifier.
{@hideConstantImplementations}
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.
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 ? >
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.
CognitoUserAttributeKey Auth
User attributes available for configuring via Amplify.Auth.signUp,
or updating via Amplify.Auth.updateUserAttribute and
Amplify.Auth.updateUserAttributes.
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
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
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:
EnvironmentCredentialsProvider
Creates an AWSCredentialsProvider for credentials injected
via the platform-specific environment.
EqualModelIdentifierQueryOperator <T extends ModelIdentifier <Model >
EqualQueryOperator <T >
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.
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 >
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
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.
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.
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
StaticCredentialsProvider
Creates an AWSCredentialsProvider for a set of static, compile-time AWS
credentials.
StorageCategory
The Amplify Storage category provides an interface for interacting with
a storage plugin.
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 .
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.
StorageItemWithAccessLevel <Item extends StorageItem >
Presents a storage object with its access level information.
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 .
StorageMoveOperation <Request extends StorageMoveRequest <StorageItem , Result extends StorageMoveResult <StorageItem >
Presents a storage move operation.
StorageMoveOptions
Configurable options for Amplify.Storage.move.
StorageMovePluginOptions
Plugin-specific options for Amplify.Storage.move.
StorageMoveRequest <Item extends StorageItem >
Presents a storage copy request.
StorageMoveResult <Item extends StorageItem >
Presents the result of a StorageCopyOperation .
StorageRemoveManyOperation <Request extends StorageRemoveManyRequest , Result extends StorageRemoveManyResult <StorageItem >
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 >
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.
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.
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.
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.
getFieldName (String fieldName → String
Removes the model name that is pre-pended to id fields.
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).
