ApplicationBasicTrait.ApplicationStatusEnum

enum ApplicationBasicTrait.ApplicationStatusEnum : Enum, ClusterEnum


Application statuses.

Summary

Enum Values

ActiveHidden

Application is running but is not visible.

ActiveVisibleFocus

Application is running, is visible, and is the active target for input.

ActiveVisibleNotFocus

Application is running and visible, but is not the active target for input.

Stopped

Application is not running.

UnknownValue

The enum value is out of range.

Public functions

ApplicationBasicTrait.ApplicationStatusEnum
valueOf(value: String)

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

Array<ApplicationBasicTrait.ApplicationStatusEnum>

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

Public properties

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

ActiveHidden

val ApplicationBasicTrait.ApplicationStatusEnum.ActiveHiddenApplicationBasicTrait.ApplicationStatusEnum

Application is running but is not visible.

ActiveVisibleFocus

val ApplicationBasicTrait.ApplicationStatusEnum.ActiveVisibleFocusApplicationBasicTrait.ApplicationStatusEnum

Application is running, is visible, and is the active target for input.

ActiveVisibleNotFocus

val ApplicationBasicTrait.ApplicationStatusEnum.ActiveVisibleNotFocusApplicationBasicTrait.ApplicationStatusEnum

Application is running and visible, but is not the active target for input.

UnknownValue

val ApplicationBasicTrait.ApplicationStatusEnum.UnknownValueApplicationBasicTrait.ApplicationStatusEnum

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): ApplicationBasicTrait.ApplicationStatusEnum

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<ApplicationBasicTrait.ApplicationStatusEnum>

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 traitIdString

Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.

typeName

open val typeNameString

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

value

open val valueULong

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