A property delegate that stores the given property as it would be serialized in a Json This is needed in Data Builders because the serializer only work from Json

BuilderScope

interface BuilderScope

BVariable

data class BVariable(val name: String) : BTerm

A term that comes from @include/@skip or @defer directives and that needs to be matched against operation variables

CompiledArgument

class CompiledArgument

The Kotlin representation of a GraphQL argument

CompiledCondition

data class CompiledCondition(val name: String, val inverted: Boolean)

CompiledField

class CompiledField : CompiledSelection

A compiled field from a GraphQL operation

CompiledFragment

class CompiledFragment : CompiledSelection

A compiled inline fragment or fragment spread

CompiledListType

class CompiledListType(val ofType: CompiledType) : CompiledType

CompiledNamedType

sealed class CompiledNamedType : CompiledType

CompiledNotNullType

class CompiledNotNullType(val ofType: CompiledType) : CompiledType

CompiledSelection

sealed class CompiledSelection

CompiledType

sealed class CompiledType

CompiledVariable

class CompiledVariable(val name: String)

The Kotlin representation of a GraphQL variable value

CompositeAdapter

interface CompositeAdapter<T>

A CompositeAdapter is responsible for adapting Kotlin-generated GraphQL composite types to/from their Json representation.

CompositeAdapterContext

class CompositeAdapterContext

CustomScalarAdapters

class CustomScalarAdapters : ExecutionContext.Element

A wrapper around a MapAdapter> used to retrieve custom scalar adapters at runtime

CustomScalarType

class CustomScalarType(val name: String, val className: String) : CompiledNamedType

A GraphQL scalar type that is mapped to a Kotlin. This is named "Custom" for historical reasons but is also used for builtin scalars

DefaultFakeResolver

open class DefaultFakeResolver(types: List<CompiledNamedType>) : FakeResolver

A FakeResolver that generates:

DefaultUpload

class DefaultUpload : Upload

A default Upload that can upload from a wide variety of content

DeferredFragmentIdentifier

data class DeferredFragmentIdentifier(val path: List<Any>, val label: String?)

EnumType

class EnumType(val name: String, val values: List<String>) : CompiledNamedType

Error

class Error(val message: String, val locations: List<Error.Location>?, val path: List<Any>?, val extensions: Map<String, Any?>?, val nonStandardFields: Map<String, Any?>?)

Represents an error response returned from the GraphQL server See https://spec.graphql.org/draft/#sec-Errors.Error-result-format

Executable

interface Executable<D : Executable.Data>

Base interface for Operation and Fragment that have a CompositeAdapter and Variables.

ExecutionContext

interface ExecutionContext

A context of GraphQL operation execution, represented as a set of Key keys and corresponding Element values.

ExecutionOptions

interface ExecutionOptions

FakeResolver

interface FakeResolver

Provides fakes values for Data builders

FakeResolverContext

class FakeResolverContext

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

ImmutableMapBuilder

class ImmutableMapBuilder<K, V>

A helper class to make it easier to build Maps from the java codegen

InputObjectType

class InputObjectType(val name: String) : CompiledNamedType

InterfaceType

class InterfaceType : CompiledNamedType

ListAdapter

class ListAdapter<T>(wrappedAdapter: Adapter<T>) : Adapter<List<@JvmSuppressWildcards T>>

This file contains a list of Adapter for standard types

ListCompositeAdapter

class ListCompositeAdapter<T>(wrappedAdapter: CompositeAdapter<T>) : CompositeAdapter<List<@JvmSuppressWildcards T>>

MutableExecutionOptions

interface MutableExecutionOptions<T> : ExecutionOptions

Mutation

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

Represents a GraphQL mutation operation that will be sent to the server.

NullableAdapter

class NullableAdapter<T : Any>(wrappedAdapter: Adapter<T>) : Adapter<@JvmSuppressWildcards T?>

NullableCompositeAdapter

class NullableCompositeAdapter<T : Any>(wrappedAdapter: CompositeAdapter<T>) : CompositeAdapter<@JvmSuppressWildcards T?>

ObjectBuilder

abstract class ObjectBuilder<out T : Map<String, Any?>>(val customScalarAdapters: CustomScalarAdapters) : BuilderScope

ObjectCompositeAdapter

class ObjectCompositeAdapter<T>(wrappedAdapter: CompositeAdapter<T>, buffered: Boolean) : CompositeAdapter<@JvmSuppressWildcards T>

ObjectMap

abstract class ObjectMap(__fields: Map<String, Any?>) : Map<String, Any?>

ObjectType

class ObjectType : CompiledNamedType

Operation

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

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

Optional

sealed class Optional<out V>

A sealed class that can either be Present or Absent

OptionalAdapter

class ~~OptionalAdapter~~<T>(wrappedAdapter: Adapter<T>) : Adapter<Optional.Present<@JvmSuppressWildcards T>>

PresentAdapter

class PresentAdapter<T>(wrappedAdapter: Adapter<T>) : Adapter<Optional.Present<@JvmSuppressWildcards T>>

PresentAdapter can only express something that's present. Absent values are handled outside of the adapter.

PresentCompositeAdapter

class PresentCompositeAdapter<T>(wrappedAdapter: CompositeAdapter<T>) : CompositeAdapter<Optional.Present<@JvmSuppressWildcards T>>

Query

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

Represents a GraphQL query that will be sent to the server.

ScalarType

class ScalarType(val name: String) : CompiledNamedType

TODO v4: remove (see also CustomScalarType above

Subscription

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

Represents a GraphQL subscription.

UnionType

class UnionType(val name: String, val members: ObjectType) : CompiledNamedType

Upload

interface Upload

A class that represents a file upload in a multipart upload See https://github.com/jaydenseric/graphql-multipart-request-spec

Functions

adaptValue

fun <T> adaptValue(adapter: Adapter<T>, value: T): Any?

fun <T> adaptValue(adapter: CompositeAdapter<T>, value: T): Any?

and

fun <T : Any> and(vararg other: BooleanExpression<T>): BooleanExpression<T>

and

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

fun <T : Any> BooleanExpression<T>.~~and~~(vararg other: BooleanExpression<T>): BooleanExpression<T>

apolloUnsafeCast

actual inline fun <T> Any.apolloUnsafeCast(): T

@ApolloExperimental

expect inline fun <T> Any.apolloUnsafeCast(): T

Uses unsafeCast on JS or a regular as unsafe cast on other platforms.

actual inline fun <T> Any.apolloUnsafeCast(): T

array

@JvmName(name = "-array")

inline fun <T> Adapter<T>.array(): Adapter<Array<T>>

@JvmName(name = "-array2")

inline fun <T> CompositeAdapter<T>.array(): CompositeAdapter<Array<T>>

Note that Arrays require their type to be known at compile time, so we construct an anonymous object with reference to function with reified type parameters as a workaround.

buildData

fun <T> buildData(adapter: CompositeAdapter<T>, selections: List<CompiledSelection>, typename: String, map: Map<String, Any?>, resolver: FakeResolver, customScalarAdapters: CustomScalarAdapters): T

fun <T, Builder : ObjectBuilder<*>> buildData(builderFactory: BuilderFactory<Builder>, block: Builder.() -> Unit, adapter: CompositeAdapter<T>, selections: List<CompiledSelection>, typename: String, resolver: FakeResolver, customScalarAdapters: CustomScalarAdapters): T

Builder

fun Builder(customScalarAdapters: CustomScalarAdapters): BuilderScope

checkFieldNotMissing

fun checkFieldNotMissing(value: Any?, name: String)

Helper function for the JavaCodegen

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

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

containsPossibleTypes

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

fun <T : Any> BooleanExpression<T>.~~containsPossibleTypes~~(): Boolean

defaultApolloUnsafeCast

inline fun <T> Any.defaultApolloUnsafeCast(): T

evaluate

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

fun <T : Any> BooleanExpression<T>.~~evaluate~~(block: (T) -> Boolean): Boolean

fun BooleanExpression<BTerm>.evaluate(variables: Set<String>, typename: String?, deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>?, path: List<Any>?): Boolean

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

firstElementOfType

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

fun <T : Any, U : Any> BooleanExpression<T>.~~firstElementOfType~~(type: KClass<U>): U?

fromJson

fun <T> CompositeAdapter<T>.fromJson(reader: JsonReader, customScalarAdapters: CustomScalarAdapters): T

isComposite

fun CompiledNamedType.isComposite(): Boolean

keyFields

fun CompiledNamedType.keyFields(): List<String>

label

fun label(label: String? = null): BooleanExpression<BLabel>

list

@JvmName(name = "-list")

fun <T> Adapter<T>.list(): ListAdapter<T>

@JvmName(name = "-list")

fun CompiledType.list(): CompiledListType

@JvmName(name = "-list")

fun <T> CompositeAdapter<T>.list(): ListCompositeAdapter<T>

not

fun <T : Any> not(other: BooleanExpression<T>): BooleanExpression<T>

notNull

@JvmName(name = "-notNull")

fun CompiledType.notNull(): CompiledNotNullType

nullable

@JvmName(name = "-nullable")

fun <T : Any> Adapter<T>.nullable(): NullableAdapter<T>

@JvmName(name = "-nullable")

fun <T : Any> CompositeAdapter<T>.nullable(): NullableCompositeAdapter<T>

obj

@JvmName(name = "-obj")

fun <T> CompositeAdapter<T>.obj(buffered: Boolean = false): ObjectCompositeAdapter<T>

optional

@JvmName(name = "-optional")

fun <T> Adapter<T>.~~optional~~(): PresentAdapter<T>

fun <T : Any> or(vararg other: BooleanExpression<T>): BooleanExpression<T>

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

fun <T : Any> BooleanExpression<T>.or(vararg other: BooleanExpression<T>): BooleanExpression<T>

parseData

@JvmOverloads

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

parseJsonResponse

@JvmOverloads

@ApolloExperimental

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

@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 like below to a ApolloResponse

possibleTypes

fun possibleTypes(vararg typenames: String): BooleanExpression<BPossibleTypes>

fun possibleTypes(allTypes: List<CompiledType>, type: CompiledNamedType): List<ObjectType>

Returns all objects that implement type

present

@JvmName(name = "-present")

fun <T> Adapter<T>.present(): PresentAdapter<T>

@JvmName(name = "-present")

fun <T> CompositeAdapter<T>.present(): PresentCompositeAdapter<T>

resolveVariables

fun resolveVariables(value: Any?, variables: Executable.Variables): Any?

Resolve all variables that may be contained inside value

toJson

actual fun Operation.Data.toJson(jsonWriter: JsonWriter, customScalarAdapters: CustomScalarAdapters)

fun Operation.Data.toJson(customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty): String

expect fun Operation.Data.toJson(jsonWriter: JsonWriter, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty)

fun <T> CompositeAdapter<T>.toJson(writer: JsonWriter, customScalarAdapters: CustomScalarAdapters, value: T)

actual fun Operation.Data.toJson(jsonWriter: JsonWriter, customScalarAdapters: CustomScalarAdapters)

toJsonString

@JvmName(name = "-toJson")

@JvmOverloads

fun <T> Adapter<T>.toJsonString(value: T, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty, indent: String? = null): String

@JvmName(name = "-toJson")

@JvmOverloads

fun <T> CompositeAdapter<T>.toJsonString(value: T, adapterContext: CompositeAdapterContext = CompositeAdapterContext.Builder().build(), indent: String? = null): String

@ApolloExperimental