onyxsdk-ktx/com.onyx.android.sdk.ktx.model/OnyxFailure

OnyxFailure

sealed class OnyxFailure : RuntimeException(source)

Typed failure returned through Kotlin's Result.

Inheritors

UnsupportedCapability

NativeRendererFailure

Types

EventOverflow

class EventOverflow(operation: String, diagnosticId: Long?, message: String) : OnyxFailure

A lossless event stream could not accept another event.

FirmwareRejected

class FirmwareRejected(operation: String, diagnosticId: Long?, message: String, cause: Throwable? = null) : OnyxFailure

Firmware rejected the operation or returned an error.

HiddenApiDenied

class HiddenApiDenied(operation: String, diagnosticId: Long?, message: String, cause: Throwable? = null) : OnyxFailure

Access to a required hidden Android API was denied.

InvalidArgument

class InvalidArgument(operation: String, message: String) : OnyxFailure

A caller supplied an invalid argument.

InvalidState

class InvalidState(operation: String, diagnosticId: Long?, message: String) : OnyxFailure

The operation is invalid for the current object or firmware state.

LeaseUnavailable

class LeaseUnavailable(operation: String, diagnosticId: Long?, message: String) : OnyxFailure

Another owner holds a required process-wide firmware lease.

NativeRendererFailure

class NativeRendererFailure(operation: String, diagnosticId: Long?, message: String, cause: Throwable? = null) : OnyxFailure

The native ink renderer failed to create, process, or release a stroke.

SurfaceChanged

class SurfaceChanged(operation: String, diagnosticId: Long?, message: String) : OnyxFailure

The rendering surface generation changed during an operation.

SurfaceUnavailable

class SurfaceUnavailable(operation: String, diagnosticId: Long?, message: String) : OnyxFailure

A usable rendering surface was not available.

TimedOut

class TimedOut(operation: String, diagnosticId: Long?, message: String, cause: Throwable? = null) : OnyxFailure

The operation did not reach its completion boundary before its deadline.

UnsupportedCapability

class UnsupportedCapability(operation: String, diagnosticId: Long?, message: String) : OnyxFailure

A required capability is unsupported by the current device or firmware.

WrongThread

class WrongThread(operation: String, diagnosticId: Long?, message: String) : OnyxFailure

The operation was invoked from an unsupported thread.

Properties

cause

open val cause: Throwable?

diagnosticId

val diagnosticId: Long?

Identifier in com.onyx.android.sdk.ktx.diagnostics.OnyxDiagnostics, or null when no diagnostic was recorded.

message

open val message: String?

operation

val operation: String

Stable name of the operation that failed.