AdvancedPerceptionDetectionTrait.SecurityIncidentType

enum AdvancedPerceptionDetectionTrait.SecurityIncidentType : Enum, ClusterEnum


The type of security incident.

Summary

Enum Values

Assault

Assault.

CarBreakIn

Car break-in.

ExternalDoorLeftAjar

External door left ajar.

ForcedEntry

Forced entry.

GarageDoorLeftOpen

Garage door left open.

Loitering

Loitering.

SuspectedPackageTheft

Suspected package theft.

SuspiciousBehavior

Suspicious behavior.

TheftInProgress

Theft in progress.

UnknownValue

The enum value is out of range.

Unspecified

Unspecified.

Vandalism

Vandalism.

VisibleWeapon

Visible weapon.

Public functions

String
AdvancedPerceptionDetectionTrait.SecurityIncidentType
valueOf(value: String)

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

Array<AdvancedPerceptionDetectionTrait.SecurityIncidentType>

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

Public properties

EnumEntries<AdvancedPerceptionDetectionTrait.SecurityIncidentType>

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

open String

Trait identifier of the Matter Cluster that defines the enum Data Type.

open String

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

open ULong

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

Enum Values

UnknownValue

val AdvancedPerceptionDetectionTrait.SecurityIncidentType.UnknownValue: AdvancedPerceptionDetectionTrait.SecurityIncidentType

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): AdvancedPerceptionDetectionTrait.SecurityIncidentType

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<AdvancedPerceptionDetectionTrait.SecurityIncidentType>

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<AdvancedPerceptionDetectionTrait.SecurityIncidentType>

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.