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

ApolloResponse

class ApolloResponse<D : Operation.Data>

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

Valid states are:

data != null && exception == null: complete data with no error
data == null && exception != null: no data, a network error or operation error happened
data != null && exception != null: partial data with field errors

Types

class Builder<D : Operation.Data>

Properties

val data: D?

Parsed response of GraphQL operation execution. data is non-null if some data is received from the server. data might contain partial data in case of field errors

dataAssertNoErrors

@get:JvmName(name = "dataAssertNoErrors")

val dataAssertNoErrors: D

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

val errors: List<Error>?

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

val exception: ApolloException?

An ApolloException if a GraphQL response wasn't received.

executionContext

val executionContext: ExecutionContext

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

val extensions: Map<String, Any?>

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

val isLast: Boolean

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

val operation: Operation<D>

The GraphQL operation this response represents

val requestUuid: Uuid

Functions

fun dataOrThrow(): D

Return data if not null or throws NoDataException else

fun hasErrors(): Boolean

fun newBuilder(): ApolloResponse.Builder<D>