Operation

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

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

Types

Data

common

interface Data : Executable.Data

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

Functions

adapter

common

abstract override fun adapter(): Adapter<D>

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

document

common

abstract fun document(): String

The GraphQL operation String to be sent to the server.

common

abstract fun id(): String

An unique identifier for the operation.

name

common

abstract fun name(): String

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

rootField

common

abstract override fun rootField(): CompiledField

A list of CompiledSelection.

serializeVariables

common

abstract override fun serializeVariables(writer: JsonWriter, customScalarAdapters: CustomScalarAdapters)

Serializes the variables of this operation to a json

Inheritors

Mutation

Query

Subscription

Extensions

composeJsonRequest

common

@JvmOverloads()

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

Reads a GraphQL Json response like below to a ApolloResponse

{
 "data": ...
 "errors": ...
 "extensions": ...
}

composeJsonResponse

common

@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.

parseJsonResponse

common

@JvmOverloads()

fun <D : Operation.Data> Operation<D>.parseJsonResponse(jsonReader: JsonReader, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty): ApolloResponse<D>

Reads a GraphQL Json response like below to a ApolloResponse

{
 "data": ...
 "errors": ...
 "extensions": ...
}