TargetNavigatorTrait.NavigateTargetCommand.Response

class TargetNavigatorTrait.NavigateTargetCommand.Response : ClusterStruct


The result of the completed NavigateTarget command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Creates a response payload from 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

String?

App-specific data.

TargetNavigatorTrait.StatusEnum

The return status of the NavigateTarget command.

Public constructors

Response

Response(
    status: TargetNavigatorTrait.StatusEnum = StatusEnum.Success,
    data: String? = null
)

Creates a response payload from 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 dataString?

App-specific data.

status

val statusTargetNavigatorTrait.StatusEnum

The return status of the NavigateTarget command. Valid values are listed in StatusEnum.