RvcCleanModeTrait.ChangeToModeCommand.Request

class RvcCleanModeTrait.ChangeToModeCommand.Request : ClusterStruct

The request payload for the ChangeToMode command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors
Request(newMode: UByte)

Creates a request payload for the ChangeToMode 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
UByte

The mode to set the cluster instance to.

Public constructors

Request

Request(newMode: UByte)

Creates a request payload for the ChangeToMode command.

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

newMode

val newMode: UByte

The mode to set the cluster instance to. This must be one of the values in RvcCleanMode.ModeOptionStruct.