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

Builder

open class Builder : MutableExecutionOptions<T>

Constructors

Builder

constructor()

Properties

CAN_BE_BATCHED

val CAN_BE_BATCHED: String = "X-APOLLO-CAN-BE-BATCHED"

canBeBatched

@get:Nullable

open val canBeBatched: Boolean

Companion

val Companion: ExecutionOptions.Companion

enableAutoPersistedQueries

@get:Nullable

open val enableAutoPersistedQueries: Boolean

executionContext

@get:NotNull

open val executionContext: ExecutionContext

httpMethod

@get:Nullable

open val httpMethod: HttpMethod

sendApqExtensions

@get:Nullable

open val sendApqExtensions: Boolean

sendDocument

@get:Nullable

open val sendDocument: Boolean

Functions

addCustomScalarAdapter

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

Registers the given customScalarAdapter.

addExecutionContext

open fun addExecutionContext(@NotNull executionContext: ExecutionContext): ApolloClient.Builder

addHttpHeader

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

addHttpInterceptor

open fun addHttpInterceptor(@NotNull interceptor: HttpInterceptor): ApolloClient.Builder

addHttpInterceptors

open fun addHttpInterceptors(@NotNull interceptors: List<HttpInterceptor>): ApolloClient.Builder

addInterceptor

open fun addInterceptor(interceptor: ApolloInterceptor): ApolloClient.Builder

addInterceptors

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

addWsHeader

open fun addWsHeader(@NotNull header: HttpHeader): ApolloClient.Builder

addWsHeaders

open fun addWsHeaders(@NotNull headers: List<HttpHeader>): ApolloClient.Builder

autoPersistedQueries

open fun autoPersistedQueries(): ApolloClient.Builder

open fun autoPersistedQueries(httpMethodForHashedQueries: HttpMethod): ApolloClient.Builder

open fun autoPersistedQueries(httpMethodForHashedQueries: HttpMethod, httpMethodForDocumentQueries: HttpMethod): ApolloClient.Builder

open fun autoPersistedQueries(httpMethodForHashedQueries: HttpMethod, httpMethodForDocumentQueries: HttpMethod, enableByDefault: Boolean): ApolloClient.Builder

build

open fun build(): ApolloClient

callFactory

open fun callFactory(factory: Call.Factory): ApolloClient.Builder

Set the custom call factory for creating Call instances.

canBeBatched

open fun canBeBatched(@Nullable canBeBatched: Boolean): ApolloClient.Builder

customScalarAdapters

open fun customScalarAdapters(@NotNull customScalarAdapters: CustomScalarAdapters): ApolloClient.Builder

dispatcher

open fun dispatcher(dispatcher: Executor): ApolloClient.Builder

The Executor to use for dispatching the requests.

enableAutoPersistedQueries

open fun enableAutoPersistedQueries(@Nullable enableAutoPersistedQueries: Boolean): ApolloClient.Builder

getCanBeBatched

abstract fun getCanBeBatched(): Boolean

getEnableAutoPersistedQueries

abstract fun getEnableAutoPersistedQueries(): Boolean

getExecutionContext

abstract fun getExecutionContext(): ExecutionContext

getHttpHeaders

@Nullable

open fun getHttpHeaders(): List<HttpHeader>

getHttpMethod

abstract fun getHttpMethod(): HttpMethod

getSendApqExtensions

abstract fun getSendApqExtensions(): Boolean

getSendDocument

abstract fun getSendDocument(): Boolean

httpBatching

open fun httpBatching(batchIntervalMillis: Long, maxBatchSize: Int, enableByDefault: Boolean): ApolloClient.Builder

Batch HTTP queries to execute multiple at once.

httpEngine

open fun httpEngine(httpEngine: HttpEngine): ApolloClient.Builder

httpExposeErrorBody

open fun httpExposeErrorBody(httpExposeErrorBody: Boolean): ApolloClient.Builder

httpHeaders

open fun httpHeaders(@Nullable list: List<HttpHeader>): ApolloClient.Builder

httpInterceptors

open fun httpInterceptors(@NotNull interceptors: List<HttpInterceptor>): ApolloClient.Builder

httpMethod

open fun httpMethod(@Nullable httpMethod: HttpMethod): ApolloClient.Builder

httpServerUrl

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

The url of the GraphQL server used for HTTP.

interceptors

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

networkTransport

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

okHttpClient

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

Set the OkHttpClient to use for making network requests.

retryOnError

@ApolloExperimental

open fun retryOnError(retryOnError: ApolloClient.RetryOnError): ApolloClient.Builder

sendApqExtensions

open fun sendApqExtensions(@Nullable sendApqExtensions: Boolean): ApolloClient.Builder

sendDocument

open fun sendDocument(@Nullable sendDocument: Boolean): ApolloClient.Builder

serverUrl

open fun serverUrl(serverUrl: String): ApolloClient.Builder

The url of the GraphQL server used for HTTP.

subscriptionNetworkTransport

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

webSocketFactory

open fun webSocketFactory(factory: WebSocket.Factory): ApolloClient.Builder

Set the custom call factory for creating WebSocket instances.

webSocketServerUrl

open fun webSocketServerUrl(webSocketServerUrl: String): ApolloClient.Builder

The url of the GraphQL server used for WebSockets.

wsHeaders

open fun wsHeaders(@NotNull headers: List<HttpHeader>): ApolloClient.Builder

wsIdleTimeoutMillis

open fun wsIdleTimeoutMillis(wsIdleTimeoutMillis: Long): ApolloClient.Builder

wsProtocolFactory

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

wsReopenWhen

open fun wsReopenWhen(reopenWhen: WebSocketNetworkTransport.ReopenWhen): ApolloClient.Builder