kotlin-components-docs/mozilla.appservices.db_crypto/DbCryptoApiException

DbCryptoApiException

sealed class DbCryptoApiException : Exception

These are the errors returned by our public API.

Inheritors

NssUninitialized

NssAuthenticationException

AuthenticationException

AuthenticationCanceled

EncryptionFailed

DecryptionFailed

UnexpectedDbCryptoApiException

Types

AuthenticationCanceled

class AuthenticationCanceled : DbCryptoApiException

authentication has been cancelled.

AuthenticationException

class AuthenticationException(val reason: String) : DbCryptoApiException

error during authentication (in PrimaryPasswordAuthenticator)

DecryptionFailed

class DecryptionFailed(val reason: String) : DbCryptoApiException

decryption failed

EncryptionFailed

class EncryptionFailed(val reason: String) : DbCryptoApiException

encryption failed

object ErrorHandler : UniffiRustCallStatusErrorHandler<DbCryptoApiException>

class Interrupted(val reason: String) : DbCryptoApiException

An operation was interrupted at the request of the consuming app.

class InvalidKey : DbCryptoApiException

Encryption key is not valid.

class MissingKey : DbCryptoApiException

Encryption key is missing.

NssAuthenticationException

class NssAuthenticationException(val reason: String) : DbCryptoApiException

NSS error during authentication

NssUninitialized

class NssUninitialized : DbCryptoApiException

NSS not initialized.

UnexpectedDbCryptoApiException

class UnexpectedDbCryptoApiException(val reason: String) : DbCryptoApiException

something internal went wrong which doesn't have a public error value because the consuming app can not reasonably take any action to resolve it. The underlying error will have been logged and reported. (ideally would just be Unexpected, but that would be a breaking change)

Functions

fun addSuppressed(p0: Throwable)

fillInStackTrace

open fun fillInStackTrace(): Throwable

getLocalizedMessage

open fun getLocalizedMessage(): String

open fun getStackTrace(): Array<StackTraceElement>

fun getSuppressed(): Array<Throwable>

open fun initCause(p0: Throwable): Throwable

printStackTrace

open fun printStackTrace()

open fun printStackTrace(p0: PrintStream)

open fun printStackTrace(p0: PrintWriter)

open fun setStackTrace(p0: Array<StackTraceElement>)

Properties

open val cause: Throwable?

open val message: String?