MessagesTrait.CancelMessagesRequestCommand.Request

class MessagesTrait.CancelMessagesRequestCommand.Request : ClusterStruct


The request payload for the CancelMessagesRequest command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Request(messageIds: List<ByteArray>)

Creates a request payload for the CancelMessagesRequest command.

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

List<ByteArray>

Provides a list of messageIds for the messages to be cancelled, and causes any active presentation of the messages to stop.

Public constructors

Request

Request(messageIds: List<ByteArray> = emptyList())

Creates a request payload for the CancelMessagesRequest command.

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

messageIds

val messageIdsList<ByteArray>

Provides a list of messageIds for the messages to be cancelled, and causes any active presentation of the messages to stop.