ExtendedDoorLockTrait.PrivacyModeActorMethodEnum

enum ExtendedDoorLockTrait.PrivacyModeActorMethodEnum : Enum, ClusterEnum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.home.google.ExtendedDoorLockTrait.PrivacyModeActorMethodEnum

The method of the privacy mode actor for changing a lock-related state.

Summary

Enum Values
`Other`	Change produced by an unspecified entity that doesn't fall into one of the defined categories.
`Physical`	The change was caused by the actor's physical interaction with the lock.
`RemoteDelegate`	The change was produced by a remote service with no user intent.
`RemoteReminderExplicit`	The change was produced explicitly by a remote service that was confirmed by a user.
`RemoteReminderImplicit`	The change was produced implicitly by a remote service that was confirmed by a user.
`RemoteUserExplicit`	The change was produced by an actor using the app.
`RemoteUserImplicit`	The change was produced by an actor with implicit intent.
`RemoteUserOther`	The change was produced by a user that does not fit in one of the other app remote categories.
`UnknownValue`	The enum value is out of range.
`Unspecified`	Unspecified.

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

Public properties
`EnumEntries<ExtendedDoorLockTrait.PrivacyModeActorMethodEnum>`	`entries` Returns a representation of an immutable list of all enum entries, in the order they're declared.
`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

Other

val ExtendedDoorLockTrait.PrivacyModeActorMethodEnum.Other: ExtendedDoorLockTrait.PrivacyModeActorMethodEnum

Change produced by an unspecified entity that doesn't fall into one of the defined categories.

Physical

val ExtendedDoorLockTrait.PrivacyModeActorMethodEnum.Physical: ExtendedDoorLockTrait.PrivacyModeActorMethodEnum

The change was caused by the actor's physical interaction with the lock.

RemoteDelegate

val ExtendedDoorLockTrait.PrivacyModeActorMethodEnum.RemoteDelegate: ExtendedDoorLockTrait.PrivacyModeActorMethodEnum

The change was produced by a remote service with no user intent.

RemoteReminderExplicit

val ExtendedDoorLockTrait.PrivacyModeActorMethodEnum.RemoteReminderExplicit: ExtendedDoorLockTrait.PrivacyModeActorMethodEnum

The change was produced explicitly by a remote service that was confirmed by a user.

RemoteReminderImplicit

val ExtendedDoorLockTrait.PrivacyModeActorMethodEnum.RemoteReminderImplicit: ExtendedDoorLockTrait.PrivacyModeActorMethodEnum

The change was produced implicitly by a remote service that was confirmed by a user.

RemoteUserExplicit

val ExtendedDoorLockTrait.PrivacyModeActorMethodEnum.RemoteUserExplicit: ExtendedDoorLockTrait.PrivacyModeActorMethodEnum

The change was produced by an actor using the app.

RemoteUserImplicit

val ExtendedDoorLockTrait.PrivacyModeActorMethodEnum.RemoteUserImplicit: ExtendedDoorLockTrait.PrivacyModeActorMethodEnum

The change was produced by an actor with implicit intent.

RemoteUserOther

val ExtendedDoorLockTrait.PrivacyModeActorMethodEnum.RemoteUserOther: ExtendedDoorLockTrait.PrivacyModeActorMethodEnum

The change was produced by a user that does not fit in one of the other app remote categories.

UnknownValue

val ExtendedDoorLockTrait.PrivacyModeActorMethodEnum.UnknownValue: ExtendedDoorLockTrait.PrivacyModeActorMethodEnum

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 ExtendedDoorLockTrait.PrivacyModeActorMethodEnum.Unspecified: ExtendedDoorLockTrait.PrivacyModeActorMethodEnum

Unspecified.

Public functions

toDescription

@HomeExperimentalGenericApi
fun toDescription(): String

valueOf

fun valueOf(value: String): ExtendedDoorLockTrait.PrivacyModeActorMethodEnum

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<ExtendedDoorLockTrait.PrivacyModeActorMethodEnum>

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

entries

val entries: EnumEntries<ExtendedDoorLockTrait.PrivacyModeActorMethodEnum>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.

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.