AuthenticationState

sealed class AuthenticationState : AuthenticationEvent

Represents the transition to an authentication state.

Types

Authenticated

data class Authenticated(details: AuthenticationDetails) : AuthenticationEvent.AuthenticationState

A user is currently authenticated with given details.

Invalid

object Invalid : AuthenticationEvent.AuthenticationState

The authentication token used so far has become invalid (e.g., it is expired) and the previously authenticated user (who is no longer authenticated) is expected to authenticate again.

Unauthenticated

object Unauthenticated : AuthenticationEvent.AuthenticationState

No user is currently neither authenticated nor expected to authenticate.

Functions

isAuthenticated

open fun isAuthenticated(): Boolean

true if an only if this AuthenticationEvent is AuthenticationState.Authenticated.

isUnauthenticated

open fun isUnauthenticated(): Boolean

true if an only if this AuthenticationEvent is AuthenticationState.Unauthenticated.

Properties

details

open val details: AuthenticationDetails? = null

All the properties that describe the authenticated user if isAuthenticated returns true or null otherwise (no user is authenticated).

Inheritors

AuthenticationEvent.AuthenticationState