Package com.apollographql.apollo3.api

Types

Adapter

common

interface Adapter<T>

An Adapter is responsible for adapting Kotlin-generated GraphQL types to/from their Json representation.

AdapterContext

common

class AdapterContext

ApolloRequest

common

class ApolloRequest<D : Operation.Data> : ExecutionOptions

A GraphQL request to execute.

ApolloResponse

common

class ApolloResponse<D : Operation.Data>

Represents a GraphQL response.

BLabel

common

data class BLabel(label: String?) : BTerm

A term that comes from @defer directives and that needs to be matched against label and current JSON path

BooleanExpression

common

sealed class BooleanExpression<out T : Any>

A boolean expression

BPossibleTypes

common

data class BPossibleTypes(possibleTypes: Set<String>) : BTerm

A term that comes from a fragment type condition and that needs to be matched against __typename

BTerm

common

sealed class BTerm

A generic term in a BooleanExpression

BVariable

common

data class BVariable(name: String) : BTerm

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

CompiledArgument

common

class CompiledArgument(name: String, value: Any?, isKey: Boolean)

The Kotlin representation of a GraphQL argumentvalue can be

String, Int, Double, Boolean
null
Map<String, Any?>
List<Any?>
CompiledVariable

Note: for now, enums are mapped to Strings

CompiledCondition

common

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

CompiledField

common

class CompiledField : CompiledSelection

A compiled field from a GraphQL operation

CompiledFragment

common

class CompiledFragment : CompiledSelection

A compiled inline fragment or fragment spread

CompiledListType

common

class CompiledListType(ofType: CompiledType) : CompiledType

CompiledNamedType

common

sealed class CompiledNamedType : CompiledType

CompiledNotNullType

common

class CompiledNotNullType(ofType: CompiledType) : CompiledType

CompiledSelection

common

sealed class CompiledSelection

CompiledType

common

sealed class CompiledType

CompiledVariable

common

class CompiledVariable(name: String)

The Kotlin representation of a GraphQL variable value

CustomScalarAdapters

common

class CustomScalarAdapters : ExecutionContext.Element

A wrapper around a Map<String, Adapter> used to retrieve custom scalar adapters at runtime

CustomScalarType

common

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

CustomTypeAdapter

common

interface CustomTypeAdapter<T>

A replica of Apollo Android v2's CustomTypeAdapter, to ease migration from v2 to v3.

CustomTypeValue

common

sealed class CustomTypeValue<T>

A replica of Apollo Android v2's CustomTypeValue, to ease migration from v2 to v3.

DefaultUpload

common

class DefaultUpload : Upload

An Upload that writes data from the provided contentIf the content is a bufferedSource, the DefaultUpload will close it once uploaded If the content is a byteString, the DefaultUpload can be reused

DeferredFragmentIdentifier

common

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

EnumType

common

class EnumType(name: String) : CompiledNamedType

Error

common

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

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

Executable

common

interface Executable<D : Executable.Data>

Base interface for Operation and Fragment that have an Adapter and Variables.

ExecutionContext

common

interface ExecutionContext

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

ExecutionOptions

common

interface ExecutionOptions

Fragment

common

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

Base interface for a fragment implementation.

ImmutableMapBuilder

common

class ImmutableMapBuilder<K, V>

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

Input

common

class Input

InputObjectType

common

class InputObjectType(name: String) : CompiledNamedType

InterfaceType

common

class InterfaceType(name: String, keyFields: List<String>, implements: List<InterfaceType>) : CompiledNamedType

ListAdapter

common

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

This file contains a list of Adapter for standard typesThey are mostly used from the generated code but could be useful in any other situations that requires adapting from GraphQL to Kotlin.

MutableExecutionOptions

common

interface MutableExecutionOptions<T> : ExecutionOptions

Mutation

common

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

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

NullableAdapter

common

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

ObjectAdapter

common

class ObjectAdapter<T>(wrappedAdapter: Adapter<T>, buffered: Boolean) : Adapter<T>

ObjectType

common

class ObjectType(name: String, keyFields: List<String>, implements: List<InterfaceType>) : CompiledNamedType

Operation

common

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

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

Optional

common

sealed class Optional<out V>

A sealed class that can either be Present or AbsentIt provides a convenient way to distinguish the case when a value is provided explicitly and should be serialized (even if it's null) and the case where it's absent and shouldn't be serialized.

OptionalAdapter

common

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

ResponseAdapters can only express something that's present.

Query

common

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

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

QueryDocumentMinifier

common

object QueryDocumentMinifier

Response

common

typealias Response<D> = ApolloResponse<D>

ScalarType

common

class ScalarType(name: String) : CompiledNamedType

ScalarTypeAdapters

common

class ScalarTypeAdapters(customAdapters: Map<CustomScalarType, CustomTypeAdapter<*>>)

A replica of Apollo Android v2's ScalarTypeAdapters, to ease migration from v2 to v3.

Subscription

common

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

Represents a GraphQL subscription.

UnionType

common

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

Upload

common

interface Upload

A class that represents a file upload in a multipart upload See https://github.

Functions

and

common

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

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

checkFieldNotMissing

common

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

Helper function for the JavaCodegen

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.

containsPossibleTypes

common

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

content

jvm

fun DefaultUpload.Builder.content(file: File): DefaultUpload.Builder

create

jvm

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_0_0)

fun create(mimetype: String, filePath: String): Upload

evaluate

common

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

fun BooleanExpression<BTerm>.evaluate(variables: Set<String>, typename: String?): Boolean

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

firstElementOfType

common

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

isComposite

common

fun CompiledNamedType.isComposite(): Boolean

keyFields

common

fun CompiledNamedType.keyFields(): List<String>

label

common

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

list

common

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

fun CompiledType.list(): CompiledListType

not

common

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

notNull

common

fun CompiledType.notNull(): CompiledNotNullType

nullable

common

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

obj

common

fun <T> Adapter<T>.obj(buffered: Boolean = false): ObjectAdapter<T>

optional

common

fun <T> Adapter<T>.optional(): OptionalAdapter<T>

common

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

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

parseJsonResponse

common

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": ...
}

possibleTypes

common

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

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

resolveVariables

common

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

Resolve all variables that may be contained inside value

toInput

common

fun <T> T.toInput(): Optional<T>

fun <T : Any> T.toInput(): Optional<T>

toJson

jvm

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

toJsonString

@ApolloExperimental()

fun Operation.Data.toJsonString(customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty, indent: String? = null): String

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

variable

common

fun variable(name: String): BooleanExpression<BVariable>

variables

common

fun <D : Executable.Data> Executable<D>.variables(customScalarAdapters: CustomScalarAdapters): Executable.Variables

variablesJson

common

fun <D : Executable.Data> Executable<D>.variablesJson(customScalarAdapters: CustomScalarAdapters): String

withDeferredFragmentIds

common

fun CustomScalarAdapters.withDeferredFragmentIds(deferredFragmentIds: Set<DeferredFragmentIdentifier>): <ERROR CLASS>

Properties

AnyAdapter

common

val AnyAdapter: Adapter<Any>

BooleanAdapter

common

val BooleanAdapter: Adapter<Boolean>

CompiledBooleanType

common

val CompiledBooleanType: ScalarType

CompiledDirectiveType

common

val CompiledDirectiveType: ObjectType

CompiledEnumValueType

common

val CompiledEnumValueType: ObjectType

CompiledFieldType

common

val CompiledFieldType: ObjectType

CompiledFloatType

common

val CompiledFloatType: ScalarType

CompiledIDType

common

val CompiledIDType: ScalarType

CompiledInputValueType

common

val CompiledInputValueType: ObjectType

CompiledIntType

common

val CompiledIntType: ScalarType

CompiledSchemaType

common

val CompiledSchemaType: ObjectType

CompiledStringType

common

val CompiledStringType: ScalarType

CompiledTypeType

common

val CompiledTypeType: ObjectType

DoubleAdapter

common

val DoubleAdapter: Adapter<Double>

FloatAdapter

common

val FloatAdapter: Adapter<Float>

An Adapter that converts to/from a Float Floats are not part of the GraphQL spec but this can be used in custom scalars

IntAdapter

common

val IntAdapter: Adapter<Int>

LongAdapter

common

val LongAdapter: Adapter<Long>

An Adapter that converts to/from a Long Longs are not part of the GraphQL spec but this can be used in custom scalarsIf the Json number does not fit in a Long, an exception will be thrown

NullableAnyAdapter

common

val NullableAnyAdapter: NullableAdapter<Any>

NullableBooleanAdapter

common

val NullableBooleanAdapter: NullableAdapter<Boolean>

NullableDoubleAdapter

common

val NullableDoubleAdapter: NullableAdapter<Double>

NullableIntAdapter

common

val NullableIntAdapter: NullableAdapter<Int>