amplify_api library
Classes
- AmplifyAPI
- The AWS implementation of the Amplify API category for Flutter.
- APIAuthProvider
- Handles the retrieval of authentication tokens for third-party providers.
- ApiHubEvent
- ApiHubEventPayload
- FunctionAuthProvider
- Handles the retrieval of tokens for Custom Function-protected API calls.
-
GraphQLOperation<
T> -
A wrapper over a
CancelableOperationspecific 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
errorsfield 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.
- ModelMutations
-
Static helpers to generate mutation
GraphQLRequestinstances from models generated by Amplify codegen. - ModelQueries
-
Static helpers to generate query
GraphQLRequestinstances from models generated by Amplify codegen. - ModelSubscriptions
-
Static helpers to generate subscription
GraphQLRequestinstances from models generated by Amplify codegen. - OIDCAuthProvider
- Handles the retrieval of tokens for OIDC-protected API calls.
-
PaginatedModelType<
T extends Model> - The modelType for decoding list query requests.
-
PaginatedResult<
T extends Model> - RestOperation
-
A wrapper over a
CancelableOperationspecific toAWSHttpResponse. - RetryOptions
- Object holding options for retrying a function.
- SubscriptionDetails
- SubscriptionHubEvent
Enums
-
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.
- GraphQLRequestOperation
- GraphQLRequestType
- IntendedState
- The intended network states for graphql subscriptions.
- NetworkState
- Network states for graphql subscriptions.
- SubscriptionStatus
-
An overall status for GraphQL subscription connection, determined by the
underlying
detailsnetworkStateandintendedState.
Extensions
-
APIAuthorizationTypeX
on APIAuthorizationType<
AmplifyAuthProvider> - Helper methods for APIAuthorizationType.
Typedefs
-
APIAuthProviderRefresher
= Future<
void> Function([APIAuthorizationType<AmplifyAuthProvider> ?]) - Refreshes the token for a given type or all registered types if none is passed.
Exceptions / Errors
- ApiException
- Exception thrown from the API Category.
- ApiOperationException
- An in-process operation encountered a processing error
- HttpStatusException
- An HTTP error encountered during a REST API call, i.e. for calls returning non-2xx status codes.
- NetworkException
- Exception thrown when the requested operation fails due to a network failure.
- UnknownException
- Exception thrown when an unknown error from an underlying SDK or service is encountered.