AccountLoginTrait.LoginCommand

object AccountLoginTrait.LoginCommand : CommandDescriptor

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.

See also
login

Use this command from the trait(AccountLogin) method.

Summary

Nested types

Optional arguments for the command LoginCommand Request

The request payload for the Login command.

Descriptor enum for this command's request fields.

Public functions
open Field?
open Field?

Public properties
open String

Unique id corresponding to the command.

Public functions

getCommandRequestFieldById

@HomeExperimentalApi
open fun getCommandRequestFieldById(tagId: UInt): Field?

getCommandRequestFieldByName

@HomeExperimentalApi
open fun getCommandRequestFieldByName(name: String): Field?

Public properties

commandId

open val commandId: String

Unique id corresponding to the command.