Package com.orange.webcom.sdk.authentication

Exposes the API of the Webcom Authentication service.

Types

Link copied to clipboard
interface AccountDetails

Provides properties related to the account of an authenticated user.

Link copied to clipboard
typealias AuthenticationCallback = (AuthenticationEvent) -> Unit

Function called with the result of an authentication operation.

Link copied to clipboard
data class AuthenticationDetails : AccountDetails, IdentityDetails

Provides properties related to the authentication of a user.

Link copied to clipboard
sealed class AuthenticationEvent : Notifiable

Represents an authentication event as expected by the callback functions passed to the AuthenticationService.subscribe method.

Link copied to clipboard
interface AuthenticationFactor

Provides properties related to an authentication factor of an authenticated user.

Link copied to clipboard
abstract class AuthenticationMethod

Base class for all authentication methods provided within the com.orange.webcom.sdk.authentication.methods package.

Link copied to clipboard
class AuthenticationService : WebcomAbstractService, Closeable

The Webcom service that makes it possible to authenticate users and manage identities (or authentication means) of users on a Webcom application.

Link copied to clipboard
sealed class AuthenticationState : AuthenticationEvent

Represents the transition to an authentication state.

Link copied to clipboard
interface ExtraIdentityDetails

Provides some optional extra properties related to the identity of an authenticated user, in case of an authentication based on the OAuth2Method.

Link copied to clipboard
interface IdentityDetails : AuthenticationFactor

Provides properties related to the identity of an authenticated user, in addition to the AuthenticationFactor properties.

Properties

Link copied to clipboard

Convenient shortcut to service(AuthenticationService::class to retrieve the unique instance of AuthenticationService associated with this WebcomApplication.