DoorLockTrait.GetUserCommand.Response
class DoorLockTrait.GetUserCommand.Response : ClusterStruct
Returns the user for the specified userIndex.
Summary
Nested types |
|---|
|
Descriptor enum for this command's request fields. |
Public constructors |
|---|
Response(Creates a response payload from the GetUser command. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
@HomeExperimentalApiReturns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
UByte? |
The user's creator fabric index. |
DoorLockTrait.CredentialRuleEnum? |
The credential rule that can be applied to the user. |
List<DoorLockTrait.CredentialStruct>? |
The user's credentials. |
UByte? |
The user's last modifier fabric index. |
UShort? |
The next occupied user index in the database, which is useful for quickly identifying occupied user slots in the database. |
UShort |
The unique identifier for the user. |
String? |
The user's name. |
DoorLockTrait.UserStatusEnum? |
The status of the user. |
DoorLockTrait.UserTypeEnum? |
The type of the user. |
UInt? |
The unique user id of the user. |
Public constructors
Response
Response(
userIndex: UShort,
userName: String? = null,
userUniqueId: UInt? = null,
userStatus: DoorLockTrait.UserStatusEnum? = null,
userType: DoorLockTrait.UserTypeEnum? = null,
credentialRule: DoorLockTrait.CredentialRuleEnum? = null,
credentials: List<DoorLockTrait.CredentialStruct>? = null,
creatorFabricIndex: UByte? = null,
lastModifiedFabricIndex: UByte? = null,
nextUserIndex: UShort? = null
)
Creates a response payload from the GetUser command.
Public functions
getDescriptor
@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
credentialRule
val credentialRule: DoorLockTrait.CredentialRuleEnum?
The credential rule that can be applied to the user.
nextUserIndex
val nextUserIndex: UShort?
The next occupied user index in the database, which is useful for quickly identifying occupied user slots in the database.