Docs
Launch GraphOS Studio
You're viewing documentation for a previous version of this software. Switch to the latest stable version.


PROTOCOL

ApolloClientProtocol

public protocol ApolloClientProtocol: AnyObject

The ApolloClientProtocol provides the core API for Apollo. This API provides methods to fetch and watch queries, and to perform .

Properties

store

var store: ApolloStore

A store used as a local cache.

cacheKeyForObject

var cacheKeyForObject: CacheKeyForObject?

A function that returns a cache key for a particular result object. If it returns nil, a default cache key based on the path will be used.

Methods

clearCache(callbackQueue:completion:)

func clearCache(callbackQueue: DispatchQueue, completion: ((Result<Void, Error>) -> Void)?)

Clears the underlying cache. Be aware: In more complex setups, the same underlying cache can be used across multiple instances, so if you call this on one instance, it'll clear that cache across all instances which share that cache.

  • Parameters:
    • callbackQueue: The queue to fall back on. Should default to the main queue.
    • completion: [optional] A completion closure to execute when clearing has completed. Should default to nil.

Parameters

NameDescription
callbackQueueThe queue to fall back on. Should default to the main queue.
completion[optional] A completion closure to execute when clearing has completed. Should default to nil.

fetch(query:cachePolicy:contextIdentifier:queue:resultHandler:)

func fetch<Query: GraphQLQuery>(query: Query,
cachePolicy: CachePolicy,
contextIdentifier: UUID?,
queue: DispatchQueue,
resultHandler: GraphQLResultHandler<Query.Data>?) -> Cancellable

Fetches a from the server or from the local cache, depending on the current contents of the cache and the specified cache policy.

  • Parameters:
    • : The query to fetch.
    • cachePolicy: A cache policy that specifies when results should be fetched from the server and when data should be loaded from the local cache.
    • queue: A dispatch queue on which the result handler will be called. Should default to the main queue.
    • contextIdentifier: [optional] A unique identifier for this request, to help with deduping cache hits for watchers. Should default to nil.
    • resultHandler: [optional] A closure that is called when results are available or when an error occurs.
  • Returns: An object that can be used to cancel an in progress fetch.

Parameters

NameDescription
queryThe query to fetch.
cachePolicyA cache policy that specifies when results should be fetched from the server and when data should be loaded from the local cache.
queueA dispatch queue on which the result handler will be called. Should default to the main queue.
contextIdentifier[optional] A unique identifier for this request, to help with deduping cache hits for watchers. Should default to nil.
resultHandler[optional] A closure that is called when query results are available or when an error occurs.

watch(query:cachePolicy:callbackQueue:resultHandler:)

func watch<Query: GraphQLQuery>(query: Query,
cachePolicy: CachePolicy,
callbackQueue: DispatchQueue,
resultHandler: @escaping GraphQLResultHandler<Query.Data>) -> GraphQLQueryWatcher<Query>

Watches a by first fetching an initial result from the server or from the local cache, depending on the current contents of the cache and the specified cache policy. After the initial fetch, the returned query watcher object will get notified whenever any of the data the query result depends on changes in the local cache, and calls the result handler again with the new result.

  • Parameters:
    • : The query to fetch.
    • cachePolicy: A cache policy that specifies when results should be fetched from the server or from the local cache.
    • callbackQueue: A dispatch queue on which the result handler will be called. Should default to the main queue.
    • resultHandler: [optional] A closure that is called when results are available or when an error occurs.
  • Returns: A watcher object that can be used to control the watching behavior.

Parameters

NameDescription
queryThe query to fetch.
cachePolicyA cache policy that specifies when results should be fetched from the server or from the local cache.
callbackQueueA dispatch queue on which the result handler will be called. Should default to the main queue.
resultHandler[optional] A closure that is called when query results are available or when an error occurs.

perform(mutation:publishResultToStore:queue:resultHandler:)

func perform<Mutation: GraphQLMutation>(mutation: Mutation,
publishResultToStore: Bool,
queue: DispatchQueue,
resultHandler: GraphQLResultHandler<Mutation.Data>?) -> Cancellable

Performs a by sending it to the server.

  • Parameters:
    • : The mutation to perform.
    • publishResultToStore: If true, this will publish the result returned from the to the cache store. Default is true.
    • queue: A dispatch queue on which the result handler will be called. Should default to the main queue.
    • resultHandler: An optional closure that is called when results are available or when an error occurs.
  • Returns: An object that can be used to cancel an in progress .

Parameters

NameDescription
mutationThe mutation to perform.
publishResultToStoreIf true, this will publish the result returned from the operation to the cache store. Default is true.
queueA dispatch queue on which the result handler will be called. Should default to the main queue.
resultHandlerAn optional closure that is called when mutation results are available or when an error occurs.

upload(operation:files:queue:resultHandler:)

func upload<Operation: GraphQLOperation>(operation: Operation,
files: [GraphQLFile],
queue: DispatchQueue,
resultHandler: GraphQLResultHandler<Operation.Data>?) -> Cancellable

Uploads the given files with the given .

  • Parameters:
    • : The operation to send
    • files: An array of GraphQLFile objects to send.
    • queue: A dispatch queue on which the result handler will be called. Should default to the main queue.
    • completionHandler: The completion handler to execute when the request completes or errors. Note that an error will be returned If your networkTransport does not also conform to UploadingNetworkTransport.
  • Returns: An object that can be used to cancel an in progress request.

Parameters

NameDescription
operationThe operation to send
filesAn array of GraphQLFile objects to send.
queueA dispatch queue on which the result handler will be called. Should default to the main queue.
completionHandlerThe completion handler to execute when the request completes or errors. Note that an error will be returned If your networkTransport does not also conform to UploadingNetworkTransport.

subscribe(subscription:queue:resultHandler:)

func subscribe<Subscription: GraphQLSubscription>(subscription: Subscription,
queue: DispatchQueue,
resultHandler: @escaping GraphQLResultHandler<Subscription.Data>) -> Cancellable

Subscribe to a

  • Parameters:
    • : The subscription to subscribe to.
    • fetchHTTPMethod: The HTTP Method to be used.
    • queue: A dispatch queue on which the result handler will be called. Should default to the main queue.
    • resultHandler: An optional closure that is called when results are available or when an error occurs.
  • Returns: An object that can be used to cancel an in progress .

Parameters

NameDescription
subscriptionThe subscription to subscribe to.
fetchHTTPMethodThe HTTP Method to be used.
queueA dispatch queue on which the result handler will be called. Should default to the main queue.
resultHandlerAn optional closure that is called when mutation results are available or when an error occurs.
Next
Introduction
Edit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy

Company