ArmDisarmTrait.LevelValues

class ArmDisarmTrait.LevelValues : ClusterStruct


Contains a user-friendly name for the levels as well as the language code.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

LevelValues(levelSynonym: List<String>, languageCode: String)

Creates the LevelValues class.

Public functions

open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

Public properties

String

Language code for the synonym of the corresponding level.

List<String>

User-friendly names for the level in each supported language.

Public constructors

LevelValues

LevelValues(
    levelSynonym: List<String> = emptyList(),
    languageCode: String = ""
)

Creates the LevelValues class.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

languageCode

val languageCodeString

Language code for the synonym of the corresponding level.

levelSynonym

val levelSynonymList<String>

User-friendly names for the level in each supported language. These names should be in sentence case and avoid words such as arm and armed. The first string in this list is used as the default name of the level and is displayed on devices with screens.