ContentAppObserverTrait.ContentAppMessageCommand.Response

class ContentAppObserverTrait.ContentAppMessageCommand.Response : ClusterStruct


The result of the ContentAppMessage command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Response(
    status: ContentAppObserverTrait.StatusEnum,
    data: String?,
    encodingHint: String?
)

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

Content app-specific data.

String?

A content app-specific hint as to the encoding of the data.

ContentAppObserverTrait.StatusEnum

The status of the command which resulted in this response.

Public constructors

Response

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

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

data

val dataString?

Content app-specific data.

encodingHint

val encodingHintString?

A content app-specific hint as to the encoding of the data.

status

val statusContentAppObserverTrait.StatusEnum

The status of the command which resulted in this response.