AuthenticationResult


sealed interface AuthenticationResult

Known direct subclasses
AuthenticationResult.Error

A result when an error has been encountered and authentication has stopped.

AuthenticationResult.Success

A result when the user has successfully authenticated.


Types of the terminal result of the authentication.

Summary

Nested types

A result when an error has been encountered and authentication has stopped.

A result when the user has successfully authenticated.

Public functions

open AuthenticationResult.Error?

Returns a Error only if it's a Error, throws otherwise.

open Boolean

Whether this AuthenticationResult is an Error.

open Boolean

Whether this AuthenticationResult is a Success.

open AuthenticationResult.Success?

Returns a Success only if it's a Success, throws otherwise.

Public functions

error

Added in 1.4.0-alpha03
open fun error(): AuthenticationResult.Error?

Returns a Error only if it's a Error, throws otherwise.

isError

Added in 1.4.0-alpha03
open fun isError(): Boolean

Whether this AuthenticationResult is an Error.

isSuccess

Added in 1.4.0-alpha03
open fun isSuccess(): Boolean

Whether this AuthenticationResult is a Success.

success

Added in 1.4.0-alpha03
open fun success(): AuthenticationResult.Success?

Returns a Success only if it's a Success, throws otherwise.