apollo-runtime/com.apollographql.apollo3/ApolloClient

ApolloClient

class ApolloClient : ExecutionOptions, Closeable

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

Types

Builder

class Builder : MutableExecutionOptions<ApolloClient.Builder>

A Builder used to create instances of ApolloClient

Companion

object Companion

Functions

open override fun close()

dispose

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_3_1)

~~fun~~ ~~dispose~~()

executeAsFlow

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

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

mutate

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_0_0)

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

mutation

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

Creates a new ApolloCall that you can customize and/or execute.

newBuilder

fun newBuilder(): ApolloClient.Builder

prefetch

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_0_0)

~~fun~~ <D : Operation.Data> ~~prefetch~~(operation: Operation<D>): Nothing

query

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

Creates a new ApolloCall that you can customize and/or execute.

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_0_0)

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

subscription

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

Creates a new ApolloCall that you can customize and/or execute.

Properties

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?

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