Webcom Android API/com.orange.webcom.sdk.authentication/AuthenticationState

AuthenticationState

sealed class AuthenticationState : AuthenticationEvent

Represents the transition to an authentication state.

Inheritors

Unauthenticated

Authenticated

Invalid

Types

Authenticated

data class Authenticated : AuthenticationState, Notification.DataNotification<AuthenticationState.Authenticated>

A user is currently authenticated with given details.

Invalid

data class Invalid : AuthenticationState, Notification.DataNotification<AuthenticationState.Invalid>

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

data class Unauthenticated : AuthenticationState, Notification.DataNotification<AuthenticationState.Unauthenticated>

No user is currently authenticated or expected to authenticate.

Properties

appId

val appId: String

Identifier of the WebcomApplication this AuthenticationEvent relates to.

application

abstract val application: WebcomApplication

The WebcomApplication instance this AuthenticationEvent relates to.

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).

path

val path: String

Meaningless property (always equals the empty string) because AuthenticationEvents don't relate to any data node.

Functions

isAuthenticated

open fun isAuthenticated(): Boolean

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

isUnauthenticated

open fun isUnauthenticated(): Boolean

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