MessagesTrait.MessageResponseOptionStruct

class MessagesTrait.MessageResponseOptionStruct : ClusterStruct


A possible response to a message.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

MessageResponseOptionStruct(
    messageResponseId: OptionalValue<UInt>,
    label: OptionalValue<String>
)

Creates the MessageResponseOptionStruct 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

OptionalValue<String>

The text for this option, for example yes or no.

OptionalValue<UInt>

A unique, unsigned 32-bit numeric identifier for this message response option.

Public constructors

MessageResponseOptionStruct

MessageResponseOptionStruct(
    messageResponseId: OptionalValue<UInt> = OptionalValue.absent(),
    label: OptionalValue<String> = OptionalValue.absent()
)

Creates the MessageResponseOptionStruct class.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

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

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

Public properties

label

val labelOptionalValue<String>

The text for this option, for example yes or no.

messageResponseId

val messageResponseIdOptionalValue<UInt>

A unique, unsigned 32-bit numeric identifier for this message response option.