DoorLockTrait.CredentialStruct
class DoorLockTrait.CredentialStruct : ClusterStruct
A set of credentials used when operating the door lock.
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
CredentialStruct(Creates the CredentialStruct class. |
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 |
|
|---|---|
UShort |
The unique identifier for the credentials. |
DoorLockTrait.CredentialTypeEnum |
The type of credentials, as enumerated by |
Public constructors
CredentialStruct
CredentialStruct(
credentialType: DoorLockTrait.CredentialTypeEnum = CredentialTypeEnum.ProgrammingPin,
credentialIndex: UShort
)
Creates the CredentialStruct class.
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
credentialType
val credentialType: DoorLockTrait.CredentialTypeEnum
The type of credentials, as enumerated by CredentialTypeEnum.