KeypadInputTrait.StatusEnum

enum KeypadInputTrait.StatusEnum : Enum, ClusterEnum


Status codes for SendKey commands.

Summary

Enum Values

InvalidKeyInCurrentState

Command failed: Requested key code is invalid in the context of the responder's current state.

Success

Command succeeded.

UnknownValue

The enum value is out of range.

UnsupportedKey

Command failed: Key code is not supported.

Public functions

KeypadInputTrait.StatusEnum
valueOf(value: String)

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

Array<KeypadInputTrait.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

InvalidKeyInCurrentState

val KeypadInputTrait.StatusEnum.InvalidKeyInCurrentStateKeypadInputTrait.StatusEnum

Command failed: Requested key code is invalid in the context of the responder's current state.

UnknownValue

val KeypadInputTrait.StatusEnum.UnknownValueKeypadInputTrait.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.

UnsupportedKey

val KeypadInputTrait.StatusEnum.UnsupportedKeyKeypadInputTrait.StatusEnum

Command failed: Key code is not supported.

Public functions

valueOf

fun valueOf(value: String): KeypadInputTrait.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<KeypadInputTrait.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