Webcom Android API/com.orange.webcom.sdk.authentication/AuthenticationMethod/Internal

Internal

abstract class Internal : AuthenticationMethod

Base class for authentication methods that manage users of a Webcom internal identity provider.

Webcom internal identity providers authenticate users based on a unique identifier (email or MSISDN) and a password, which may be:

either a personal password, in this case use PersonalPasswordMethod,
or a generated one-time password sent to the user, in this case use OneTimePasswordMethod.

This class provides with common operations to manage user profile data.

Types

MessageDetails

open class MessageDetails @JvmOverloads constructor(val template: String? = null, val locale: Locale? = null)

Represents messages sent to the user such as a one-time password or a code to reset her·his personal password.

Provider

enum Provider : Enum<AuthenticationMethod.Internal.Provider>

List of all available Webcom internal identity providers.

Functions

clearProfile

@JvmOverloads

fun clearProfile(callback: WebcomDoneCallback? = null)

Clears the profile data of the currently authenticated user stored by the Webcom authentication service. This operation is asynchronous and calls the given callback once performed.

setProfile

@JvmOverloads

fun setProfile(value: Any?, callback: WebcomDoneCallback? = null)

Sets the value of the profile data of the currently authenticated user stored by the Webcom authentication service. This operation is asynchronous and calls the given callback once performed.

updateProfile

@JvmOverloads

fun updateProfile( path: String, value: Any?, callback: WebcomDoneCallback? = null)

Updates the value of the profile data of the currently authenticated user stored by the Webcom authentication service at a given path. This operation is asynchronous and calls the given callback once performed.

Inheritors

OneTimePasswordMethod

PersonalPasswordMethod