ApolloResponse

class ApolloResponse<out D : Operation.Data>(requestUuid: Uuid, operation: Operation<*>, data: D?, errors: List<Error>?, extensions: Map<String, Any?>, executionContext: ExecutionContext)

Represents a GraphQL response. GraphQL responses can be be partial responses so it is valid to have both data != null and errors

Constructors

ApolloResponse

common

fun <out D : Operation.Data> ApolloResponse(requestUuid: Uuid, operation: Operation<*>, data: D?, errors: List<Error>? = null, extensions: Map<String, Any?> = emptyMap(), executionContext: ExecutionContext = ExecutionContext.Empty)

Functions

copy

common

fun copy(requestUuid: Uuid = this.requestUuid, operation: Operation<*> = this.operation, data: Any? = this.data, errors: List<Error>? = this.errors, extensions: Map<String, Any?> = this.extensions, executionContext: ExecutionContext = this.executionContext): ApolloResponse<D>

hasErrors

common

fun hasErrors(): Boolean

withExecutionContext

common

fun withExecutionContext(executionContext: ExecutionContext): ApolloResponse<D>

Properties

data

common

@JvmField()

val data: D?

Parsed response of GraphQL operation execution.

dataAssertNoErrors

common

val dataAssertNoErrors: D

A shorthand property to get a non-nullable data if handling partial data is not importantNote: A future version could use Definitely non nullable types to implement something like ApolloResponse<D>.assertNoErrors(): ApolloResponse<D & Any>

dataOrThrow

common

val dataOrThrow: D

A shorthand property to get a non-nullable data if handling partial data is not important

errors

common

@JvmField()

val errors: List<Error>? = null

GraphQL operation execution errors returned by the server to let client know that something has gone wrong.

executionContext

common

@JvmField()