amplify_flutter 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.
AmplifyOutputs
The amplify outputs generated by Amplify Gen 2 for Amplify libraries to communicate with backend services.
AmplifySecureStorage
The default Secure Storage implementation used in Amplify packages.
AmplifySecureStorageConfig
Configuration options for Amplify Secure Storage.
AmplifySecureStorageConfigBuilder
AmplifySecureStorageDart
Secure Storage implementation in Dart, supporting web and desktop platforms.
AmplifySecureStorageInterface
An extension of SecureStorageInterface which adds Amplify specific options.
AmplifySecureStorageWorker
A package:worker_bee variant of AmplifySecureStorageDart which runs storage operations in a background thread.
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
AttributeExistsQueryOperator<T>
AuthCategory
The Amplify Auth category provides an interface for authenticating a user.
AuthCodeDeliveryDetails
Details on where a confirmation code has been delivered.
AuthDevice
Common interface for devices tracked by an authentication provider.
AuthHubEvent
The base class for hub events of the Auth category.
AuthNextSignInStep
AuthNextSignUpStep
AuthNextStep
AuthNextUpdateAttributeStep
This wraps all the details around the next step in the user attribute update process.
AuthProvider
AuthProviderOptions
AuthRule
AuthSession
AuthUser
AuthUserAttribute
The key and value for a user attribute.
AuthUserAttributeKey
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.
AWSHeaders
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
User attributes available for configuring via Amplify.Auth.signUp, or updating via Amplify.Auth.updateUserAttribute and Amplify.Auth.updateUserAttributes.
ConfirmResetPasswordOptions
The shared confirm reset password options among all Auth plugins.
ConfirmSignInOptions
Options for Amplify.Auth.confirmSignIn.
ConfirmSignUpOptions
Options passed to Amplify.Auth.confirmSignUp.
ConfirmUserAttributeOptions
Options passed to Amplify.Auth.confirmUserAttribute
ConfirmUserAttributeResult
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
Options for Amplify.Auth.fetchAuthSession.
FetchUserAttributesOptions
The shared fetch user attributes options among all Auth plugins.
FunctionAuthProvider
Handles the retrieval of tokens for Custom Function-protected API calls.
GetCurrentUserOptions
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.
IOSSecureStorageOptions
Configuration options that are specific to iOS.
IOSSecureStorageOptionsBuilder
KeychainAttributeAccessible
Represents the kSecAttrAccessible attribute in Keychain operations.
LessOrEqualQueryOperator<T extends Comparable<Object?>>
LessThanQueryOperator<T extends Comparable<Object?>>
LinuxSecureStorageOptions
Configuration options that are specific to Linux.
LinuxSecureStorageOptionsBuilder
LogEntry
A discrete log event emitted by an AWSLogger.
MacOSSecureStorageOptions
Configuration options that are specific to MacOS.
MacOSSecureStorageOptionsBuilder
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>>
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
ResendSignUpCodeOptions
The shared resend sign up code options among all Auth plugins.
ResendSignUpCodeResult
ResetPasswordOptions
The shared reset password options among all Auth plugins.
ResetPasswordResult
The result of a password reset request.
ResetPasswordStep
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.
SecureStorageInterface
Interface for Secure Storage in Amplify plugins.
SendUserAttributeVerificationCodeOptions
The shared send user attribute verification code options among all Auth plugins.
SendUserAttributeVerificationCodeResult
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
Details about how a user signed in.
SignInOptions
Options for Amplify.Auth.signIn.
SignInResult
SignInWithWebUIOptions
Options for Amplify.Auth.signInWithWebUI.
SignOutOptions
The shared sign out options among all Auth plugins.
SignOutResult
The result of a call to Amplify.Auth.signOut.
SignUpOptions
Options for Amplify.Auth.signUp.
SignUpResult
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.
StoppableTimer
A Timer that can be stopped and started again.
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.
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.
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, Error 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.
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
The shared update password options among all Auth plugins.
UpdatePasswordResult
The result of an update password request.
UpdateUserAttributeOptions
The shared update user attribute options among all Auth plugins.
UpdateUserAttributeResult
Wraps the result of an update user attribute operation.
UpdateUserAttributesOptions
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.
WebPersistenceOption
How data is persisted on the Web platform.
WebSecureStorageOptions
Configuration options that are specific to Web.
WebSecureStorageOptionsBuilder
WindowsSecureStorageOptions
Configuration options that are specific to Windows.
WindowsSecureStorageOptionsBuilder
X509Certificate
X509Certificate represents an SSL certificate, with accessors to get the fields of the certificate.

Enums

AlpnProtocol
TLS Application-Layer Protocol Negotiation Protocol IDs.
AmplifySecureStorageScope
Storage scope for config of SecureStorageInterface within Amplify.
APIAuthorizationType<T extends AmplifyAuthProvider>
The types of authorization one can use while talking to an Amazon AppSync GraphQL backend, or an Amazon API Gateway endpoint.
AuthHubEventType
Hub Event types for the Auth category.
AuthModeStrategy
Represents different auth strategies supported by a client interfacing with an AppSync backend
AuthResetPasswordStep
The current step in the reset password flow.
AuthRuleProvider
AuthSignInStep
The current step in the sign in flow.
AuthSignUpStep
The current step in the sign up flow.
AuthStrategy
AuthUpdateAttributeStep
The current step in the attribute update flow.
AWSConfigValue<T extends Object>
A configuration value for use with AWS packages.
AWSHttpMethod
Valid HTTP methods for AWS requests.
Category
Amplify category types.
DataStoreHubEventType
The type of the DataStore Hub event.
DeliveryMedium
The medium to which an item (e.g., confirmation code) was delivered.
EventType
The different type of mutations that may be observed
GraphQLRequestOperation
GraphQLRequestType
HubChannel<HubEventPayload, E extends HubEvent<HubEventPayload>>
A channel which can be listened on via AmplifyHub (Amplify.Hub).
IntendedState
The intended network states for graphql subscriptions.
LogLevel
The different levels of logging.
MfaPreference
The MFA preference for an MFA type.
ModelAssociationEnum
ModelFieldTypeEnum
ModelOperation
NetworkState
Network states for graphql subscriptions.
PinpointEventSource
The source of a push notification.
PinpointEventType
The different push notification events recorded with Pinpoint.
PushNotificationPermissionStatus
The state of the current push notification permissions.
QueryFieldOperatorType
QueryPredicateConstantType
QueryPredicateGroupType
QuerySortOrder
ResolutionStrategy
StorageTransferState
State of a download task.
SubscriptionStatus
A consolidated subscription connection status determined by the network and intended states.
SupportedProtocols
Protocols supported by an AWSHttpClient.

Mixins

AmplifySecureStorageDartMixin
A mixin that implements the SecureStorageInterface for the target platform.
AWSDebuggable
An object whose properties can be introspected and thus, printed safely to the console.
AWSEquatable<T extends AWSEquatable<T>>
Mixin class to provide equatable functionality on objects.
AWSLoggerMixin
Mixin providing an AWSLogger to AWS classes.
AWSProgressOperation<T>
A mixin to AWSOperation which adds progress monitoring.
AWSSerializable<T extends Object?>
A mixin to provide toJson functionality to objects.

Constants

dummyFieldName → const String
zAccessKeyId → const String
The AWS_ACCESS_KEY_ID identifier, used for locating credentials in the environment.
zDebugMode → const bool
Whether running in debug mode.
zDefaultLogLevel → const LogLevel
The default log level used by AWSLogger.
zIsFlutter → const bool
Whether running in Flutter (as opposed to Dart-only).
zIsWeb → const bool
Whether running on the Web.
zProfileMode → const bool
Whether running in profile mode.
zReleaseMode → const bool
Whether running in release mode.
zSecretAccessKey → const String
The AWS_SECRET_ACCESS_KEY identifier, used for locating credentials in the environment.
zSessionToken → const String
The AWS_SESSION_TOKEN identifier, used for locating credentials in the environment.

Properties

Amplify ↔ AmplifyClass
Top level singleton Amplify object.
getter/setter pair
zAssertsEnabled → bool
Whether asserts are enabled.
final

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).

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.
DataStoreConflictHandler = ConflictResolutionDecision Function(ConflictData)
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
SecureStorageFactory = SecureStorageInterface Function(AmplifySecureStorageScope amplifyScope)
A factory constructor for a SecureStorageInterface instance.

Exceptions / Errors

AmplifyAlreadyConfiguredException
Thrown when amplify has already been configured. Amplify can only be configured once at run time. Use this exception to detect that Amplify.configure() is called again (such as during a hot reload)
AmplifyCodeGenModelException
Exception thrown from codegen models
AmplifyError
An non-recoverable error occurring within an Amplify category or plugin.
AmplifyException
Thrown from top level Amplify APIs from the amplify-flutter package. All other Amplify APIs throw subclasses of AmplifyException.
AnalyticsException
Base Class for Analytics Exceptions.
ApiException
Exception thrown from the API Category.
ApiOperationException
An in-process operation encountered a processing error
AuthException
The class for Auth category exceptions.
AuthNotAuthorizedException
Exception thrown when the current session is not authorized to perform an operation.
AuthServiceException
Exception thrown when some error occurs in the underlying service.
AuthValidationException
Exception thrown when one of the input fields to an operation is invalid.
AWSHttpException
Exception thrown when an error occurs during an AWSHttpOperation.
CancellationException
Exception thrown when an operation is cancelled before completion.
ConfigurationError
An error occurring during configuration of an Amplify plugin, typically the result of missing values needed for that plugin to function properly.
DataStoreException
Exception thrown from DataStore Category
HttpStatusException
An HTTP error encountered during a REST API call, i.e. for calls returning non-2xx status codes.
InvalidCredentialsException
Exception thrown when AWS credentials are either unavailable or invalid.
InvalidEventException
Exception when event data is invalid and cannot be sent to the server.
InvalidFileException
The file created from AWSFile is not readable.
InvalidStateException
Exception thrown when the requested operation is not valid in the current Amplity Auth state.
ModelQueryException
Exception thrown during a model query operation in the API or DataStore categories.
NetworkException
Exception thrown when the requested operation fails due to a network failure.
PluginError
A non-recoverable error occurring during plugin operations.
PushNotificationException
Base Class for Push Notification Exceptions
SessionExpiredException
Exception thrown when the current session is expired.
SignedOutException
Exception thrown when the requested operation can't be performed due to the user being signed out.
StorageAccessDeniedException
Exception thrown when the service request receives access denied error.
StorageException
The base class for Storage category exceptions.
StorageHttpStatusException
Exception thrown when the service returned unsuccessful response.
StorageLocalFileNotFoundException
Exception thrown when a file in the local file system is not found.
StorageNotFoundException
Exception thrown when the item is not found in the storage service.
StorageOperationCanceledException
Exception thrown when a storage operation is canceled.
StoragePathValidationException
Exception thrown when the StoragePath is invalid.
UnknownException
Exception thrown when an unknown error from an underlying SDK or service is encountered.
UrlLauncherException
Thrown when the requested operation did not complete because a URL could not be launched, typically because of an error spawning an external process.
UserCancelledException
Exception thrown when a requested operation could not be completed because it was cancelled by the user.