apollo-runtime/com.apollographql.apollo3/ApolloClient/Builder

Builder

class Builder : MutableExecutionOptions<ApolloClient.Builder>

A Builder used to create instances of ApolloClient

Constructors

Functions

fun <T> addCustomScalarAdapter(customScalarType: CustomScalarType, customScalarAdapter: Adapter<T>): ApolloClient.Builder

Registers the given customScalarAdapter

addCustomTypeAdapter

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_0_0)

~~fun~~ <T> ~~addCustomTypeAdapter~~(customScalarType: CustomScalarType, customTypeAdapter: CustomTypeAdapter<T>): ApolloClient.Builder

addExecutionContext

open override fun addExecutionContext(executionContext: ExecutionContext): ApolloClient.Builder

addHttpHeader

open override fun addHttpHeader(name: String, value: String): ApolloClient.Builder

addHttpInterceptor

fun addHttpInterceptor(httpInterceptor: HttpInterceptor): ApolloClient.Builder

Adds httpInterceptor to the list of HTTP interceptors

addInterceptor

fun addInterceptor(interceptor: ApolloInterceptor): ApolloClient.Builder

addInterceptors

fun addInterceptors(interceptors: List<ApolloInterceptor>): ApolloClient.Builder

autoPersistedQueries

@JvmOverloads

fun autoPersistedQueries( httpMethodForHashedQueries: HttpMethod = HttpMethod.Get, httpMethodForDocumentQueries: HttpMethod = HttpMethod.Post, enableByDefault: Boolean = true): ApolloClient.Builder

Configures auto persisted queries.

build

fun build(): ApolloClient

Creates an ApolloClient from this Builder

canBeBatched

open override fun canBeBatched(canBeBatched: Boolean?): ApolloClient.Builder

copy

fun copy(): ApolloClient.Builder

customScalarAdapters

fun customScalarAdapters(customScalarAdapters: CustomScalarAdapters): ApolloClient.Builder

dispatcher

fun dispatcher(dispatcher: CoroutineDispatcher?): ApolloClient.Builder

Changes the CoroutineDispatcher used for I/O intensive work like reading the network or the cache On the JVM the dispatcher is kotlinx.coroutines.Dispatchers.IO by default. On native this function has no effect. Network request use the default NSURLConnection threads and the cache uses a background dispatch queue.

enableAutoPersistedQueries

open override fun enableAutoPersistedQueries(enableAutoPersistedQueries: Boolean?): ApolloClient.Builder

executionContext

fun executionContext(executionContext: ExecutionContext): ApolloClient.Builder

httpBatching

@JvmOverloads

fun httpBatching( batchIntervalMillis: Long = 10, maxBatchSize: Int = 10, enableByDefault: Boolean = true): ApolloClient.Builder

Batch HTTP queries to execute multiple at once. This reduces the number of HTTP round trips at the price of increased latency as every request in the batch is now as slow as the slowest one. Some servers might have a per-HTTP-call cache making it faster to resolve 1 big array of n queries compared to resolving the n queries separately.

httpEngine

fun httpEngine(httpEngine: HttpEngine): ApolloClient.Builder

The HttpEngine to use for HTTP requests

httpExposeErrorBody

fun httpExposeErrorBody(httpExposeErrorBody: Boolean): ApolloClient.Builder

Configures whether to expose the error body in ApolloHttpException.

httpHeaders

open override fun httpHeaders(httpHeaders: List<HttpHeader>?): ApolloClient.Builder

httpMethod

open override fun httpMethod(httpMethod: HttpMethod?): ApolloClient.Builder

httpServerUrl

fun httpServerUrl(httpServerUrl: String): ApolloClient.Builder

The url of the GraphQL server used for HTTP

interceptors

fun interceptors(interceptors: List<ApolloInterceptor>): ApolloClient.Builder

networkTransport

fun networkTransport(networkTransport: NetworkTransport): ApolloClient.Builder

requestedDispatcher

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_3_3)

~~fun~~ ~~requestedDispatcher~~(requestedDispatcher: CoroutineDispatcher?): ApolloClient.Builder

sendApqExtensions

open override fun sendApqExtensions(sendApqExtensions: Boolean?): ApolloClient.Builder

sendDocument

open override fun sendDocument(sendDocument: Boolean?): ApolloClient.Builder

serverUrl

fun serverUrl(serverUrl: String): ApolloClient.Builder

The url of the GraphQL server used for HTTP

subscriptionNetworkTransport

fun subscriptionNetworkTransport(subscriptionNetworkTransport: NetworkTransport): ApolloClient.Builder

useHttpGetMethodForPersistedQueries

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_0_0)

~~fun~~ ~~useHttpGetMethodForPersistedQueries~~(useHttpGetMethodForQueries: Boolean): ApolloClient.Builder

useHttpGetMethodForQueries

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_0_0)

~~fun~~ ~~useHttpGetMethodForQueries~~(useHttpGetMethodForQueries: Boolean): ApolloClient.Builder

webSocketEngine

fun webSocketEngine(webSocketEngine: WebSocketEngine): ApolloClient.Builder

The WebSocketEngine to use for WebSocket requests

webSocketIdleTimeoutMillis

fun webSocketIdleTimeoutMillis(webSocketIdleTimeoutMillis: Long): ApolloClient.Builder

The timeout after which an inactive WebSocket will be closed

webSocketReconnectWhen

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_0_1)

~~fun~~ ~~webSocketReconnectWhen~~(reconnectWhen: (Throwable) -> Boolean?): ApolloClient.Builder

webSocketReopenWhen

fun webSocketReopenWhen(webSocketReopenWhen: suspend (Throwable, attempt: Long) -> Boolean): ApolloClient.Builder

Configure the WebSocketNetworkTransport to reopen the websocket automatically when a network error happens

webSocketServerUrl

fun webSocketServerUrl(webSocketServerUrl: String): ApolloClient.Builder

The url of the GraphQL server used for WebSockets Use this function or webSocketServerUrl((suspend () -> String)) but not both.

fun webSocketServerUrl(webSocketServerUrl: suspend () -> String): ApolloClient.Builder

Configure dynamically the url of the GraphQL server used for WebSockets. Use this function or webSocketServerUrl(String) but not both.

wsProtocol

fun wsProtocol(wsProtocolFactory: WsProtocol.Factory): ApolloClient.Builder

The WsProtocol.Factory to use for websockets

Properties

canBeBatched

open override var canBeBatched: Boolean? = null

enableAutoPersistedQueries

open override var enableAutoPersistedQueries: Boolean? = null

executionContext

open override var executionContext: ExecutionContext

httpHeaders

open override var httpHeaders: List<HttpHeader>? = null

httpMethod

open override var httpMethod: HttpMethod? = null

interceptors

val interceptors: List<ApolloInterceptor>

sendApqExtensions

open override var sendApqExtensions: Boolean? = null

sendDocument

open override var sendDocument: Boolean? = null

Extensions

okHttpCallFactory

fun ApolloClient.Builder.okHttpCallFactory(callFactory: Call.Factory): ApolloClient.Builder

Configures the ApolloClient to use the callFactory for network requests.

okHttpClient

fun ApolloClient.Builder.okHttpClient(okHttpClient: OkHttpClient): ApolloClient.Builder

Configures the ApolloClient to use the OkHttpClient for network requests. The OkHttpClient will be used for both HTTP and WebSocket requests.