TargetNavigatorTrait.NavigateTargetCommand.Request

class TargetNavigatorTrait.NavigateTargetCommand.Request : ClusterStruct


The request payload for the NavigateTarget command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Request(target: UByte, data: OptionalValue<String>)

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

OptionalValue<String>

App-specific data.

UByte

The identifier for the navigation target.

Public constructors

Request

Request(target: UByte, data: OptionalValue<String> = OptionalValue.absent())

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

data

val dataOptionalValue<String>

App-specific data.

target

val targetUByte

The identifier for the navigation target.