Program object
which will be built using ProgramBuilder.
Implements
Constructors
new Program()
new Program(identifier, channelDescriptor, title, startTimeMs, endTimeMs, subtitle, description, thumbnailUrl, posterArtUrl, ratings, genres, attributes, seriesInfo?): Program
Constructor function called for initialization of a Program.
Parameters
identifier
string
channelDescriptor
IChannelDescriptor
title
string
startTimeMs
number
endTimeMs
number
subtitle
string = ''
description
string = ''
thumbnailUrl
string = ''
posterArtUrl
string = ''
ratings
string[] = []
genres
string[] = []
attributes
string[] = []
seriesInfo?
ISeriesInfo
Returns
Program
Accessors
attributes
Get Signature
get attributes():string[]
Gets the attributes of the Program.
Returns
string[]
The program attributes.
Implementation of
IProgram.attributes
channelDescriptor
Get Signature
get channelDescriptor():IChannelDescriptor
Gets the ChannelDescriptor of the Program.
Returns
IChannelDescriptor
The ChannelDescriptor of the Program.
Implementation of
IProgram.channelDescriptor
description
Get Signature
get description():string
Gets the description of the Program.
Returns
string
The program description.
Implementation of
IProgram.description
endTimeMs
Get Signature
get endTimeMs():number
Gets the end time of the Program.
Returns
number
The end time of the program in milliseconds since epoch.
Implementation of
IProgram.endTimeMs
genres
Get Signature
get genres():string[]
Gets the genres that pertain to the Program.
Returns
string[]
The genres of the program.
Implementation of
IProgram.genres
identifier
Get Signature
get identifier():string
Gets the identifier of the Program.
Returns
string
The program identifier.
Implementation of
IProgram.identifier
posterArtUrl
Get Signature
get posterArtUrl():string
Gets the poster art url of the Program.
Returns
string
The poster art url of the program.
Implementation of
IProgram.posterArtUrl
ratings
Get Signature
get ratings():string[]
Gets the parental guidance ratings of the Program.
Returns
string[]
The program parental guidance ratings.
Implementation of
IProgram.ratings
seriesInfo
Get Signature
get seriesInfo():undefined | ISeriesInfo
Gets the series information of the Program.
Returns
undefined | ISeriesInfo
The series information of the program.
Implementation of
IProgram.seriesInfo
startTimeMs
Get Signature
get startTimeMs():number
Gets the start time of the Program.
Returns
number
The start time of the program in milliseconds since epoch.
Implementation of
IProgram.startTimeMs
subtitle
Get Signature
get subtitle():string
Gets the subtitle of the Program.
Returns
string
The program subtitle.
Implementation of
IProgram.subtitle
thumbnailUrl
Get Signature
get thumbnailUrl():string
Gets the thumbnail url of the Program.
Returns
string
The thumbnail url of the program.
Implementation of
IProgram.thumbnailUrl
title
Get Signature
get title():string
Gets the title of the Program.
Returns
string
The program title.
Implementation of
IProgram.title
