DoorLockTrait.UserTypeEnum

enum DoorLockTrait.UserTypeEnum : Enum, ClusterEnum

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

The type of a specific user.

Summary

Enum Values
`DisposableUser`	Disposable.
`ExpiringUser`	Expiring.
`ForcedUser`	Forced.
`NonAccessUser`	Non-access.
`ProgrammingUser`	Programming.
`RemoteOnlyUser`	Remote-only.
`ScheduleRestrictedUser`	Schedule-restricted.
`UnknownValue`	The enum value is out of range.
`UnrestrictedUser`	Unrestricted.
`WeekDayScheduleUser`	Week day schedule.
`YearDayScheduleUser`	Year day schedule.

Public functions
`String`	`@HomeExperimentalGenericApi toDescription()`
`DoorLockTrait.UserTypeEnum`	`valueOf(value: String)` Returns the enum constant of this type with the specified name.
`Array<DoorLockTrait.UserTypeEnum>`	`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

DisposableUser

val DoorLockTrait.UserTypeEnum.DisposableUser: DoorLockTrait.UserTypeEnum

Disposable.

ExpiringUser

val DoorLockTrait.UserTypeEnum.ExpiringUser: DoorLockTrait.UserTypeEnum

Expiring.

ForcedUser

val DoorLockTrait.UserTypeEnum.ForcedUser: DoorLockTrait.UserTypeEnum

Forced.

NonAccessUser

val DoorLockTrait.UserTypeEnum.NonAccessUser: DoorLockTrait.UserTypeEnum

Non-access.

ProgrammingUser

val DoorLockTrait.UserTypeEnum.ProgrammingUser: DoorLockTrait.UserTypeEnum

Programming.

RemoteOnlyUser

val DoorLockTrait.UserTypeEnum.RemoteOnlyUser: DoorLockTrait.UserTypeEnum

Remote-only.

ScheduleRestrictedUser

val DoorLockTrait.UserTypeEnum.ScheduleRestrictedUser: DoorLockTrait.UserTypeEnum

Schedule-restricted.

UnknownValue

val DoorLockTrait.UserTypeEnum.UnknownValue: DoorLockTrait.UserTypeEnum

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.

UnrestrictedUser

val DoorLockTrait.UserTypeEnum.UnrestrictedUser: DoorLockTrait.UserTypeEnum

Unrestricted.

WeekDayScheduleUser

val DoorLockTrait.UserTypeEnum.WeekDayScheduleUser: DoorLockTrait.UserTypeEnum

Week day schedule.

YearDayScheduleUser

val DoorLockTrait.UserTypeEnum.YearDayScheduleUser: DoorLockTrait.UserTypeEnum

Year day schedule.

Public functions

toDescription

@HomeExperimentalGenericApi
fun toDescription(): String

valueOf

fun valueOf(value: String): DoorLockTrait.UserTypeEnum

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

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.