ChannelTrait.GetProgramGuideCommand.Request
class ChannelTrait.GetProgramGuideCommand.Request : ClusterStruct
The request payload for the GetProgramGuide command.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the GetProgramGuide 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<List<ChannelTrait.ChannelInfoStruct>> |
The set of channels for which program guide entries should be fetched. |
OptionalValue<ByteArray> |
Optional app-specific data. |
OptionalValue<UInt> |
The end of the time window for which program guide entries are to be retrieved, as a UTC time. |
OptionalValue<List<ChannelTrait.AdditionalInfoStruct>> |
The list of additional external content identifiers. |
OptionalValue<ChannelTrait.PageTokenStruct> |
The pagination token used for managing pagination progression. |
OptionalValue<ChannelTrait.RecordingFlagBitmap> |
The flags of the programs for which entries should be fetched. |
OptionalValue<UInt> |
The beginning of the time window for which program guide entries are to be retrieved, as a UTC time. |
Public constructors
Request
Request(
startTime: OptionalValue<UInt> = OptionalValue.absent(),
endTime: OptionalValue<UInt> = OptionalValue.absent(),
channelList: OptionalValue<List<ChannelTrait.ChannelInfoStruct>> = OptionalValue.absent(),
pageToken: OptionalValue<ChannelTrait.PageTokenStruct> = OptionalValue.absent(),
recordingFlag: OptionalValue<ChannelTrait.RecordingFlagBitmap> = OptionalValue.absent(),
externalIdList: OptionalValue<List<ChannelTrait.AdditionalInfoStruct>> = OptionalValue.absent(),
data: OptionalValue<ByteArray> = OptionalValue.absent()
)
Creates a request payload for the GetProgramGuide 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
channelList
val channelList: OptionalValue<List<ChannelTrait.ChannelInfoStruct>>
The set of channels for which program guide entries should be fetched.
endTime
val endTime: OptionalValue<UInt>
The end of the time window for which program guide entries are to be retrieved, as a UTC time.
externalIdList
val externalIdList: OptionalValue<List<ChannelTrait.AdditionalInfoStruct>>
The list of additional external content identifiers.
pageToken
val pageToken: OptionalValue<ChannelTrait.PageTokenStruct>
The pagination token used for managing pagination progression.
recordingFlag
val recordingFlag: OptionalValue<ChannelTrait.RecordingFlagBitmap>
The flags of the programs for which entries should be fetched.
startTime
val startTime: OptionalValue<UInt>
The beginning of the time window for which program guide entries are to be retrieved, as a UTC time.