AccountLogin

interface AccountLogin : AccountLoginTrait.Attributes, MatterTrait, AccountLoginCommands


API for the AccountLogin trait. This trait provides commands to facilitate user account login on a content app or a node.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions

Boolean
Boolean

Public properties

open TraitFactory<AccountLogin>

Inherited functions

From com.google.home.matter.standard.AccountLoginCommands
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.

From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties

From com.google.home.matter.standard.AccountLoginTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

UShort

The revision of the server cluster specification supported by the cluster instance.

UInt

Whether the server supports zero or more optional cluster features.

List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

From com.google.home.Trait

Public functions

supports

fun supports(attribute: AccountLogin.Attribute): Boolean

supports

fun supports(command: AccountLogin.Command): Boolean

Public properties

factory

open val factoryTraitFactory<AccountLogin>