ContentLauncherTrait.LaunchUrlCommand.Request

class ContentLauncherTrait.LaunchUrlCommand.Request : ClusterStruct

The request payload for the LaunchUrl command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors
Request(
    contentUrl: String,
    displayString: OptionalValue<String>,
    brandingInformation: OptionalValue<ContentLauncherTrait.BrandingInformationStruct>
)

Creates a request payload for the LaunchUrl 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
OptionalValue<ContentLauncherTrait.BrandingInformationStruct>

The branding information that is displayed when playing back the content.
String

The URL of the content to launch.
OptionalValue<String>

A string that describes the content being accessed at the given URL.

Public constructors

Request

Request(
    contentUrl: String = "",
    displayString: OptionalValue<String> = OptionalValue.absent(),
    brandingInformation: OptionalValue<ContentLauncherTrait.BrandingInformationStruct> = OptionalValue.absent()
)

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

brandingInformation

val brandingInformation: OptionalValue<ContentLauncherTrait.BrandingInformationStruct>

The branding information that is displayed when playing back the content.

contentUrl

val contentUrl: String

The URL of the content to launch.

displayString

val displayString: OptionalValue<String>

A string that describes the content being accessed at the given URL.