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

Fragment

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

Base interface for a fragment implementation. Fragments do not have variables per the GraphQL spec but they are inferred from arguments and used when reading the cache See https://github.com/graphql/graphql-spec/issues/204 for a proposal to add fragment arguments

Types

Data

interface Data : Executable.Data

Marker interface for generated models of this fragment

Properties

ignoreErrors

abstract val ignoreErrors: Boolean

A flag to disable error checking for the whole operation. Used for backward compatibility.

Functions

adapter

abstract override 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)

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

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?

rootField

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, 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