AccountLoginTrait.GetSetupPinCommand

object AccountLoginTrait.GetSetupPinCommand : CommandDescriptor

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.

See also
getSetupPin

Use this command from the trait(AccountLogin) method.

Summary

Nested types

The request payload for the GetSetupPin command.

Descriptor enum for this command's request fields.

Contains the setup PIN.

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.