MessagesTrait.MessageComplete

interface MessagesTrait.MessageComplete : ClusterStruct

Known direct subclasses

This event is sent when the message is confirmed by the user or when the duration of the message has elapsed without confirmation.

Summary

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
MessagesTrait.FutureMessagePreferenceEnum?

A user-provided preference for the delivery of similar messages in the future.
ByteArray?

The messageID for the message being confirmed.
String?

A user-provided reply to a message.
UInt?

The messageResponseId selected by the user.

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

futureMessagesPreference

val futureMessagesPreference: MessagesTrait.FutureMessagePreferenceEnum?

A user-provided preference for the delivery of similar messages in the future. A null value indicates there is no change in user preference.

messageId

val messageId: ByteArray?

The messageID for the message being confirmed.

reply

val reply: String?

A user-provided reply to a message. If there is no reply or the message did not have the responseRequired bit set, this field is null.

responseId

val responseId: UInt?

The messageResponseId selected by the user. If there is no response before the duration of the message elapses, this field is null.