apollo-api/com.apollographql.apollo.api/ApolloRequest/Builder

Builder

class Builder<D : Operation.Data>(val operation: Operation<D>) : MutableExecutionOptions<ApolloRequest.Builder<D>>

Constructors

Builder

constructor(operation: Operation<D>)

Properties

canBeBatched

open override var canBeBatched: Boolean?

Whether the request can be batched. Used by com.apollographql.apollo.network.http.BatchingHttpInterceptor

enableAutoPersistedQueries

open override var enableAutoPersistedQueries: Boolean?

Whether to enable Auto Persisted Queries and try to send a hashed query first. Used by com.apollographql.apollo.interceptor.AutoPersistedQueryInterceptor

executionContext

open override var executionContext: ExecutionContext

The ExecutionContext to use for the request.

extensions

var extensions: Map<String, ApolloJsonElement?>?

failFastIfOffline

var failFastIfOffline: Boolean?

httpHeaders

open override var httpHeaders: List<HttpHeader>?

HTTP headers to use for the request. Used by com.apollographql.apollo.api.http.DefaultHttpRequestComposer

httpMethod

open override var httpMethod: HttpMethod?

The HTTP method to use for the request.

ignoreApolloClientHttpHeaders

var ignoreApolloClientHttpHeaders: Boolean?

ignoreUnknownKeys

open override var ignoreUnknownKeys: Boolean?

Whether to ignore the unknown keys in the JSON response.

operation

val operation: Operation<D>

requestUuid

var requestUuid: Uuid?

retryOnError

var retryOnError: Boolean?

sendApqExtensions

open override var sendApqExtensions: Boolean?

Whether to send the Auto Persisted Queries extensions. Used by com.apollographql.apollo.api.http.DefaultHttpRequestComposer

sendDocument

open override var sendDocument: Boolean?

Whether to send the document. Used by com.apollographql.apollo.api.http.DefaultHttpRequestComposer

sendEnhancedClientAwareness

var sendEnhancedClientAwareness: Boolean

url

open override var url: String?

The url to use for that request.

Functions

addExecutionContext

open override fun addExecutionContext(executionContext: ExecutionContext): ApolloRequest.Builder<D>

addHttpHeader

open override fun addHttpHeader(name: String, value: String): ApolloRequest.Builder<D>

Add an HTTP header to be sent with the request.

build

fun build(): ApolloRequest<D>

canBeBatched

open override fun canBeBatched(canBeBatched: Boolean?): ApolloRequest.Builder<D>

enableAutoPersistedQueries

open override fun enableAutoPersistedQueries(enableAutoPersistedQueries: Boolean?): ApolloRequest.Builder<D>

executionContext

fun executionContext(executionContext: ExecutionContext): ApolloRequest.Builder<D>

extensions

fun extensions(extensions: Map<String, ApolloJsonElement?>?): ApolloRequest.Builder<D>

Custom extensions to be sent to the server. Those extensions are sent in addition to the default Apollo extensions, if any (like auto-persisted queries).

failFastIfOffline

fun failFastIfOffline(failFastIfOffline: Boolean?): ApolloRequest.Builder<D>

httpHeaders

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

Sets HTTP headers to be sent with the request.

httpMethod

open override fun httpMethod(httpMethod: HttpMethod?): ApolloRequest.Builder<D>

Configures whether the request should use GET or POST Usually, POST request can transfer bigger GraphQL documents but are more difficult to cache

ignoreApolloClientHttpHeaders

fun ignoreApolloClientHttpHeaders(ignoreApolloClientHttpHeaders: Boolean?): ApolloRequest.Builder<D>

ignoreUnknownKeys

open override fun ignoreUnknownKeys(ignoreUnknownKeys: Boolean?): ApolloRequest.Builder<D>

Sets whether to ignore the unknown keys in the JSON response.

requestUuid

fun requestUuid(requestUuid: Uuid): ApolloRequest.Builder<D>

retryOnError

fun retryOnError(retryOnError: Boolean?): ApolloRequest.Builder<D>

sendApqExtensions

open override fun sendApqExtensions(sendApqExtensions: Boolean?): ApolloRequest.Builder<D>

sendDocument

open override fun sendDocument(sendDocument: Boolean?): ApolloRequest.Builder<D>

sendEnhancedClientAwareness

fun sendEnhancedClientAwareness(sendEnhancedClientAwareness: Boolean): ApolloRequest.Builder<D>

url

open override fun url(url: String?): ApolloRequest.Builder<D>

Configures the url to use for this request.