ContentLauncherTrait.LaunchContentCommand.Request
class ContentLauncherTrait.LaunchContentCommand.Request : ClusterStruct
The request payload for the LaunchContent command.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(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 |
OptionalValue<String> |
Optional app-specific data. |
OptionalValue<ContentLauncherTrait.PlaybackPreferencesStruct> |
The user's preferred Text/AudioTracks and playbackPosition. |
ContentLauncherTrait.ContentSearchStruct |
The content to launch. |
OptionalValue<Boolean> |
Whether to consider the context of current ongoing activity. |
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
@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
playbackPreferences
val playbackPreferences: OptionalValue<ContentLauncherTrait.PlaybackPreferencesStruct>
The user's preferred Text/AudioTracks and playbackPosition.
useCurrentContext
val useCurrentContext: OptionalValue<Boolean>
Whether to consider the context of current ongoing activity.