nutrient/com.pspdfkit.instant.exceptions/InstantException

InstantException

open class InstantException : RuntimeException

Thrown when there's an error while communicating with Instant Server (Nutrient Document Engine). Suppressing OverrideThrowableToString as we're fine with just using toString here.

Inheritors

InstantSyncException

InstantDownloadException

Constructors

InstantException

constructor(@Nullable message: String, @Nullable cause: Throwable)

Constructs a new instant exception with the specified detail message and cause.

constructor(@NonNull errorCode: InstantErrorCode, @Nullable cause: Throwable, @Nullable message: String, @NonNull args: Array<Any>)

Constructs a new instant exception with the specified detail message and cause.

constructor(@NonNull errorCode: InstantErrorCode, @Nullable message: String, @NonNull args: Array<Any>)

Constructs a new instant exception with the specified detail message and cause.

constructor(@NonNull errorCode: InstantErrorCode, @Nullable message: String, @Nullable underlyingError: Integer)

Constructs a new instant exception with the specified detail message and cause.

Properties

errorCode

@NonNull

@get:NonNull

val errorCode: InstantErrorCode

The error code indicating the category of this Instant exception.

underlyingError

@Nullable

val underlyingError: Integer

The original error code from the underlying subsystem (e.g., HTTP status code or SQL error code), if available.

Functions

toString

@NonNull

open fun toString(): String

Returns a string representation of this exception including the class name, error code, and message.