apollo-api/com.apollographql.apollo3.api/Subscription

Subscription

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

Represents a GraphQL subscription.

Types

interface Data : Operation.Data

Functions

abstract override fun adapter(): Adapter<D>

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

abstract fun document(): String

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

abstract fun id(): String

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

abstract fun name(): String

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

abstract override fun rootField(): CompiledField

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

serializeVariables

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

Serializes the variables of this operation to a json