ContentLauncherTrait.LaunchContentCommand.Request

class ContentLauncherTrait.LaunchContentCommand.Request : ClusterStruct


The request payload for the LaunchContent command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Request(
    search: ContentLauncherTrait.ContentSearchStruct,
    autoPlay: Boolean,
    data: OptionalValue<String>,
    playbackPreferences: OptionalValue<ContentLauncherTrait.PlaybackPreferencesStruct>,
    useCurrentContext: OptionalValue<Boolean>
)

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

Boolean

Set to true to have the matching content play automatically.

OptionalValue<String>

Optional app-specific data.

OptionalValue<ContentLauncherTrait.PlaybackPreferencesStruct>
ContentLauncherTrait.ContentSearchStruct

The content to launch.

OptionalValue<Boolean>

Public constructors

Request

Request(
    search: ContentLauncherTrait.ContentSearchStruct = ContentSearchStruct(),
    autoPlay: Boolean = false,
    data: OptionalValue<String> = OptionalValue.absent(),
    playbackPreferences: OptionalValue<ContentLauncherTrait.PlaybackPreferencesStruct> = OptionalValue.absent(),
    useCurrentContext: OptionalValue<Boolean> = OptionalValue.absent()
)

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

autoPlay

val autoPlayBoolean

Set to true to have the matching content play automatically.

data

val dataOptionalValue<String>

Optional app-specific data.

search

val searchContentLauncherTrait.ContentSearchStruct

The content to launch.

useCurrentContext

val useCurrentContextOptionalValue<Boolean>