LocatorTrait.LocateCommand.Request

class LocatorTrait.LocateCommand.Request : ClusterStruct

The request payload for the Locate command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors
Request(lang: String, reportLocation: Boolean)

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

Current language of query or display.
Boolean

Indicates that coordinates are expected in the response and that the device should not ring.

Public constructors

Request

Request(lang: String = "", reportLocation: Boolean = false)

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

lang

val lang: String

Current language of query or display.

reportLocation

val reportLocation: Boolean

Indicates that coordinates are expected in the response and that the device should not ring.