apollo-api/com.apollographql.apollo3.exception

Package-level declarations

Types

ApolloCompositeException

class ~~ApolloCompositeException~~ : ApolloException

ApolloException

sealed class ApolloException : RuntimeException

The base class for all exceptions

ApolloGraphQLException

class ApolloGraphQLException(val error: Error) : ApolloException

ApolloHttpException

class ApolloHttpException(val statusCode: Int, val headers: List<HttpHeader>, val body: BufferedSource?, message: String, cause: Throwable? = null) : ApolloException

The response was received but the response code was not 200

ApolloNetworkException

class ApolloNetworkException(message: String? = null, val platformCause: Any? = null) : ApolloException

An I/O error happened: socket closed, DNS issue, TLS problem, file not found, etc...

ApolloParseException

class ~~ApolloParseException~~(message: String? = null, cause: Throwable? = null) : ApolloException

The response could not be parsed because of an I/O exception.

ApolloWebSocketClosedException

class ApolloWebSocketClosedException(val code: Int, val reason: String? = null, cause: Throwable? = null) : ApolloException

A WebSocket connection could not be established: e.g., expired token

AutoPersistedQueriesNotSupported

class AutoPersistedQueriesNotSupported : ApolloException

CacheMissException

class CacheMissException constructor(val key: String, val fieldName: String? = null, stale: Boolean = false) : ApolloException

An object/field was missing in the cache If fieldName is null, it means a reference to an object could not be resolved

DefaultApolloException

class DefaultApolloException(message: String? = null, cause: Throwable? = null) : ApolloException

A generic exception used when there is no additional context besides the message.

HttpCacheMissException

class HttpCacheMissException(message: String, cause: Exception? = null) : ApolloException

An HTTP cache miss happened

JsonDataException

class JsonDataException(message: String) : ApolloException

Thrown when the data in a JSON document doesn't match the data expected by the caller.

JsonEncodingException

class JsonEncodingException(message: String) : ApolloException

Thrown when the data being parsed is not encoded as valid JSON.

MissingValueException

class MissingValueException : ApolloException

NoDataException

class NoDataException(cause: Throwable?) : ApolloException

No data was found

NullOrMissingField

class NullOrMissingField(message: String) : ApolloException

A field was missing or null in the JSON response.

RouterError

class RouterError(val errors: List<Error>) : ApolloException

The router sent one or several errors.

SubscriptionConnectionException

class SubscriptionConnectionException(val payload: Any?) : ApolloException

The server responded with an error to the 'connection_init' message.

SubscriptionOperationException

class SubscriptionOperationException(operationName: String, val payload: Any?) : ApolloException

The server could not process a subscription and sent an error.

Properties

apolloExceptionHandler

@ApolloExperimental

var apolloExceptionHandler: (Throwable) -> Unit

A handler that can be set to intercept certain exceptions occurring in the library that are not normally surfaced. This can be used to investigate issues. The default is to log the exception.

nsError

val <Error class: unknown class>.nsError: <Error class: unknown class>?