DittoError

sealed class DittoError : Throwable

All errors that are thrown by the Ditto SDK are wrapped as a DittoError. This type wraps multiple different types of error that each have an associated reason.

You can access more specific information about an error by switching over the error's reason value. A human-readable version of the error is available via the localizedMessage property of the error's reason.

Types

Link copied to clipboard
data class ActivationError(val reason: DittoError.ActivationErrorReason) : DittoError
Link copied to clipboard
sealed class ActivationErrorReason

The possible underlying reasons an ActivationError occurs.

Link copied to clipboard
data class AuthenticationError(val reason: DittoError.AuthenticationErrorReason) : DittoError
Link copied to clipboard
sealed class AuthenticationErrorReason

The possible underlying reasons an AuthenticationError error occurs.

Link copied to clipboard
data class BusError(val reason: DittoError.BusErrorReason) : DittoError
Link copied to clipboard
sealed class BusErrorReason

The possible underlying reasons a BusError error occurs.

Link copied to clipboard
object Companion
Link copied to clipboard
data class FatalError(val message: String) : DittoError

Represents a fatal error that the Ditto instance cannot recover from. Should your app encounter one, the instance should be closed and a new instance created.

Link copied to clipboard
data class FilesystemError(val message: String) : DittoError

An error occurred accessing the filesystem.

Link copied to clipboard
data class InternalError(val reason: DittoError.InternalErrorReason) : DittoError

Errors related to internal ditto core native communication.

Link copied to clipboard
sealed class InternalErrorReason

The possible underlying reasons an InternalError occurs.

Link copied to clipboard
data class IoError(val reason: DittoError.IoErrorReason) : DittoError

Errors related to IO devices.

Link copied to clipboard
sealed class IoErrorReason

The possible underlying reasons an IoError occurs.

Link copied to clipboard
data class LockedWorkingDirectoryError(val message: String) : DittoError

Outstanding usage of ditto's working directory detected when trying to instantiate a new Ditto, which would have led to concurrent usage of the backing database files.

Link copied to clipboard
data class PresenceError(val reason: DittoError.PresenceErrorReason) : DittoError

Errors transforming Ditto mesh presence data to or from JSON encoding.

Link copied to clipboard
sealed class PresenceErrorReason

The possible underlying reasons a PresenceError occurs.

Link copied to clipboard
data class StoreError(val reason: DittoError.StoreErrorReason) : DittoError
Link copied to clipboard
sealed class StoreErrorReason

The possible underlying reasons a StoreError occurs.

Link copied to clipboard
data class TransportError(val reason: DittoError.TransportErrorReason) : DittoError
Link copied to clipboard
sealed class TransportErrorReason

The possible underlying reasons a TransportError error occurs.

Link copied to clipboard
data class UnknownError(val message: String) : DittoError

Some not-yet-categorized error occurred.

Link copied to clipboard
data class UnsupportedError(val message: String) : DittoError

Operation is not supported.

Link copied to clipboard
data class ValidationError(val reason: DittoError.ValidationErrorReason) : DittoError
Link copied to clipboard
sealed class ValidationErrorReason

Errors interacting with DittoSmallPeerInfo.

Functions

Link copied to clipboard
fun addSuppressed(p0: Throwable)
Link copied to clipboard
open fun fillInStackTrace(): Throwable
Link copied to clipboard
open override fun getLocalizedMessage(): String

A String representation of the error suitable for display.

Link copied to clipboard
open fun getStackTrace(): Array<StackTraceElement>
Link copied to clipboard
fun getSuppressed(): Array<Throwable>
Link copied to clipboard
open fun initCause(p0: Throwable): Throwable
Link copied to clipboard
open fun printStackTrace()
open fun printStackTrace(p0: PrintStream)
open fun printStackTrace(p0: PrintWriter)
Link copied to clipboard
open fun setStackTrace(p0: Array<StackTraceElement>)

Properties

Link copied to clipboard
open val cause: Throwable?
Link copied to clipboard
open override val message: String?

A formatted description of the error. Not all errors have a message. Use the null-safe getLocalizedMessage if you don't want to have to handle null values.

Inheritors

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard