apollo-runtime/com.apollographql.apollo

Package-level declarations

Types

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.

ApolloClient

class ApolloClient : ExecutionOptions, Closeable

The main entry point for the Apollo runtime. An ApolloClient is responsible for executing queries, mutations and subscriptions

AutoPersistedQueryInfo

class AutoPersistedQueryInfo(val hit: Boolean) : ExecutionContext.Element

Information about auto persisted queries

CacheDumpProviderContext

class CacheDumpProviderContext(val cacheDumpProvider: () -> Map<String, Map<String, Pair<Int, Map<String, Any?>>>>) : ExecutionContext.Element

Cache dump provider, which can be set by cache implementations.

ConcurrencyInfo

@ApolloExperimental

class ConcurrencyInfo(val dispatcher: CoroutineDispatcher, val coroutineScope: CoroutineScope) : ExecutionContext.Element

Gives access to ApolloClient dispatcher and scope. This is used by the normalized cache to execute cache writes in the background.

Properties

autoPersistedQueryInfo

val <D : Operation.Data> ApolloResponse<D>.autoPersistedQueryInfo: AutoPersistedQueryInfo?

conflateFetchPolicyInterceptorResponses

val <D : Operation.Data> ApolloRequest<D>.conflateFetchPolicyInterceptorResponses: Boolean

Functions

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.apollo.exception.ApolloCompositeException error response is emitted.