kotlin-components-docs

mozilla.appservices.logins

LoginsApiException

kotlin-components-docs/mozilla.appservices.logins/LoginsApiException

LoginsApiException

sealed class LoginsApiException : Exception

These are the errors returned by our public API.

Inheritors

NssUninitialized

NssAuthenticationException

AuthenticationException

AuthenticationCanceled

EncryptionFailed

DecryptionFailed

SyncAuthInvalid

UnexpectedLoginsApiException

Types

AuthenticationCanceled

class AuthenticationCanceled : LoginsApiException

authentication has been cancelled.

AuthenticationException

class AuthenticationException(val reason: String) : LoginsApiException

error during authentication (in PrimaryPasswordAuthenticator)

DecryptionFailed

class DecryptionFailed(val reason: String) : LoginsApiException

decryption failed

EncryptionFailed

class EncryptionFailed(val reason: String) : LoginsApiException

encryption failed

object ErrorHandler : UniffiRustCallStatusErrorHandler<LoginsApiException>

class Interrupted(val reason: String) : LoginsApiException

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

class InvalidKey : LoginsApiException

Encryption key is not valid.

class InvalidRecord(val reason: String) : LoginsApiException

The login data supplied is invalid. The reason will indicate what's wrong with it.

class MissingKey : LoginsApiException

Encryption key is missing.

class NoSuchRecord(val reason: String) : LoginsApiException

Asking to do something with a guid which doesn't exist.

NssAuthenticationException

class NssAuthenticationException(val reason: String) : LoginsApiException

NSS error during authentication

NssUninitialized

class NssUninitialized : LoginsApiException

NSS not initialized.

SyncAuthInvalid

class SyncAuthInvalid(val reason: String) : LoginsApiException

Sync reported that authentication failed and the user should re-enter their FxA password.

UnexpectedLoginsApiException

class UnexpectedLoginsApiException(val reason: String) : LoginsApiException

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?