Operation

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

Types

Data

common

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

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

serializeVariables

common

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

Serializes the variables of this operation to a json

Mutation

Query

Subscription

composeJsonRequest

common

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

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

Reads a GraphQL Json response like below to a ApolloResponse

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