com.apollographql.apollo

Class ApolloClient.Builder

java.lang.Object

com.apollographql.apollo.ApolloClient.Builder

Enclosing class:

ApolloClient

public static class ApolloClient.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
ApolloClient.Builder	addApplicationInterceptor(ApolloInterceptor interceptor) Adds an interceptor that observes the full span of each call: from before the connection is established until after the response source is selected (either the server, cache or both).
<T> ApolloClient.Builder	addCustomTypeAdapter(com.apollographql.apollo.api.ScalarType scalarType, CustomTypeAdapter<T> customTypeAdapter) Set the type adapter to use for serializing and de-serializing custom GraphQL scalar types.
ApolloClient	build() Builds the ApolloClient instance using the configured values.
ApolloClient.Builder	defaultCacheControl(CacheControl cacheControl) Set the default CacheControl strategy that will be used for each new ApolloCall.
ApolloClient.Builder	defaultCacheHeaders(CacheHeaders cacheHeaders) Set the default CacheHeaders strategy that will be passed to each new ApolloCall.
ApolloClient.Builder	defaultHttpCachePolicy(HttpCachePolicy.Policy cachePolicy) Sets the http cache policy to be used as default for all GraphQL Query operations.
ApolloClient.Builder	dispatcher(java.util.concurrent.ExecutorService dispatcher) The #ExecutorService to use for dispatching the requests.
ApolloClient.Builder	httpCacheStore(HttpCacheStore cacheStore) Set the configuration to be used for request/response http cache.
ApolloClient.Builder	logger(Logger logger) The Logger to use for logging purposes.
ApolloClient.Builder	normalizedCache(NormalizedCacheFactory normalizedCacheFactory) Set the configuration to be used for normalized cache.
ApolloClient.Builder	normalizedCache(NormalizedCacheFactory normalizedCacheFactory, CacheKeyResolver keyResolver) Set the configuration to be used for normalized cache.
ApolloClient.Builder	okHttpClient(okhttp3.OkHttpClient okHttpClient) Set the OkHttpClient to use for making network requests.
ApolloClient.Builder	serverUrl(okhttp3.HttpUrl serverUrl) Set the API server's base url.
ApolloClient.Builder	serverUrl(java.lang.String serverUrl) Set the API server's base url.

Methods inherited from class java.lang.Object

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

Method Detail

okHttpClient

public ApolloClient.Builder okHttpClient(@Nonnull
                                         okhttp3.OkHttpClient okHttpClient)

Set the OkHttpClient to use for making network requests.

Parameters:

okHttpClient - the client to use.

Returns:

The ApolloClient.Builder object to be used for chaining method calls

serverUrl

public ApolloClient.Builder serverUrl(@Nonnull
                                      okhttp3.HttpUrl serverUrl)

Set the API server's base url.

Parameters:

serverUrl - the url to set.

Returns:

The ApolloClient.Builder object to be used for chaining method calls

serverUrl

public ApolloClient.Builder serverUrl(@Nonnull
                                      java.lang.String serverUrl)

Set the API server's base url.

Parameters:

serverUrl - the url to set.

Returns:

The ApolloClient.Builder object to be used for chaining method calls

httpCacheStore

public ApolloClient.Builder httpCacheStore(@Nonnull
                                           HttpCacheStore cacheStore)

Set the configuration to be used for request/response http cache.

Parameters:

cacheStore - The store to use for reading and writing cached response.

Returns:

The ApolloClient.Builder object to be used for chaining method calls

normalizedCache

public ApolloClient.Builder normalizedCache(@Nonnull
                                            NormalizedCacheFactory normalizedCacheFactory)

Set the configuration to be used for normalized cache.

Parameters:

normalizedCacheFactory - the NormalizedCacheFactory used to construct a NormalizedCache.

Returns:

The ApolloClient.Builder object to be used for chaining method calls

normalizedCache

public ApolloClient.Builder normalizedCache(@Nonnull
                                            NormalizedCacheFactory normalizedCacheFactory,
                                            @Nonnull
                                            CacheKeyResolver keyResolver)

Set the configuration to be used for normalized cache.

Parameters:

normalizedCacheFactory - the NormalizedCacheFactory used to construct a NormalizedCache.

keyResolver - the CacheKeyResolver to use to normalize records

Returns:

The ApolloClient.Builder object to be used for chaining method calls

addCustomTypeAdapter

public <T> ApolloClient.Builder addCustomTypeAdapter(@Nonnull
                                                     com.apollographql.apollo.api.ScalarType scalarType,
                                                     @Nonnull
                                                     CustomTypeAdapter<T> customTypeAdapter)

Set the type adapter to use for serializing and de-serializing custom GraphQL scalar types.

Type Parameters:

T - the value type

Parameters:

scalarType - the scalar type to serialize/deserialize

customTypeAdapter - the type adapter to use

Returns:

The ApolloClient.Builder object to be used for chaining method calls

dispatcher

public ApolloClient.Builder dispatcher(@Nonnull
                                       java.util.concurrent.ExecutorService dispatcher)

The #ExecutorService to use for dispatching the requests.

Returns:

The ApolloClient.Builder object to be used for chaining method calls

defaultHttpCachePolicy

public ApolloClient.Builder defaultHttpCachePolicy(@Nonnull
                                                   HttpCachePolicy.Policy cachePolicy)

Sets the http cache policy to be used as default for all GraphQL Query operations. Will be ignored for any Mutation operations. By default http cache policy is set to HttpCachePolicy.NETWORK_ONLY.

Returns:

The ApolloClient.Builder object to be used for chaining method calls

defaultCacheControl

public ApolloClient.Builder defaultCacheControl(@Nonnull
                                                CacheControl cacheControl)

Set the default CacheControl strategy that will be used for each new ApolloCall.

Returns:

The ApolloClient.Builder object to be used for chaining method calls

defaultCacheHeaders

public ApolloClient.Builder defaultCacheHeaders(@Nonnull
                                                CacheHeaders cacheHeaders)

Set the default CacheHeaders strategy that will be passed to each new ApolloCall.

Returns:

The ApolloClient.Builder object to be used for chaining method calls

logger

public ApolloClient.Builder logger(@Nullable
                                   Logger logger)

The Logger to use for logging purposes.

Returns:

The ApolloClient.Builder object to be used for chaining method calls

addApplicationInterceptor

public ApolloClient.Builder addApplicationInterceptor(@Nonnull
                                                      ApolloInterceptor interceptor)

Adds an interceptor that observes the full span of each call: from before the connection is established until after the response source is selected (either the server, cache or both). This method can be called multiple times for adding multiple application interceptors.

Note: Interceptors will be called in the order in which they are added to the list of interceptors and if any of the interceptors tries to short circuit the responses, then subsequent interceptors won't be called.

Parameters:

interceptor - Application level interceptor to add

Returns:

The ApolloClient.Builder object to be used for chaining method calls

build

public ApolloClient build()

Builds the ApolloClient instance using the configured values. Note that if the dispatcher is not called, then a default ExecutorService is used.

Returns:

The configured ApolloClient