DoorLockTrait.DoorLockProgrammingEventCode

enum DoorLockTrait.DoorLockProgrammingEventCode : Enum, ClusterEnum

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

Door lock programming event codes.

Summary

Enum Values
`IdAdded`	Added.
`IdDeleted`	Deleted.
`MasterCodeChanged`	Master code was changed.
`PinAdded`	PIN added.
`PinChanged`	PIN changed.
`PinDeleted`	PIN deleted.
`UnknownOrMfgSpecific`	Unknown or manufacturer-specific event
`UnknownValue`	The enum value is out of range.

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

IdAdded

val DoorLockTrait.DoorLockProgrammingEventCode.IdAdded: DoorLockTrait.DoorLockProgrammingEventCode

Added.

IdDeleted

val DoorLockTrait.DoorLockProgrammingEventCode.IdDeleted: DoorLockTrait.DoorLockProgrammingEventCode

Deleted.

MasterCodeChanged

val DoorLockTrait.DoorLockProgrammingEventCode.MasterCodeChanged: DoorLockTrait.DoorLockProgrammingEventCode

Master code was changed.

PinAdded

val DoorLockTrait.DoorLockProgrammingEventCode.PinAdded: DoorLockTrait.DoorLockProgrammingEventCode

PIN added.

PinChanged

val DoorLockTrait.DoorLockProgrammingEventCode.PinChanged: DoorLockTrait.DoorLockProgrammingEventCode

PIN changed.

PinDeleted

val DoorLockTrait.DoorLockProgrammingEventCode.PinDeleted: DoorLockTrait.DoorLockProgrammingEventCode

PIN deleted.

UnknownOrMfgSpecific

val DoorLockTrait.DoorLockProgrammingEventCode.UnknownOrMfgSpecific: DoorLockTrait.DoorLockProgrammingEventCode

Unknown or manufacturer-specific event

UnknownValue

val DoorLockTrait.DoorLockProgrammingEventCode.UnknownValue: DoorLockTrait.DoorLockProgrammingEventCode

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

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

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.