ArmDisarmTrait.StatusEnum

enum ArmDisarmTrait.StatusEnum : Enum, ClusterEnum


The result status of the ArmDisarm command.

Summary

Enum Values

Failure

The command failed.

Success

The command succeeded.

UnknownValue

The enum value is out of range.

Unspecified

The result of the command is not provided.

Public functions

ArmDisarmTrait.StatusEnum
valueOf(value: String)

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

Array<ArmDisarmTrait.StatusEnum>

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

Public properties

open String
open String
open ULong

Enum Values

Success

val ArmDisarmTrait.StatusEnum.SuccessArmDisarmTrait.StatusEnum

The command succeeded.

UnknownValue

val ArmDisarmTrait.StatusEnum.UnknownValueArmDisarmTrait.StatusEnum

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 ArmDisarmTrait.StatusEnum.UnspecifiedArmDisarmTrait.StatusEnum

The result of the command is not provided.

Public functions

valueOf

fun valueOf(value: String): ArmDisarmTrait.StatusEnum

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<ArmDisarmTrait.StatusEnum>

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

typeName

open val typeNameString

value

open val valueULong