DoorLockTrait.DoorLockUserType

enum DoorLockTrait.DoorLockUserType : Enum, ClusterEnum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.home.matter.standard.DoorLockTrait.DoorLockUserType

The type for a specific user.

Summary

Enum Values
`MasterUser`	Master user.
`NonAccessUser`	User is recognized by the lock but does not have the ability to open the lock.
`NotSupported`	Not supported.
`UnknownValue`	The enum value is out of range.
`Unrestricted`	Unrestricted user.
`WeekDayScheduleUser`	Weekday schedule user.
`YearDayScheduleUser`	Year day schedule user.

Public functions
`DoorLockTrait.DoorLockUserType`	`valueOf(value: String)` Returns the enum constant of this type with the specified name.
`Array<DoorLockTrait.DoorLockUserType>`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Public properties
`open String`	`traitId` Trait identifier of the Matter Cluster that defines the enum Data Type.
`open String`	`typeName` Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.
`open ULong`	`value` Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.

Enum Values

MasterUser

val DoorLockTrait.DoorLockUserType.MasterUser: DoorLockTrait.DoorLockUserType

Master user.

NonAccessUser

val DoorLockTrait.DoorLockUserType.NonAccessUser: DoorLockTrait.DoorLockUserType

User is recognized by the lock but does not have the ability to open the lock.

NotSupported

val DoorLockTrait.DoorLockUserType.NotSupported: DoorLockTrait.DoorLockUserType

Not supported.

UnknownValue

val DoorLockTrait.DoorLockUserType.UnknownValue: DoorLockTrait.DoorLockUserType

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.

Unrestricted

val DoorLockTrait.DoorLockUserType.Unrestricted: DoorLockTrait.DoorLockUserType

Unrestricted user.

WeekDayScheduleUser

val DoorLockTrait.DoorLockUserType.WeekDayScheduleUser: DoorLockTrait.DoorLockUserType

Weekday schedule user.

YearDayScheduleUser

val DoorLockTrait.DoorLockUserType.YearDayScheduleUser: DoorLockTrait.DoorLockUserType

Year day schedule user.

Public functions

valueOf

fun valueOf(value: String): DoorLockTrait.DoorLockUserType

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

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.

typeName

open val typeName: String

Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.

value

open val value: ULong

Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.