com.apollographql.apollo

Class ApolloClient

java.lang.Object

com.apollographql.apollo.ApolloClient

All Implemented Interfaces:

AppSyncMutationCall.Factory, AppSyncPrefetch.Factory, AppSyncQueryCall.Factory, AppSyncSubscriptionCall.Factory

public final class ApolloClient
extends java.lang.Object
implements AppSyncQueryCall.Factory, AppSyncMutationCall.Factory, AppSyncSubscriptionCall.Factory, AppSyncPrefetch.Factory

ApolloClient class represents the abstraction for the graphQL client that will be used to execute queries and read the responses back.

ApolloClient should be shared

Since each ApolloClient holds its own connection pool and thread pool, it is recommended to only create a single ApolloClient and use that for execution of all the queries, as this would reduce latency and would also save memory. Conversely, creating a client for each query execution would result in resource wastage on idle pools.

See the ApolloClient.Builder class for configuring the ApolloClient.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApolloClient.Builder

Method Summary

Modifier and Type	Method and Description
int	activeCallsCount() Returns the count of GraphQLCall & AppSyncPrefetch objects which are currently in progress.
ApolloStore	apolloStore()
static ApolloClient.Builder	builder()
void	clearHttpCache() Clear all entries from the HttpCache, if present.
GraphQLStoreOperation<java.lang.Boolean>	clearNormalizedCache() Clear all entries from the normalized cache.
CacheHeaders	defaultCacheHeaders()
void	idleCallback(IdleResourceCallback idleResourceCallback) Sets the idleResourceCallback which will be called when this ApolloClient is idle.
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> AppSyncMutationCall<T>	mutate(com.apollographql.apollo.api.Mutation<D,T,V> mutation) Creates and prepares a new AppSyncMutationCall call.
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> AppSyncMutationCall<T>	mutate(com.apollographql.apollo.api.Mutation<D,T,V> mutation, D withOptimisticUpdates) Creates and prepares a new AppSyncMutationCall call with optimistic updates.
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> AppSyncPrefetch	prefetch(com.apollographql.apollo.api.Operation<D,T,V> operation) Prepares the AppSyncPrefetch which will be executed at some point in the future.
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> AppSyncQueryCall<T>	query(com.apollographql.apollo.api.Query<D,T,V> query) Creates and prepares a new AppSyncQueryCall call.
<D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> AppSyncSubscriptionCall<T>	subscribe(com.apollographql.apollo.api.Subscription<D,T,V> subscription)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ApolloClient.Builder builder()

mutate

public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> AppSyncMutationCall<T> mutate(@Nonnull
                                                                                                                                                          com.apollographql.apollo.api.Mutation<D,T,V> mutation)

Description copied from interface: AppSyncMutationCall.Factory

Creates and prepares a new AppSyncMutationCall call.

Specified by:

mutate in interface AppSyncMutationCall.Factory

Parameters:

mutation - the Mutation which needs to be performed

Returns:

prepared AppSyncMutationCall call to be executed at some point in the future

mutate

public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> AppSyncMutationCall<T> mutate(@Nonnull
                                                                                                                                                          com.apollographql.apollo.api.Mutation<D,T,V> mutation,
                                                                                                                                                          @Nonnull
                                                                                                                                                          D withOptimisticUpdates)

Description copied from interface: AppSyncMutationCall.Factory

Creates and prepares a new AppSyncMutationCall call with optimistic updates.

Provided optimistic updates will be stored in ApolloStore immediately before mutation execution. Any AppSyncQueryWatcher dependent on the changed cache records will be re-fetched.

Specified by:

mutate in interface AppSyncMutationCall.Factory

Parameters:

mutation - the Mutation which needs to be performed

withOptimisticUpdates - optimistic updates for this mutation

Returns:

prepared AppSyncMutationCall call to be executed at some point in the future

query

public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> AppSyncQueryCall<T> query(@Nonnull
                                                                                                                                                      com.apollographql.apollo.api.Query<D,T,V> query)

Description copied from interface: AppSyncQueryCall.Factory

Creates and prepares a new AppSyncQueryCall call.

Specified by:

query in interface AppSyncQueryCall.Factory

Parameters:

query - the operation which needs to be performed

Returns:

prepared AppSyncQueryCall call to be executed at some point in the future

subscribe

public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> AppSyncSubscriptionCall<T> subscribe(@Nonnull
                                                                                                                                                                 com.apollographql.apollo.api.Subscription<D,T,V> subscription)

Specified by:

subscribe in interface AppSyncSubscriptionCall.Factory

prefetch

public <D extends com.apollographql.apollo.api.Operation.Data,T,V extends com.apollographql.apollo.api.Operation.Variables> AppSyncPrefetch prefetch(@Nonnull
                                                                                                                                                     com.apollographql.apollo.api.Operation<D,T,V> operation)

Prepares the AppSyncPrefetch which will be executed at some point in the future.

Specified by:

prefetch in interface AppSyncPrefetch.Factory

Parameters:

operation - the operation which needs to be performed

Returns:

The AppSyncPrefetch object with the wrapped operation object

defaultCacheHeaders

public CacheHeaders defaultCacheHeaders()

Returns:

The default CacheHeaders which this instance of ApolloClient was configured.

clearHttpCache

public void clearHttpCache()

Clear all entries from the HttpCache, if present.

clearNormalizedCache

@Nonnull
public GraphQLStoreOperation<java.lang.Boolean> clearNormalizedCache()

Clear all entries from the normalized cache.

Returns:

GraphQLStoreOperation operation to execute

apolloStore

public ApolloStore apolloStore()

Returns:

The ApolloStore managing access to the normalized cache created by ApolloClient.Builder.normalizedCache(NormalizedCacheFactory, CacheKeyResolver) }

idleCallback

public void idleCallback(IdleResourceCallback idleResourceCallback)

Sets the idleResourceCallback which will be called when this ApolloClient is idle.

activeCallsCount

public int activeCallsCount()

Returns the count of GraphQLCall & AppSyncPrefetch objects which are currently in progress.