apollo-runtime/com.apollographql.apollo3/ApolloCall

ApolloCall

class ApolloCall<D : Operation.Data> : MutableExecutionOptions<ApolloCall<D>>

An ApolloCall is a thin class that binds an ApolloRequest with its ApolloClient. It offers a fluent way to configure the ApolloRequest.

Contrary to an ApolloRequest, an ApolloCall doesn't have a request id and a new request id is allocated every time execute or toFlow is called.

call execute for simple cases that expect a single response:

val response = apolloClient.query(myQuery).fetchPolicy(CacheOnly).execute()

call toFlow for other cases that expect multiple ApolloResponse like subscriptions and @defer:

apolloClient.subscription(mySubscription).toFlow().collect { response ->
  println(response.data)
}

Properties

canBeBatched

open override val canBeBatched: Boolean?

enableAutoPersistedQueries

open override val enableAutoPersistedQueries: Boolean?

executionContext

open override val executionContext: ExecutionContext

failFastIfOffline

@ApolloExperimental

val failFastIfOffline: Boolean?

httpHeaders

open override val httpHeaders: List<HttpHeader>?

httpMethod

open override val httpMethod: HttpMethod?

ignoreApolloClientHttpHeaders

val ignoreApolloClientHttpHeaders: Boolean?

operation

val operation: Operation<D>

retryOnError

@ApolloExperimental

val retryOnError: Boolean?

sendApqExtensions

open override val sendApqExtensions: Boolean?

sendDocument

open override val sendDocument: Boolean?

Functions

addExecutionContext

open override fun addExecutionContext(executionContext: ExecutionContext): ApolloCall<D>

addHttpHeader

open override fun addHttpHeader(name: String, value: String): ApolloCall<D>

canBeBatched

open override fun canBeBatched(canBeBatched: Boolean?): ApolloCall<D>

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.

copy