APICategory

final public class APICategory : Category

extension APICategory: DefaultLogger

extension APICategory: APICategoryAuthProviderFactoryBehavior

extension APICategory: APICategoryGraphQLBehavior

extension APICategory: APICategoryInterceptorBehavior

extension APICategory: APICategoryRESTBehavior

extension APICategory: APICategoryReachabilityBehavior

extension APICategory: Resettable

The API category provides a solution for making HTTP requests to REST and GraphQL endpoints.

categoryType
The category type for API
Declaration
Swift

public var categoryType: CategoryType { get }
isConfigured
true if this category has been configured with Amplify.configure().

Warning
This property is intended for use by plugin developers.
Declaration
Swift

public var isConfigured: Bool

Plugin handling


                    
                    
                    add(plugin:)

Adds plugin to the list of Plugins that implement functionality for this category.

Declaration

Swift

public func add(plugin: APICategoryPlugin) throws

Parameters


                                plugin

The Plugin to add


                    
                    
                    getPlugin(for:)

Returns the added plugin with the specified key property.

Declaration

Swift

public func getPlugin(for key: PluginKey) throws -> APICategoryPlugin

Parameters

key

The PluginKey (String) of the plugin to retrieve

Return Value

The wrapped plugin


                    
                    
                    removePlugin(for:)

Removes the plugin registered for key from the list of Plugins that implement functionality for this category. If no plugin has been added for key, no action is taken, making this method safe to call multiple times.

Declaration

Swift

public func removePlugin(for key: PluginKey)

Parameters

key

The key used to add the plugin

log
Declaration
Swift

public static var log: Logger { get }
log
Declaration
Swift

public var log: Logger { get }
apiAuthProviderFactory()
Retrieve the plugin’s auth provider factory
Declaration
Swift

public func apiAuthProviderFactory() -> APIAuthProviderFactory
Return Value

auth provider factory

Request-based GraphQL operations


                    
                    
                    query(request:)

Asynchronous

Declaration

Swift

public func query<R>(request: GraphQLRequest<R>) async throws -> GraphQLTask<R>.Success where R : Decodable


                    
                    
                    mutate(request:)

Asynchronous

Declaration

Swift

public func mutate<R>(request: GraphQLRequest<R>) async throws -> GraphQLTask<R>.Success where R : Decodable


                    
                    
                    subscribe(request:)

Declaration

Swift

public func subscribe<R>(request: GraphQLRequest<R>) -> AmplifyAsyncThrowingSequence<GraphQLSubscriptionEvent<R>> where R : Decodable


                    
                    
                    add(interceptor:for:)

Declaration

Swift

public func add(interceptor: URLRequestInterceptor, for apiName: String) throws


                    
                    
                    get(request:)

Asynchronous

Declaration

Swift

public func get(request: RESTRequest) async throws -> RESTTask.Success


                    
                    
                    put(request:)

Asynchronous

Declaration

Swift

public func put(request: RESTRequest) async throws -> RESTTask.Success


                    
                    
                    post(request:)

Asynchronous

Declaration

Swift

public func post(request: RESTRequest) async throws -> RESTTask.Success


                    
                    
                    delete(request:)

Asynchronous

Declaration

Swift

public func delete(request: RESTRequest) async throws -> RESTTask.Success


                    
                    
                    head(request:)

Asynchronous

Declaration

Swift

public func head(request: RESTRequest) async throws -> RESTTask.Success


                    
                    
                    patch(request:)

Asynchronous

Declaration

Swift

public func patch(request: RESTRequest) async throws -> RESTTask.Success

reachabilityPublisher(for:)
Default implementation of reachabilityPublisher to delegate to plugin’s method
Declaration
Swift

public func reachabilityPublisher(for apiName: String?) throws -> AnyPublisher<ReachabilityUpdate, Never>?
reachabilityPublisher()
Default implementation of reachabilityPublisher to delegate to plugin’s method
Declaration
Swift

public func reachabilityPublisher() throws -> AnyPublisher<ReachabilityUpdate, Never>?
reset() Asynchronous
Declaration
Swift

public func reset() async