apollo-runtime/com.apollographql.apollo/ApolloClient

ApolloClient

class ApolloClient : ExecutionOptions, Closeable

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

Use ApolloClient.Builder to create a new ApolloClient:

val apolloClient = ApolloClient.Builder()
    .serverUrl("https://example.com/graphql")
    .build()

val response = apolloClient.query(MyQuery()).execute()
if (response.data != null) {
  // Handle (potentially partial) data
} else {
  // Something wrong happened
  if (response.exception != null) {
    // Handle fetch errors
  } else {
    // Handle GraphQL errors in response.errors
  }
}

On native targets, ApolloClient.close must be called to release resources when not in use anymore.

Types

Builder

class Builder : MutableExecutionOptions<ApolloClient.Builder>

A Builder used to create instances of ApolloClient.

Properties

cacheInterceptor

val cacheInterceptor: ApolloInterceptor?

canBeBatched

open override val canBeBatched: Boolean?

customScalarAdapters

val customScalarAdapters: CustomScalarAdapters

enableAutoPersistedQueries

open override val enableAutoPersistedQueries: Boolean?

executionContext

open override val executionContext: ExecutionContext

httpHeaders

open override val httpHeaders: List<HttpHeader>?

httpMethod

open override val httpMethod: HttpMethod?

ignoreUnknownKeys

open override val ignoreUnknownKeys: Boolean?

interceptors

val interceptors: List<ApolloInterceptor>

networkTransport

val networkTransport: NetworkTransport

sendApqExtensions

open override val sendApqExtensions: Boolean?

sendDocument

open override val sendDocument: Boolean?

subscriptionNetworkTransport

val subscriptionNetworkTransport: NetworkTransport

Functions

open override fun close()

Disposes resources held by this ApolloClient. On JVM platforms, resources are ultimately garbage collected but calling close is necessary on other platform or to reclaim those resources earlier.

executeAsFlow

fun <D : Operation.Data> executeAsFlow(apolloRequest: ApolloRequest<D>): Flow<ApolloResponse<D>>

Low level API to execute the given apolloRequest and return a Flow.

mutation

fun <D : Mutation.Data> mutation(mutation: Mutation<D>): ApolloCall<D>

Creates a new ApolloCall for the given Mutation.

newBuilder

fun newBuilder(): ApolloClient.Builder

Creates a new Builder from this ApolloClient.

query

fun <D : Query.Data> query(query: Query<D>): ApolloCall<D>

Creates a new ApolloCall for the given Query.

subscription

fun <D : Subscription.Data> subscription(subscription: Subscription<D>): ApolloCall<D>

Creates a new ApolloCall for the given Subscription.