apollo-api/com.apollographql.apollo3.exception

Package com.apollographql.apollo3.exception

Types

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_0_0)

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

class ApolloCompositeException(first: Throwable?, second: Throwable?) : ApolloException

Multiple exceptions happened. This happens typically when a CacheFirst request fails to fetch both the cache and the network. In that case, ApolloCompositeException is thrown, and you can access the underlying cache and network exceptions in suppressedExceptions.

ApolloException

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

The base class for all exceptions

ApolloGenericException

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_0_0)

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

Something went wrong but it's not sure exactly what

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

A network error happened: socket closed, DNS issue, TLS problem, etc...

ApolloParseException

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

The response could not be parsed either because of another issue than JsonDataException or JsonEncodingException

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

HttpCacheMissException

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

A 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

SubscriptionOperationException

class SubscriptionOperationException(operationName: String, val payload: Any? = null) : 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 ApolloNetworkException.nsError: NSError?