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

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.

In this state, all operations on data that possibly require to be authenticated are paused pending a valid authentication state (Authenticated or Unauthenticated).

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.

Properties

abstract val appId: String

Identifier of the WebcomApplication this Notification relates to.

open override val application: WebcomApplication

The WebcomApplication instance this AuthenticationEvent relates to.

open override val data: AuthenticationState.Invalid

The event conveyed by this DataNotification.

open val details: AuthenticationDetails? = null

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

abstract val path: String

Path of the data this Notification relates to, or "" if it doesn't relate to any data node.