AmplifyAPI class

The AWS implementation of the Amplify API category for Flutter.

Constructors

AmplifyAPI({APIPluginOptions options = const APIPluginOptions()})
The AWS implementation of the Amplify API category for Flutter.

Properties

hashCode → int
The hash code for this object.
no setterinherited
modelProvider → ModelProviderInterface?
modelProvider
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
runtimeTypeName → String
The string value of runtimeType, saving a runtime lookup and preventing obfuscation during web compilation.
no setter

Methods

addPlugin({required AmplifyAuthProviderRepository authProviderRepo}) → Future<void>
Called when the plugin is added to the category.
configure({AmplifyConfig? config, required AmplifyAuthProviderRepository authProviderRepo}) → Future<void>
Configures the plugin using the registered config.
inherited
createWebSocketBloc(EndpointConfig endpoint) → WebSocketBloc
Returns the websocket bloc to use for a given endpoint.
inherited
delete(String path, {HttpPayload? body, Map<String, String>? headers, Map<String, String>? queryParameters, String? apiName}) → RestOperation
inherited
get(String path, {Map<String, String>? headers, Map<String, String>? queryParameters, String? apiName}) → RestOperation
Uses Amplify configuration to authorize request to path and returns CancelableOperation which resolves to standard HTTP Response.
inherited
getHttpClient(EndpointType type, {String? apiName, APIAuthorizationType<AmplifyAuthProvider>? authorizationMode}) → AWSHttpClient
Returns the HTTP client to be used for REST/GraphQL operations.
inherited
inherited
mutate<T>({required GraphQLRequest<T> request}) → GraphQLOperation<T>
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patch(String path, {HttpPayload? body, Map<String, String>? headers, Map<String, String>? queryParameters, String? apiName}) → RestOperation
inherited
post(String path, {HttpPayload? body, Map<String, String>? headers, Map<String, String>? queryParameters, String? apiName}) → RestOperation
inherited
put(String path, {HttpPayload? body, Map<String, String>? headers, Map<String, String>? queryParameters, String? apiName}) → RestOperation
inherited
query<T>({required GraphQLRequest<T> request}) → GraphQLOperation<T>
inherited
reset() → Future<void>
Resets the plugin by removing all traces of it from the device.
inherited
subscribe<T>(GraphQLRequest<T> request, {void onEstablished()?}) → Stream<GraphQLResponse<T>>
Subscribes to the given request and returns the stream of response events. An optional onEstablished callback can be used to be alerted when the subscription has been successfully established with the server.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited