DoorLockTrait.CredentialRuleEnum
enum DoorLockTrait.CredentialRuleEnum : Enum, ClusterEnum
Indicates the credential rule that can be applied to a particular user.
Summary
Enum Values |
|
|---|---|
Dual |
Two credentials are required to operate the lock. |
Single |
Only one credential is required to operate the lock. |
Tri |
Three credentials are required to operate the lock. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
DoorLockTrait.CredentialRuleEnum |
Returns the enum constant of this type with the specified name. |
Array<DoorLockTrait.CredentialRuleEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
open String |
Trait identifier of the Matter Cluster that defines the enum Data Type. |
open String |
Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster. |
open ULong |
Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset. |
Enum Values
Dual
val DoorLockTrait.CredentialRuleEnum.Dual: DoorLockTrait.CredentialRuleEnum
Two credentials are required to operate the lock.
Single
val DoorLockTrait.CredentialRuleEnum.Single: DoorLockTrait.CredentialRuleEnum
Only one credential is required to operate the lock.
Tri
val DoorLockTrait.CredentialRuleEnum.Tri: DoorLockTrait.CredentialRuleEnum
Three credentials are required to operate the lock.
UnknownValue
val DoorLockTrait.CredentialRuleEnum.UnknownValue: DoorLockTrait.CredentialRuleEnum
The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.
Public functions
valueOf
fun valueOf(value: String): DoorLockTrait.CredentialRuleEnum
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |
values
fun values(): Array<DoorLockTrait.CredentialRuleEnum>
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Public properties
traitId
open val traitId: String
Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.