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

ApolloResponse

class ApolloResponse<D : Operation.Data>

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

Types

Builder

class Builder<D : Operation.Data>( operation: Operation<D>, requestUuid: Uuid, data: D?)

Functions

hasErrors

fun hasErrors(): Boolean

newBuilder

fun newBuilder(): ApolloResponse.Builder<D>

Properties

data

@JvmField

val data: D?

Parsed response of GraphQL operation execution. Can be null in case if operation execution failed.

dataAssertNoErrors

@get:JvmName(name = "dataAssertNoErrors")

val dataAssertNoErrors: D

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

errors

@JvmField

val errors: List<Error>?

GraphQL operation execution errors returned by the server to let client know that something has gone wrong. This can either be null or empty depending on what your server sends back

executionContext

@JvmField

val executionContext: ExecutionContext

The context of GraphQL operation execution. This can contain additional data contributed by interceptors.

extensions

@JvmField

val extensions: Map<String, Any?>

Extensions of GraphQL protocol, arbitrary map of key String / value Any sent by server along with the response.

isLast

@JvmField

val isLast: Boolean

Indicates that this ApolloResponse is the last ApolloResponse in a given Flow and that no other items are expected.

operation

@JvmField

val operation: Operation<D>

The GraphQL operation this response represents

requestUuid

@JvmField

val requestUuid: Uuid