DoorLockTrait.SetUserCommand.Request
class DoorLockTrait.SetUserCommand.Request : ClusterStruct
The request payload for the SetUser command.
Summary
Nested types |
|---|
|
Descriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the SetUser command. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
Returns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
DoorLockTrait.CredentialRuleEnum? |
The credential rule. |
DoorLockTrait.DataOperationTypeEnum |
The operation to perform. |
UShort |
The unique identifier for the user to set on the lock. |
String? |
The user name of the user to set on the lock. |
DoorLockTrait.UserStatusEnum? |
The status of the user to set on the lock. |
DoorLockTrait.UserTypeEnum? |
The type of the user. |
UInt? |
The unique user id of the user to set on the lock. |
Public constructors
Request
Request(
operationType: DoorLockTrait.DataOperationTypeEnum = DataOperationTypeEnum.Add,
userIndex: UShort,
userName: String? = null,
userUniqueId: UInt? = null,
userStatus: DoorLockTrait.UserStatusEnum? = null,
userType: DoorLockTrait.UserTypeEnum? = null,
credentialRule: DoorLockTrait.CredentialRuleEnum? = null
)
Creates a request payload for the SetUser command.
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
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. Valid values are defined by CredentialRuleEnum.
operationType
val operationType: DoorLockTrait.DataOperationTypeEnum
The operation to perform. Valid values are defined by DataOperationTypeEnum.
userStatus
val userStatus: DoorLockTrait.UserStatusEnum?
The status of the user to set on the lock. Valid values are defined by UserStatusEnum.
userType
val userType: DoorLockTrait.UserTypeEnum?
The type of the user. Valid values are defined by UserTypeEnum.