apollo-api/com.apollographql.apollo.api/Operation

Operation

interface Operation<D : Operation.Data> : Executable<D>

Represents a GraphQL operation (mutation, query or subscription).

Inheritors

Mutation

Query

Subscription

Types

Data

interface Data : Executable.Data

Marker interface for generated models built from data returned by the server in response to this operation.

Functions

adapter

abstract fun adapter(): Adapter<D>

The Adapter that maps the server response data to/from generated model class D.

composeData

fun <D : Executable.Data> Executable<D>.composeData(jsonWriter: JsonWriter, customScalarAdapters: CustomScalarAdapters, value: D)

composeJsonRequest

@JvmOverloads

fun <D : Operation.Data> Operation<D>.composeJsonRequest(jsonWriter: JsonWriter, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty)

Reads a GraphQL Json response like below to a ApolloResponse

composeJsonResponse

@ApolloExperimental

fun <D : Operation.Data> Operation<D>.composeJsonResponse(data: D, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty): String

@JvmOverloads

fun <D : Operation.Data> Operation<D>.composeJsonResponse(jsonWriter: JsonWriter, data: D, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty)

writes a successful GraphQL Json response containing "data" to the given sink.

document

abstract fun document(): String

The GraphQL operation String to be sent to the server. This might differ from the input *.graphql file with:

falseVariables

fun <D : Executable.Data> Executable<D>.falseVariables(customScalarAdapters: CustomScalarAdapters): Set<String>

Returns the Set of boolean variables that are false either explicitly or because there is a default value

abstract fun id(): String

An unique identifier for the operation. Used for Automatic Persisted Queries. You can customize it with a OperationIdGenerator

name

abstract fun name(): String

The GraphQL operation name as in the *.graphql file.

parseData

@JvmOverloads

fun <D : Executable.Data> Executable<D>.parseData(jsonReader: JsonReader, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty, falseVariables: Set<String>? = null, deferredFragmentIds: Set<DeferredFragmentIdentifier>? = null, errors: List<Error>? = null): D?

parseJsonResponse

@JvmOverloads

fun <D : Operation.Data> Operation<D>.~~parseJsonResponse~~(jsonReader: JsonReader, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty, deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>? = null): ApolloResponse<D>

Reads a GraphQL Json response to a ApolloResponse. GraphQL Json responses look like so:

parseResponse

@JvmOverloads

fun <D : Operation.Data> Operation<D>.parseResponse(jsonReader: JsonReader, requestUuid: Uuid? = null, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty, deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>? = null): ApolloResponse<D>

Reads a GraphQL Json response like below to a ApolloResponse. GraphQL Json responses look like so:

rootField

abstract fun rootField(): CompiledField

A list of CompiledSelection. Used when reading from the cache and/or normalizing a model. Use com.apollographql.apollo.cache.normalized.ApolloStore.readOperation for a higher level API

serializeVariables

abstract fun serializeVariables(writer: JsonWriter, customScalarAdapters: CustomScalarAdapters, withDefaultValues: Boolean)

Serializes the variables of this operation to a json

variables

fun <D : Executable.Data> Executable<D>.variables(customScalarAdapters: CustomScalarAdapters): Executable.Variables

Returns a map of the variables as they would be sent over the wire. Use this to construct your own HTTP requests

fun <D : Executable.Data> Executable<D>.variables(customScalarAdapters: CustomScalarAdapters, withDefaultValues: Boolean): Executable.Variables

variablesJson

fun <D : Executable.Data> Executable<D>.variablesJson(customScalarAdapters: CustomScalarAdapters): String

Returns the variables as they would be sent over the wire. Use this to construct your own HTTP requests