Package com.apollographql.apollo3

Types

ApolloCall
Link copied to clipboard
common
abstract class ApolloCall<D : Operation.Data, E : HasMutableExecutionContext<E>>(apolloClient: ApolloClient, operation: Operation<D>) : HasMutableExecutionContext<E>
ApolloClient
Link copied to clipboard
common
class ApolloClient @JvmOverloads() constructor(networkTransport: NetworkTransport, customScalarAdapters: CustomScalarAdapters, subscriptionNetworkTransport: NetworkTransport, interceptors: List<ApolloInterceptor>, executionContext: ExecutionContext, requestedDispatcher: CoroutineDispatcher?) : HasExecutionContext
The main entry point for the Apollo runtime.
ApolloMutationCall
Link copied to clipboard
common
class ApolloMutationCall<D : Mutation.Data>(apolloClient: ApolloClient, mutation: Mutation<D>) : ApolloCall<D, ApolloMutationCall<D>>
ApolloMutationCall contains everything needed to execute a Mutation with the given ApolloClientApolloMutationCall is mutable.
ApolloQueryCall
Link copied to clipboard
common
class ApolloQueryCall<D : Query.Data>(apolloClient: ApolloClient, query: Query<D>) : ApolloCall<D, ApolloQueryCall<D>>
ApolloQueryCall contains everything needed to execute a Query with the given ApolloClientApolloQueryCall is mutable.
ApolloSubscriptionCall
Link copied to clipboard
common
class ApolloSubscriptionCall<D : Subscription.Data>(apolloClient: ApolloClient, subscription: Subscription<D>) : ApolloCall<D, ApolloSubscriptionCall<D>>
ApolloSubscriptionCall contains everything needed to execute a Subscription with the given ApolloClientApolloSubscriptionCall is mutable.
AutoPersistedQueryInfo
Link copied to clipboard
common
class AutoPersistedQueryInfo(hit: Boolean) : ExecutionContext.Element
Information about auto persisted queries
ConcurrencyInfo
Link copied to clipboard
common
class ConcurrencyInfo(dispatcher: CoroutineDispatcher, coroutineScope: CoroutineScope) : ExecutionContext.Element

Functions

hashedQuery
Link copied to clipboard
common
fun <T : HasMutableExecutionContext<T>> HasMutableExecutionContext<T>.hashedQuery(hashed: Boolean): T
A shorthand method that sets sendDocument and sendApqExtensions at the same time.
useHttpGetMethodForPersistedQueries
Link copied to clipboard
common
fun ApolloClient.Builder.useHttpGetMethodForPersistedQueries(useHttpGetMethodForQueries: Boolean): ApolloClient.Builder
useHttpGetMethodForQueries
Link copied to clipboard
common
fun ApolloClient.Builder.useHttpGetMethodForQueries(useHttpGetMethodForQueries: Boolean): ApolloClient.Builder
withAutoPersistedQueries
Link copied to clipboard
common
fun ApolloClient.withAutoPersistedQueries(httpMethodForHashedQueries: HttpMethod = HttpMethod.Get, httpMethodForDocumentQueries: HttpMethod = HttpMethod.Post, hashByDefault: Boolean = true): ApolloClient
withAutoPersistedQueryInfo
Link copied to clipboard
common
fun <D : Operation.Data> ApolloResponse<D>.withAutoPersistedQueryInfo(hit: Boolean): ApolloResponse<D>
withHashedQuery
Link copied to clipboard
common
fun ApolloClient.withHashedQuery(hashed: Boolean): ApolloClient
fun <D : Operation.Data> ApolloRequest<D>.withHashedQuery(hashed: Boolean): ApolloRequest<D>
withHttpHeader
Link copied to clipboard
common
fun ApolloClient.withHttpHeader(httpHeader: HttpHeader): ApolloClient
fun ApolloClient.withHttpHeader(name: String, value: String): ApolloClient
withHttpHeaders
Link copied to clipboard
common
fun ApolloClient.withHttpHeaders(httpHeaders: List<HttpHeader>): ApolloClient
withHttpMethod
Link copied to clipboard
common
fun ApolloClient.withHttpMethod(httpMethod: HttpMethod): ApolloClient
withSendApqExtensions
Link copied to clipboard
common
fun ApolloClient.withSendApqExtensions(sendApqExtensions: Boolean): ApolloClient
withSendDocument
Link copied to clipboard
common
fun ApolloClient.withSendDocument(sendDocument: Boolean): ApolloClient

Properties

autoPersistedQueryInfo
Link copied to clipboard
common
val <D : Operation.Data> ApolloResponse<D>.autoPersistedQueryInfo: AutoPersistedQueryInfo?