APIPluginInterface class abstract

Inheritance

Constructors

APIPluginInterface()

Properties

authProviders → Map<APIAuthorizationType<AmplifyAuthProvider>, APIAuthProvider>
The registered APIAuthProvider instances.
final
category → Category
The category implemented by this plugin.
no setteroverride
dependencies → DependencyManager
Global dependencies scoped to this plugin.
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
modelProvider → ModelProviderInterface?
modelProvider
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addPlugin({required AmplifyAuthProviderRepository authProviderRepo}) → Future<void>
Called when the plugin is added to the category.
inherited
cast<P extends AmplifyPluginInterface>() → P
Casts a plugin to a category-specific implementation.
inherited
configure({AmplifyOutputs? config, required AmplifyAuthProviderRepository authProviderRepo}) → Future<void>
Configures the plugin using the registered config.
inherited
delete(String path, {HttpPayload? body, Map<String, String>? headers, Map<String, String>? queryParameters, String? apiName}) → RestOperation
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.
mutate<T>({required GraphQLRequest<T> request}) → GraphQLOperation<T>
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
post(String path, {HttpPayload? body, Map<String, String>? headers, Map<String, String>? queryParameters, String? apiName}) → RestOperation
put(String path, {HttpPayload? body, Map<String, String>? headers, Map<String, String>? queryParameters, String? apiName}) → RestOperation
query<T>({required GraphQLRequest<T> request}) → GraphQLOperation<T>
registerAuthProvider(APIAuthProvider authProvider) → void
Registers an APIAuthProvider with this plugin.
reifyPluginOptions<T extends AWSDebuggable>({required Object? pluginOptions, required T defaultPluginOptions}) → T
Reifies pluginOptions as an instance of 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.
toString() → String
A string representation of this object.
inherited

Operators

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