AccountLoginCommands

interface AccountLoginCommands

Known direct subclasses
AccountLogin

API for the AccountLogin trait.

Summary

Public functions
suspend AccountLoginTrait.GetSetupPinCommand.Response
getSetupPin(tempAccountIdentifier: String)

Determine if the active user account of the given content app matches the active user account of the given commissionee, and if it does, return a setup PIN which can be used to establish a password-authenticated session with the commissionee.
suspend Unit
login(
    tempAccountIdentifier: String,
    setupPin: String,
    optionalArgs: AccountLoginTrait.LoginCommand.OptionalArgs.() -> Unit
)

Allow the content app to assume the user account of the given commissionee by leveraging the setup PIN input by the user during the commissioning process.
suspend Unit

Instruct the content app to clear the current user account and end the user session.

Public functions

getSetupPin

suspend fun getSetupPin(tempAccountIdentifier: String): AccountLoginTrait.GetSetupPinCommand.Response

Determine if the active user account of the given content app matches the active user account of the given commissionee, and if it does, return a setup PIN which can be used to establish a password-authenticated session with the commissionee.

Parameters
tempAccountIdentifier: String

The client's temporary account identifier.
Returns
AccountLoginTrait.GetSetupPinCommand.Response

Contains the setup PIN.

login

suspend fun login(
    tempAccountIdentifier: String,
    setupPin: String,
    optionalArgs: AccountLoginTrait.LoginCommand.OptionalArgs.() -> Unit = {}
): Unit

Allow the content app to assume the user account of the given commissionee by leveraging the setup PIN input by the user during the commissioning process.

Parameters
tempAccountIdentifier: String

The client's temporary account identifier.
setupPin: String

The setup PIN.
optionalArgs: AccountLoginTrait.LoginCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

logout

suspend fun logout(optionalArgs: AccountLoginTrait.LogoutCommand.OptionalArgs.() -> Unit = {}): Unit

Instruct the content app to clear the current user account and end the user session.

Parameters
optionalArgs: AccountLoginTrait.LogoutCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command