ChannelTrait.RecordProgramCommand.Request

class ChannelTrait.RecordProgramCommand.Request : ClusterStruct

The request payload for the RecordProgram command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors
Request(
    programIdentifier: String,
    shouldRecordSeries: Boolean,
    externalIdList: List<ChannelTrait.AdditionalInfoStruct>,
    data: ByteArray
)

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

Optional app-specific data.
List<ChannelTrait.AdditionalInfoStruct>

The list of additional external content identifiers.
String

The program identifier for the program that should be recorded.
Boolean

Whether the whole series associated to the program should be recorded.

Public constructors

Request

Request(
    programIdentifier: String = "",
    shouldRecordSeries: Boolean = false,
    externalIdList: List<ChannelTrait.AdditionalInfoStruct> = emptyList(),
    data: ByteArray = ByteArray(0)
)

Creates a request payload for the RecordProgram 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 data: ByteArray

Optional app-specific data.

externalIdList

val externalIdList: List<ChannelTrait.AdditionalInfoStruct>

The list of additional external content identifiers.

programIdentifier

val programIdentifier: String

The program identifier for the program that should be recorded.

shouldRecordSeries

val shouldRecordSeries: Boolean

Whether the whole series associated to the program should be recorded.