ApolloClient.Builder (apollo-runtime 1.2.2 API)

java.lang.Object
- com.apollographql.apollo.ApolloClient.Builder

Enclosing class:: ApolloClient

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

Method Summary

All Methods Instance Methods Concrete Methods
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, com.apollographql.apollo.response.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`	`callFactory(okhttp3.Call.Factory factory)` Set the custom call factory for creating `Call` instances.
`ApolloClient.Builder`	`defaultCacheHeaders(CacheHeaders cacheHeaders)` Set the default `CacheHeaders` strategy that will be passed to the `com.apollographql.apollo.interceptor.FetchOptions` used in each new `ApolloCall`.
`ApolloClient.Builder`	`defaultHttpCachePolicy(com.apollographql.apollo.api.cache.http.HttpCachePolicy.Policy cachePolicy)` Sets the http cache policy to be used as default for all GraphQL `Query` operations.
`ApolloClient.Builder`	`defaultResponseFetcher(ResponseFetcher defaultResponseFetcher)` Set the default `ResponseFetcher` to be used with each new `ApolloCall`.
`ApolloClient.Builder`	`dispatcher(java.util.concurrent.Executor dispatcher)` The #`Executor` to use for dispatching the requests.
`ApolloClient.Builder`	`enableAutoPersistedQueries(boolean enableAutoPersistedQueries)`
`ApolloClient.Builder`	`httpCache(com.apollographql.apollo.api.cache.http.HttpCache httpCache)` Set the configuration to be used for request/response http cache.
`ApolloClient.Builder`	`logger(com.apollographql.apollo.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.
`ApolloClient.Builder`	`subscriptionConnectionParams(SubscriptionConnectionParams connectionParams)` Sets up subscription connection parameters to be sent to the server when connection is established with subscription server
`ApolloClient.Builder`	`subscriptionConnectionParams(SubscriptionConnectionParamsProvider provider)` Sets up subscription connection parameters to be sent to the server when connection is established with subscription server
`ApolloClient.Builder`	`subscriptionHeartbeatTimeout(long timeout, java.util.concurrent.TimeUnit timeUnit)` Sets up subscription heartbeat message timeout.
`ApolloClient.Builder`	`subscriptionTransportFactory(SubscriptionTransport.Factory subscriptionTransportFactory)` Sets up subscription transport factory to be used for subscription server communication.
`ApolloClient.Builder`	`useHttpGetMethodForPersistedQueries(boolean useHttpGetMethodForPersistedQueries)` Sets flag whether GraphQL Persisted queries should be sent via HTTP GET requests.
`ApolloClient.Builder`	`useHttpGetMethodForQueries(boolean useHttpGetMethodForQueries)` Sets flag whether GraphQL queries should be sent via HTTP GET requests.

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(@NotNull
                                         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
  - callFactory
```
public ApolloClient.Builder callFactory(@NotNull
                                        okhttp3.Call.Factory factory)
```
    Set the custom call factory for creating Call instances.
    Note: Calling okHttpClient(OkHttpClient) automatically sets this value.
  - serverUrl
```
public ApolloClient.Builder serverUrl(@NotNull
                                      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(@NotNull
                                      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
  - httpCache
```
public ApolloClient.Builder httpCache(@NotNull
                                      com.apollographql.apollo.api.cache.http.HttpCache httpCache)
```
    Set the configuration to be used for request/response http cache.
    
    Parameters:
    
    httpCache - The 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(@NotNull
                                            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(@NotNull
                                            NormalizedCacheFactory normalizedCacheFactory,
                                            @NotNull
                                            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(@NotNull
                                                     com.apollographql.apollo.api.ScalarType scalarType,
                                                     @NotNull
                                                     com.apollographql.apollo.response.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(@NotNull
                                       java.util.concurrent.Executor dispatcher)
```
    The #Executor to use for dispatching the requests.
    
    Returns:
    
    The ApolloClient.Builder object to be used for chaining method calls
  - defaultHttpCachePolicy
```
public ApolloClient.Builder defaultHttpCachePolicy(@NotNull
                                                   com.apollographql.apollo.api.cache.http.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
  - defaultCacheHeaders
```
public ApolloClient.Builder defaultCacheHeaders(@NotNull
                                                CacheHeaders cacheHeaders)
```
    Set the default CacheHeaders strategy that will be passed to the com.apollographql.apollo.interceptor.FetchOptions used in each new ApolloCall.
    
    Returns:
    
    The ApolloClient.Builder object to be used for chaining method calls
  - defaultResponseFetcher
```
public ApolloClient.Builder defaultResponseFetcher(@NotNull
                                                   ResponseFetcher defaultResponseFetcher)
```
    Set the default ResponseFetcher to be used with each new ApolloCall.
    
    Returns:
    
    The ApolloClient.Builder object to be used for chaining method calls
  - logger
```
public ApolloClient.Builder logger(@Nullable
                                   com.apollographql.apollo.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(@NotNull
                                                      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
  - enableAutoPersistedQueries
```
public ApolloClient.Builder enableAutoPersistedQueries(boolean enableAutoPersistedQueries)
```
    Parameters:
    
    enableAutoPersistedQueries - True if ApolloClient should enable Automatic Persisted Queries support. Default: false.
    
    Returns:
    
    The ApolloClient.Builder object to be used for chaining method calls
  - subscriptionTransportFactory
```
public ApolloClient.Builder subscriptionTransportFactory(@NotNull
                                                         SubscriptionTransport.Factory subscriptionTransportFactory)
```
    Sets up subscription transport factory to be used for subscription server communication.
    See also: WebSocketSubscriptionTransport
    
    Parameters:
    
    subscriptionTransportFactory - transport layer to be used for subscriptions.
    
    Returns:
    
    The ApolloClient.Builder object to be used for chaining method calls
  - subscriptionConnectionParams
```
public ApolloClient.Builder subscriptionConnectionParams(@NotNull
                                                         SubscriptionConnectionParams connectionParams)
```
    Sets up subscription connection parameters to be sent to the server when connection is established with subscription server
    
    Parameters:
    
    connectionParams - map of connection parameters to be sent
    
    Returns:
    
    The ApolloClient.Builder object to be used for chaining method calls
  - subscriptionConnectionParams
```
public ApolloClient.Builder subscriptionConnectionParams(@NotNull
                                                         SubscriptionConnectionParamsProvider provider)
```
    Sets up subscription connection parameters to be sent to the server when connection is established with subscription server
    
    Parameters:
    
    provider - connection parameters provider
    
    Returns:
    
    The ApolloClient.Builder object to be used for chaining method calls
  - subscriptionHeartbeatTimeout
```
public ApolloClient.Builder subscriptionHeartbeatTimeout(long timeout,
                                                         @NotNull
                                                         java.util.concurrent.TimeUnit timeUnit)
```
    Sets up subscription heartbeat message timeout. Timeout for how long subscription manager should wait for a keep-alive message from the subscription server before reconnect. NOTE: will be ignored if server doesn't send keep-alive messages.
    . By default heartbeat timeout is disabled.
    
    Parameters:
    
    timeout - connection keep alive timeout. Min value is 10 secs.
    
    timeUnit - time unit
    
    Returns:
    
    The ApolloClient.Builder object to be used for chaining method calls
  useHttpGetMethodForQueries
  
  public ApolloClient.Builder useHttpGetMethodForQueries(boolean useHttpGetMethodForQueries)
  
  Sets flag whether GraphQL queries should be sent via HTTP GET requests.
  
  Parameters:
  
  useHttpGetMethodForQueries - true if HTTP GET requests should be used, false otherwise.
  
  Returns:
  
  The ApolloClient.Builder object to be used for chaining method calls
  
  useHttpGetMethodForPersistedQueries
  
  public ApolloClient.Builder useHttpGetMethodForPersistedQueries(boolean useHttpGetMethodForPersistedQueries)
  
  Sets flag whether GraphQL Persisted queries should be sent via HTTP GET requests.
  
  Parameters:
  
  useHttpGetMethodForPersistedQueries - true if HTTP GET requests should be used, false otherwise.
  
  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 Executor is used.
  
  Returns:
  
  The configured ApolloClient

Class ApolloClient.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

okHttpClient

callFactory

serverUrl

serverUrl

httpCache

normalizedCache

normalizedCache

addCustomTypeAdapter

dispatcher

defaultHttpCachePolicy

defaultCacheHeaders

defaultResponseFetcher

logger

addApplicationInterceptor

enableAutoPersistedQueries

subscriptionTransportFactory

subscriptionConnectionParams

subscriptionConnectionParams

subscriptionHeartbeatTimeout

useHttpGetMethodForQueries

useHttpGetMethodForPersistedQueries

build