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

Builder

class Builder : MutableExecutionOptions<ApolloClient.Builder>

A Builder used to create instances of ApolloClient.

Constructors

constructor()

Properties

open override var canBeBatched: Boolean?

customScalarAdapters

val customScalarAdapters: CustomScalarAdapters

var dispatcher: CoroutineDispatcher?

enableAutoPersistedQueries

open override var enableAutoPersistedQueries: Boolean?

executionContext

open override var executionContext: ExecutionContext

failFastIfOffline

@ApolloExperimental

var failFastIfOffline: Boolean?

var httpEngine: HttpEngine?

httpExposeErrorBody

var httpExposeErrorBody: Boolean?

open override var httpHeaders: List<HttpHeader>?

httpInterceptors

val httpInterceptors: List<HttpInterceptor>

open override var httpMethod: HttpMethod?

var httpServerUrl: String?

val interceptors: List<ApolloInterceptor>

@ApolloExperimental

var networkMonitor: NetworkMonitor?

networkTransport

var networkTransport: NetworkTransport?

@ApolloExperimental

var retryOnError: (ApolloRequest<*>) -> Boolean?

sendApqExtensions

open override var sendApqExtensions: Boolean?

open override var sendDocument: Boolean?

subscriptionNetworkTransport

var subscriptionNetworkTransport: NetworkTransport?

webSocketEngine

var webSocketEngine: WebSocketEngine?

webSocketIdleTimeoutMillis

var webSocketIdleTimeoutMillis: Long?

webSocketReopenServerUrl

var webSocketReopenServerUrl: suspend () -> String?

webSocketReopenWhen

var webSocketReopenWhen: suspend (Throwable, attempt: Long) -> Boolean?

webSocketServerUrl

var webSocketServerUrl: String?

wsProtocolFactory

var wsProtocolFactory: WsProtocol.Factory?

Functions

addCustomScalarAdapter

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

Adds the given customScalarAdapter to this ApolloClient.

addExecutionContext

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

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

Adds a HttpHeader to the ApolloClient headers. The ApolloClient headers are added to the ApolloCall headers.

addHttpInterceptor

fun addHttpInterceptor(httpInterceptor: HttpInterceptor): ApolloClient.Builder

Adds httpInterceptor to the list of HTTP interceptors

fun addInterceptor(interceptor: ApolloInterceptor): ApolloClient.Builder

Adds an ApolloInterceptor to this ApolloClient.

addInterceptors

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

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

Adds several ApolloInterceptors to this ApolloClient.

fun addListener(listener: ApolloClientListener): ApolloClient.Builder

addRetryOnErrorInterceptor

@ApolloExperimental

fun ApolloClient.Builder.addRetryOnErrorInterceptor(retryWhen: suspend (ApolloException, Int) -> Boolean): ApolloClient.Builder

autoPersistedQueries

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

Configures auto persisted queries.

fun build(): ApolloClient

Creates an ApolloClient from this Builder

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

Whether this operation can be batched.

conflateFetchPolicyInterceptorResponses

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

fun <T> MutableExecutionOptions<T>.~~conflateFetchPolicyInterceptorResponses~~(conflateResponses: Boolean): T

When conflateResponses is true, the fetch policy interceptors emit a single response and ignores the first cache or network error if a successful response is ultimately fetched. If no successful response can be emitted, a com.apollographql.apollo3.exception.ApolloCompositeException error response is emitted.

fun copy(): ApolloClient.Builder

customScalarAdapters

fun customScalarAdapters(customScalarAdapters: CustomScalarAdapters): ApolloClient.Builder

Configures the CustomScalarAdapters.

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

Sets the CoroutineDispatcher that the return value of ApolloCall.toFlow will flow on.

enableAutoPersistedQueries

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

Whether to enable Auto Persisted Queries (APQs for this operation.

executionContext

fun executionContext(executionContext: ExecutionContext): ApolloClient.Builder

failFastIfOffline

@ApolloExperimental

fun failFastIfOffline(failFastIfOffline: Boolean?): ApolloClient.Builder

Whether to fail fast if the device is offline.

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.

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.

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

Configures the HttpHeaders to use. These headers are added with the ApolloCall headers.

httpInterceptors

fun httpInterceptors(httpInterceptors: List<HttpInterceptor>): ApolloClient.Builder

Adds httpInterceptor to the list of HTTP interceptors.

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

Configures the HttpMethod to use.

fun httpServerUrl(httpServerUrl: String?): ApolloClient.Builder

The http:// or https:// url of the GraphQL server.

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

Sets the ApolloInterceptors on this ApolloClient.

fun listeners(listeners: List<ApolloClientListener>): ApolloClient.Builder

@ApolloExperimental

fun networkMonitor(networkMonitor: NetworkMonitor?): ApolloClient.Builder

Configures the NetworkMonitor for this ApolloClient

networkTransport

fun networkTransport(networkTransport: NetworkTransport?): ApolloClient.Builder

Configures the NetworkTransport to use for queries and mutations.

removeInterceptor

fun removeInterceptor(interceptor: ApolloInterceptor): ApolloClient.Builder

Removes an ApolloInterceptor from this ApolloClient.

@ApolloExperimental

fun retryOnError(retryOnError: (ApolloRequest<*>) -> Boolean?): ApolloClient.Builder

Configures the retryOnError default if ApolloRequest.retryOnError is not set.

sendApqExtensions

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

Whether to send the Auto Persisted Queries (APQs extensions.

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

Whether to send the GraphQL Document.

fun serverUrl(serverUrl: String): ApolloClient.Builder

The http:// or https:// url of the GraphQL server.

subscriptionNetworkTransport

fun subscriptionNetworkTransport(subscriptionNetworkTransport: NetworkTransport?): ApolloClient.Builder

Configures the NetworkTransport to use for queries and mutations.

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

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.

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

The WsProtocol.Factory to use for websockets