Package com.apollographql.apollo3.api

Types

Adapter
Link copied to clipboard
common
interface Adapter<T>
Content copied to clipboard
An Adapter is responsible for adapting Kotlin-generated GraphQL types to/from their Json representation.
AnyAdapter
Link copied to clipboard
common
object AnyAdapter : Adapter<Any>
Content copied to clipboard
ApolloRequest
Link copied to clipboard
common
class ApolloRequest<D : Operation.Data> constructor(operation: Operation<D>, requestUuid: Uuid, executionContext: ExecutionContext) : HasExecutionContext
Content copied to clipboard
A GraphQL request to execute.
ApolloResponse
Link copied to clipboard
common
class ApolloResponse<out D : Operation.Data>(requestUuid: Uuid, operation: Operation<*>, data: D?, errors: List<Error>?, extensions: Map<String, Any?>, executionContext: ExecutionContext)
Content copied to clipboard
Represents a GraphQL response.
BooleanAdapter
Link copied to clipboard
common
object BooleanAdapter : Adapter<Boolean>
Content copied to clipboard
BooleanExpression
Link copied to clipboard
common
sealed class BooleanExpression<out T : Any>
Content copied to clipboard
A boolean expression
BPossibleTypes
Link copied to clipboard
common
data class BPossibleTypes(possibleTypes: Set<String>) : BTerm
Content copied to clipboard
A term that comes from a fragment type condition and that needs to be matched against __typename
BTerm
Link copied to clipboard
common
sealed class BTerm
Content copied to clipboard
A generic term in a BooleanExpression
BVariable
Link copied to clipboard
common
data class BVariable(name: String) : BTerm
Content copied to clipboard
A term that comes from @include/@skip directives and that needs to be matched against operation variables
CompiledArgument
Link copied to clipboard
common
class CompiledArgument(name: String, value: Any?, isKey: Boolean)
Content copied to clipboard
The Kotlin representation of a GraphQL argumentvalue can beNote: for now, enums are mapped to Strings
CompiledCondition
Link copied to clipboard
common
data class CompiledCondition(name: String, inverted: Boolean)
Content copied to clipboard
CompiledField
Link copied to clipboard
common
class CompiledField : CompiledSelection
Content copied to clipboard
A compiled field from a GraphQL operation
CompiledFragment
Link copied to clipboard
common
class CompiledFragment : CompiledSelection
Content copied to clipboard
A compiled inline fragment or fragment spread
CompiledListType
Link copied to clipboard
common
class CompiledListType(ofType: CompiledType) : CompiledType
Content copied to clipboard
CompiledNamedType
Link copied to clipboard
common
sealed class CompiledNamedType : CompiledType
Content copied to clipboard
CompiledNotNullType
Link copied to clipboard
common
class CompiledNotNullType(ofType: CompiledType) : CompiledType
Content copied to clipboard
CompiledSelection
Link copied to clipboard
common
sealed class CompiledSelection
Content copied to clipboard
CompiledType
Link copied to clipboard
common
sealed class CompiledType
Content copied to clipboard
CompiledVariable
Link copied to clipboard
common
class CompiledVariable(name: String)
Content copied to clipboard
The Kotlin representation of a GraphQL variable value
CustomScalarAdapters
Link copied to clipboard
common
class CustomScalarAdapters constructor(customScalarAdapters: Map<String, Adapter<*>>) : ExecutionContext.Element
Content copied to clipboard
A wrapper around a Map<String, Adapter> used to retrieve custom scalar adapters at runtime
CustomScalarType
Link copied to clipboard
common
class CustomScalarType(name: String, className: String) : CompiledNamedType
Content copied to clipboard
CustomTypeAdapter
Link copied to clipboard
common
interface CustomTypeAdapter<T>
Content copied to clipboard
A replica of Apollo Android v2's CustomTypeAdapter, to ease migration from v2 to v3.
CustomTypeValue
Link copied to clipboard
common
open class CustomTypeValue<T>(value: T)
Content copied to clipboard
A replica of Apollo Android v2's CustomTypeValue, to ease migration from v2 to v3.
DoubleAdapter
Link copied to clipboard
common
object DoubleAdapter : Adapter<Double>
Content copied to clipboard
EnumType
Link copied to clipboard
common
class EnumType(name: String) : CompiledNamedType
Content copied to clipboard
Error
Link copied to clipboard
common
class Error(message: String, locations: List<Error.Location>?, path: List<Any>?, extensions: Map<String, Any?>?, nonStandardFields: Map<String, Any?>?)
Content copied to clipboard
Represents an error response returned from the GraphQL server See https://spec.graphql.org/draft/#sec-Errors.
Executable
Link copied to clipboard
common
interface Executable<D : Executable.Data>
Content copied to clipboard
Base interface for Operation and Fragment that have an Adapter and Variables.
ExecutionContext
Link copied to clipboard
common
interface ExecutionContext
Content copied to clipboard
A context of GraphQL operation execution, represented as a set of Key keys and corresponding Element values.
FloatAdapter
Link copied to clipboard
common
object FloatAdapter : Adapter<Float>
Content copied to clipboard
An Adapter that converts to/from a Float Floats are not part of the GraphQL spec but this can be used in custom scalars
Fragment
Link copied to clipboard
common
interface Fragment<D : Fragment.Data> : Executable<D>
Content copied to clipboard
Base interface for a fragment implementation.
HasExecutionContext
Link copied to clipboard
common
interface HasExecutionContext
Content copied to clipboard
Implemented by classes that have an ExecutionContext: ApolloClient and ApolloRequest.
HasMutableExecutionContext
Link copied to clipboard
common
interface HasMutableExecutionContext<T : HasMutableExecutionContext<T>> : HasExecutionContext
Content copied to clipboard
Implemented by classes whose ExecutionContext can be mutated: ApolloClient.
ImmutableMapBuilder
Link copied to clipboard
common
class ImmutableMapBuilder<K, V>
Content copied to clipboard
A helper class to make it easier to build Maps from the java codegen
Input
Link copied to clipboard
common
class Input
Content copied to clipboard
InputObjectType
Link copied to clipboard
common
class InputObjectType(name: String) : CompiledNamedType
Content copied to clipboard
IntAdapter
Link copied to clipboard
common
object IntAdapter : Adapter<Int>
Content copied to clipboard
InterfaceType
Link copied to clipboard
common
class InterfaceType(name: String, keyFields: List<String>, implements: List<InterfaceType>) : CompiledNamedType
Content copied to clipboard
ListAdapter
Link copied to clipboard
common
class ListAdapter<T>(wrappedAdapter: Adapter<T>) : Adapter<List<@JvmSuppressWildcards() T>>
Content copied to clipboard
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.
LongAdapter
Link copied to clipboard
common
object LongAdapter : Adapter<Long>
Content copied to clipboard
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
Mutation
Link copied to clipboard
common
interface Mutation<D : Mutation.Data> : Operation<D>
Content copied to clipboard
Represents a GraphQL mutation operation that will be sent to the server.
NullableAdapter
Link copied to clipboard
common
class NullableAdapter<T : Any>(wrappedAdapter: Adapter<T>) : Adapter<@JvmSuppressWildcards() T?>
Content copied to clipboard
ObjectAdapter
Link copied to clipboard
common
class ObjectAdapter<T>(wrappedAdapter: Adapter<T>, buffered: Boolean) : Adapter<@JvmSuppressWildcards() T>
Content copied to clipboard
ObjectType
Link copied to clipboard
common
class ObjectType(name: String, keyFields: List<String>, implements: List<InterfaceType>) : CompiledNamedType
Content copied to clipboard
Operation
Link copied to clipboard
common
interface Operation<D : Operation.Data> : Executable<D>
Content copied to clipboard
Represents a GraphQL operation (mutation, query or subscription).
Optional
Link copied to clipboard
common
sealed class Optional<out V>
Content copied to clipboard
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
Link copied to clipboard
common
class OptionalAdapter<T>(wrappedAdapter: Adapter<T>) : Adapter<Optional.Present<@JvmSuppressWildcards() T>>
Content copied to clipboard
ResponseAdapters can only express something that's present.
Query
Link copied to clipboard
common
interface Query<D : Query.Data> : Operation<D>
Content copied to clipboard
Represents a GraphQL query that will be sent to the server.
QueryDocumentMinifier
Link copied to clipboard
common
object QueryDocumentMinifier
Content copied to clipboard
ScalarType
Link copied to clipboard
common
class ScalarType(name: String) : CompiledNamedType
Content copied to clipboard
StringAdapter
Link copied to clipboard
common
object StringAdapter : Adapter<String>
Content copied to clipboard
Subscription
Link copied to clipboard
common
interface Subscription<D : Subscription.Data> : Operation<D>
Content copied to clipboard
Represents a GraphQL subscription.
Throws
Link copied to clipboard
annotation class Throws(exceptionClasses: KClass<out Throwable>)
Content copied to clipboard
typealias Throws = Throws
Content copied to clipboard
UnionType
Link copied to clipboard
common
class UnionType(name: String, members: ObjectType) : CompiledNamedType
Content copied to clipboard
Upload
Link copied to clipboard
common
interface Upload
Content copied to clipboard
A class that represents a file upload in a multipart upload See https://github.
UploadAdapter
Link copied to clipboard
common
object UploadAdapter : Adapter<Upload>
Content copied to clipboard

Functions

and
Link copied to clipboard
common
fun <T : Any> and(vararg other: BooleanExpression<T>): BooleanExpression<T>
Content copied to clipboard
fun <T : Any> BooleanExpression<T>.and(vararg other: BooleanExpression<T>): BooleanExpression<T>
Content copied to clipboard
checkFieldNotMissing
Link copied to clipboard
common
fun checkFieldNotMissing(value: Any?, name: String)
Content copied to clipboard
Helper function for the JavaCodegen
composeJsonData
Link copied to clipboard
common
fun <D : Operation.Data> Operation<D>.composeJsonData(data: D): String
Content copied to clipboard
fun <D : Operation.Data> Operation<D>.composeJsonData(sink: BufferedSink, data: D)
Content copied to clipboard
See composeJsonData
fun <D : Operation.Data> Operation<D>.composeJsonData(data: D, customScalarAdapters: CustomScalarAdapters, indent: String): String
Content copied to clipboard
See composeJsonData
fun <D : Operation.Data> Operation<D>.composeJsonData(sink: BufferedSink, data: D, customScalarAdapters: CustomScalarAdapters, indent: String)
Content copied to clipboard
writes operation data to the given sinkUse this for testing/mocking a valid GraphQL response
composeJsonRequest
Link copied to clipboard
common
fun <D : Operation.Data> Operation<D>.composeJsonRequest(): String
Content copied to clipboard
see composeJsonRequest
fun <D : Operation.Data> Operation<D>.composeJsonRequest(customScalarAdapters: CustomScalarAdapters): String
Content copied to clipboard
see composeJsonRequest
fun <D : Operation.Data> Operation<D>.composeJsonRequest(sink: BufferedSink)
Content copied to clipboard
See composeJsonRequest
fun <D : Operation.Data> Operation<D>.composeJsonRequest(sink: BufferedSink, customScalarAdapters: CustomScalarAdapters)
Content copied to clipboard
writes the body of a GraphQL json request like below: { "query": ...
composeJsonResponse
Link copied to clipboard
common
fun <D : Operation.Data> Operation<D>.composeJsonResponse(data: D): String
Content copied to clipboard
see composeJsonResponse
fun <D : Operation.Data> Operation<D>.composeJsonResponse(sink: BufferedSink, data: D)
Content copied to clipboard
See composeJsonResponse
fun <D : Operation.Data> Operation<D>.composeJsonResponse(data: D, customScalarAdapters: CustomScalarAdapters, indent: String): String
Content copied to clipboard
see composeJsonResponse
fun <D : Operation.Data> Operation<D>.composeJsonResponse(sink: BufferedSink, data: D, customScalarAdapters: CustomScalarAdapters, indent: String)
Content copied to clipboard
writes a successful GraphQL Json response containing "data" to the given sink.
evaluate
Link copied to clipboard
common
fun <T : Any> BooleanExpression<T>.evaluate(block: (T) -> Boolean): Boolean
Content copied to clipboard
fun BooleanExpression<BTerm>.evaluate(variables: Set<String>, typename: String): Boolean
Content copied to clipboard
fromFile
Link copied to clipboard
fun Upload.Companion.fromFile(file: File, contentType: String): Upload
Content copied to clipboard
fromJson
Link copied to clipboard
common
fun <T> Adapter<T>.fromJson(string: String): T
Content copied to clipboard
See fromJson
fun <T> Adapter<T>.fromJson(bufferedSource: BufferedSource): T
Content copied to clipboard
See fromJson
fun <T> Adapter<T>.fromJson(string: String, customScalarAdapters: CustomScalarAdapters): T
Content copied to clipboard
See fromJson
fun <T> Adapter<T>.fromJson(bufferedSource: BufferedSource, customScalarAdapters: CustomScalarAdapters): T
Content copied to clipboard
Converts the given bufferedSource to a T
fromMap
Link copied to clipboard
common
fun <T, M : Map<String, Any?>> Adapter<T>.fromMap(map: M): T
Content copied to clipboard
See fromMap
fun <T, M : Map<String, Any?>> Adapter<T>.fromMap(map: M, customScalarAdapters: CustomScalarAdapters): T
Content copied to clipboard
Converts the given Map to a T
isComposite
Link copied to clipboard
common
fun CompiledNamedType.isComposite(): Boolean
Content copied to clipboard
keyFields
Link copied to clipboard
common
fun CompiledNamedType.keyFields(): List<String>
Content copied to clipboard
list
Link copied to clipboard
common
@JvmName(name = -list)
fun <T> Adapter<T>.list(): ListAdapter<T>
Content copied to clipboard
@JvmName(name = -list)
fun CompiledType.list(): CompiledListType
Content copied to clipboard
not
Link copied to clipboard
common
fun <T : Any> not(other: BooleanExpression<T>): BooleanExpression<T>
Content copied to clipboard
notNull
Link copied to clipboard
common
@JvmName(name = -notNull)
fun CompiledType.notNull(): CompiledNotNullType
Content copied to clipboard
nullable
Link copied to clipboard
common
@JvmName(name = -nullable)
fun <T : Any> Adapter<T>.nullable(): NullableAdapter<T>
Content copied to clipboard
obj
Link copied to clipboard
common
@JvmName(name = -obj)
fun <T> Adapter<T>.obj(buffered: Boolean = false): ObjectAdapter<T>
Content copied to clipboard
optional
Link copied to clipboard
common
@JvmName(name = -optional)
fun <T> Adapter<T>.optional(): OptionalAdapter<T>
Content copied to clipboard
or
Link copied to clipboard
common
fun <T : Any> or(vararg other: BooleanExpression<T>): BooleanExpression<T>
Content copied to clipboard
fun <T : Any> BooleanExpression<T>.or(vararg other: BooleanExpression<T>): BooleanExpression<T>
Content copied to clipboard
parseJsonData
Link copied to clipboard
common
fun <D : Operation.Data> Operation<D>.parseJsonData(string: String): D
Content copied to clipboard
see parseJsonData
fun <D : Operation.Data> Operation<D>.parseJsonData(source: BufferedSource): D
Content copied to clipboard
See parseJsonData
fun <D : Operation.Data> Operation<D>.parseJsonData(byteString: ByteString): D
Content copied to clipboard
see parseJsonData
fun <D : Operation.Data> Operation<D>.parseJsonData(string: String, customScalarAdapters: CustomScalarAdapters): D
Content copied to clipboard
see parseJsonData
fun <D : Operation.Data> Operation<D>.parseJsonData(source: BufferedSource, customScalarAdapters: CustomScalarAdapters): D
Content copied to clipboard
Reads only the "data" part of a GraphQL Json response
fun <D : Operation.Data> Operation<D>.parseJsonData(byteString: ByteString, customScalarAdapters: CustomScalarAdapters): D
Content copied to clipboard
see parseJsonData
parseJsonResponse
Link copied to clipboard
common
fun <D : Operation.Data> Operation<D>.parseJsonResponse(string: String): ApolloResponse<D>
Content copied to clipboard
See parseJsonResponse
fun <D : Operation.Data> Operation<D>.parseJsonResponse(map: Map<String, Any?>): ApolloResponse<D>
Content copied to clipboard
See parseJsonResponse
fun <D : Operation.Data> Operation<D>.parseJsonResponse(source: BufferedSource): ApolloResponse<D>
Content copied to clipboard
See parseJsonResponse
fun <D : Operation.Data> Operation<D>.parseJsonResponse(byteString: ByteString): ApolloResponse<D>
Content copied to clipboard
See parseJsonResponse
fun <D : Operation.Data> Operation<D>.parseJsonResponse(string: String, customScalarAdapters: CustomScalarAdapters): ApolloResponse<D>
Content copied to clipboard
See parseJsonResponse
fun <D : Operation.Data> Operation<D>.parseJsonResponse(map: Map<String, Any?>, customScalarAdapters: CustomScalarAdapters): ApolloResponse<D>
Content copied to clipboard
See parseJsonResponse
fun <D : Operation.Data> Operation<D>.parseJsonResponse(source: BufferedSource, customScalarAdapters: CustomScalarAdapters): ApolloResponse<D>
Content copied to clipboard
Reads a GraphQL Json response like below to a ApolloResponse
{
 "data": ...
 "errors": ...
 "extensions": ...
}
fun <D : Operation.Data> Operation<D>.parseJsonResponse(byteString: ByteString, customScalarAdapters: CustomScalarAdapters): ApolloResponse<D>
Content copied to clipboard
See parseJsonResponse
possibleTypes
Link copied to clipboard
common
fun possibleTypes(vararg typenames: String): BooleanExpression<BPossibleTypes>
Content copied to clipboard
fun possibleTypes(allTypes: List<CompiledType>, type: CompiledNamedType): List<ObjectType>
Content copied to clipboard
toInput
Link copied to clipboard
common
@JvmName(name = toInputOrAbsent)
fun <T> T.toInput(): Optional<T>
Content copied to clipboard
@JvmName(name = toInput)
fun <T : Any> T.toInput(): Optional<T>
Content copied to clipboard
toJson
Link copied to clipboard
common
fun <T> Adapter<T>.toJson(value: T): String
Content copied to clipboard
See toJson
fun <T> Adapter<T>.toJson(sink: BufferedSink, value: T)
Content copied to clipboard
See toJson
fun <T> Adapter<T>.toJson(value: T, customScalarAdapters: CustomScalarAdapters, indent: String): String
Content copied to clipboard
Converts the given value to a Json String
fun <T> Adapter<T>.toJson(sink: BufferedSink, value: T, customScalarAdapters: CustomScalarAdapters, indent: String)
Content copied to clipboard
See toJson
variable
Link copied to clipboard
common
fun variable(name: String): BooleanExpression<BVariable>
Content copied to clipboard
variables
Link copied to clipboard
common
fun <D : Executable.Data> Executable<D>.variables(customScalarAdapters: CustomScalarAdapters): Executable.Variables
Content copied to clipboard
variablesJson
Link copied to clipboard
common
fun <D : Executable.Data> Executable<D>.variablesJson(customScalarAdapters: CustomScalarAdapters): String
Content copied to clipboard
withHttpHeader
Link copied to clipboard
common
fun <D : Operation.Data> ApolloRequest<D>.withHttpHeader(httpHeader: HttpHeader): ApolloRequest<D>
Content copied to clipboard
fun <D : Operation.Data> ApolloRequest<D>.withHttpHeader(name: String, value: String): ApolloRequest<D>
Content copied to clipboard
withHttpHeaders
Link copied to clipboard
common
fun <D : Operation.Data> ApolloRequest<D>.withHttpHeaders(httpHeaders: List<HttpHeader>): ApolloRequest<D>
Content copied to clipboard
withHttpMethod
Link copied to clipboard
common
fun <D : Operation.Data> ApolloRequest<D>.withHttpMethod(httpMethod: HttpMethod): ApolloRequest<D>
Content copied to clipboard
withSendApqExtensions
Link copied to clipboard
common
fun <D : Operation.Data> ApolloRequest<D>.withSendApqExtensions(sendApqExtensions: Boolean): ApolloRequest<D>
Content copied to clipboard
withSendDocument
Link copied to clipboard
common
fun <D : Operation.Data> ApolloRequest<D>.withSendDocument(sendDocument: Boolean): ApolloRequest<D>
Content copied to clipboard

Properties

CompiledBooleanType
Link copied to clipboard
common
@JvmField()
val CompiledBooleanType: ScalarType
Content copied to clipboard
CompiledDirectiveType
Link copied to clipboard
common
@JvmField()
val CompiledDirectiveType: ObjectType
Content copied to clipboard
CompiledEnumValueType
Link copied to clipboard
common
@JvmField()
val CompiledEnumValueType: ObjectType
Content copied to clipboard
CompiledFieldType
Link copied to clipboard
common
@JvmField()
val CompiledFieldType: ObjectType
Content copied to clipboard
CompiledFloatType
Link copied to clipboard
common
@JvmField()
val CompiledFloatType: ScalarType
Content copied to clipboard
CompiledIDType
Link copied to clipboard
common
@JvmField()
val CompiledIDType: ScalarType
Content copied to clipboard
CompiledInputValueType
Link copied to clipboard
common
@JvmField()
val CompiledInputValueType: ObjectType
Content copied to clipboard
CompiledIntType
Link copied to clipboard
common
@JvmField()
val CompiledIntType: ScalarType
Content copied to clipboard
CompiledSchemaType
Link copied to clipboard
common
@JvmField()
val CompiledSchemaType: ObjectType
Content copied to clipboard
CompiledStringType
Link copied to clipboard
common
@JvmField()
val CompiledStringType: ScalarType
Content copied to clipboard
CompiledTypeType
Link copied to clipboard
common
@JvmField()
val CompiledTypeType: ObjectType
Content copied to clipboard
NullableAnyAdapter
Link copied to clipboard
common
@JvmField()
val NullableAnyAdapter: NullableAdapter<Any>
Content copied to clipboard
NullableBooleanAdapter
Link copied to clipboard
common
@JvmField()
val NullableBooleanAdapter: NullableAdapter<Boolean>
Content copied to clipboard
NullableDoubleAdapter
Link copied to clipboard
common
@JvmField()
val NullableDoubleAdapter: NullableAdapter<Double>
Content copied to clipboard
NullableIntAdapter
Link copied to clipboard
common
@JvmField()
val NullableIntAdapter: NullableAdapter<Int>
Content copied to clipboard
NullableStringAdapter
Link copied to clipboard
common
@JvmField()
val NullableStringAdapter: NullableAdapter<String>
Content copied to clipboard
Global instances of nullable adapters for built-in scalar types