DoorLockTrait.LockDataTypeEnum

enum DoorLockTrait.LockDataTypeEnum : Enum, ClusterEnum


Data types associated with door locks.

Summary

Enum Values

AliroCredentialIssuerKey
AliroEvictableEndpointKey
AliroNonEvictableEndpointKey
Face

Face.

FingerVein

Finger vein.

Fingerprint

Fingerprint.

HolidaySchedule

Holiday schedule.

Pin

PIN.

ProgrammingCode

Programming code.

Rfid

RFID.

UnknownValue

The enum value is out of range.

Unspecified

Unspecified or manufacturer-specific lock user data.

UserIndex

The unique identifier for the user.

WeekDaySchedule

Week day schedule.

YearDaySchedule

Year day schedule.

Public functions

DoorLockTrait.LockDataTypeEnum
valueOf(value: String)

Returns the enum constant of this type with the specified name.

Array<DoorLockTrait.LockDataTypeEnum>

Returns an array containing the constants of this enum type, in the order they're declared.

Public properties

open String
open String
open ULong

Enum Values

UnknownValue

val DoorLockTrait.LockDataTypeEnum.UnknownValueDoorLockTrait.LockDataTypeEnum

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.

Unspecified

val DoorLockTrait.LockDataTypeEnum.UnspecifiedDoorLockTrait.LockDataTypeEnum

Unspecified or manufacturer-specific lock user data.

UserIndex

val DoorLockTrait.LockDataTypeEnum.UserIndexDoorLockTrait.LockDataTypeEnum

The unique identifier for the user.

WeekDaySchedule

val DoorLockTrait.LockDataTypeEnum.WeekDayScheduleDoorLockTrait.LockDataTypeEnum

Week day schedule. Week day schedules are used to restrict access to a specified time window on certain days of the week. The schedule is repeated each week.

YearDaySchedule

val DoorLockTrait.LockDataTypeEnum.YearDayScheduleDoorLockTrait.LockDataTypeEnum

Year day schedule. Year day schedules are used to restrict access to a specified date and time window.

Public functions

valueOf

fun valueOf(value: String): DoorLockTrait.LockDataTypeEnum

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.LockDataTypeEnum>

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 traitIdString

typeName

open val typeNameString

value

open val valueULong