AccountLoginCommands
@Generated(value = ["GoogleHomePlatformCodegen"])
interface AccountLoginCommands
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. |
BatchableCommand<AccountLoginTrait.GetSetupPinCommand.Response> |
getSetupPinBatchable(tempAccountIdentifier: String)The batchable version of |
suspend Unit |
login(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. |
BatchableCommand<Unit> |
loginBatchable(The batchable version of |
suspend Unit |
logout(optionalArgs: AccountLoginTrait.LogoutCommand.OptionalArgs.() -> Unit)Instruct the content app to clear the current user account and end the user session. |
BatchableCommand<Unit> |
logoutBatchable(optionalArgs: AccountLoginTrait.LogoutCommand.OptionalArgs.() -> Unit)The batchable version of |
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. |
getSetupPinBatchable
fun getSetupPinBatchable(tempAccountIdentifier: String): BatchableCommand<AccountLoginTrait.GetSetupPinCommand.Response>
The batchable version of getSetupPin command.
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 | |
|---|---|
BatchableCommand<AccountLoginTrait.GetSetupPinCommand.Response> |
BatchableCommand |
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 |
loginBatchable
fun loginBatchable(
tempAccountIdentifier: String,
setupPin: String,
optionalArgs: AccountLoginTrait.LoginCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<Unit>
The batchable version of login command.
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 |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |
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 |
logoutBatchable
fun logoutBatchable(optionalArgs: AccountLoginTrait.LogoutCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>
The batchable version of logout command.
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 |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |