Program class.
Accessors
attributes
Get Signature
get attributes():string[]
Gets the attributes for the program.
Returns
string[]
The list of attributes of the program.
Please refer to the developer guide for a recommended list of canonical values for this field.
channelDescriptor
Get Signature
get channelDescriptor():IChannelDescriptor
Gets the channel descriptor to which this program is associated.
Returns
IChannelDescriptor
The descriptor of the channel on which this program is airing.
description
Get Signature
get description():string
Gets the description for the program.
Returns
string
The brief description for the specific program. For example, a description of an episode.
endTimeMs
Get Signature
get endTimeMs():number
Gets the end time for the program.
Returns
number
The end time of the program in milliseconds since epoch.
genres
Get Signature
get genres():string[]
Gets the genres for the program.
Returns
string[]
The list of genres that apply to the program.
Please refer to the developer guide for a recommended list of canonical values for this field.
identifier
Get Signature
get identifier():string
Gets the identifier for the program.
Returns
string
The identifier for a program in an electronic program guide list.
posterArtUrl
Get Signature
get posterArtUrl():string
Gets the poster art url for the program.
Returns
string
The URL where the poster art image can be found. Used to render larger sized program
images such as the background banner for the detail view.
ratings
Get Signature
get ratings():string[]
Gets the ratings for the program.
Returns
string[]
The list of strings used to indicate the level of parental guidance recommended for a particular program.
This can be any rating system used in the country or region where the program is broadcasted.
Please refer to the developer guide for a recommended list of canonical values for this field.
seriesInfo
Get Signature
get seriesInfo():undefined | ISeriesInfo
Gets the series information for the program.
Returns
undefined | ISeriesInfo
The series-related information of the program, such as season and episode number.
This field is optional but SHOULD be provided if the program represents an episode and this
information is available.
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.
subtitle
Get Signature
get subtitle():string
Gets the subordinate title of the program.
Returns
string
The subordinate title for a specific program. For example, “Maybe Today” which is an episode name for “MCIS: Los Angeles”.
thumbnailUrl
Get Signature
get thumbnailUrl():string
Gets the thumbnail url for the program.
Returns
string
The URL where the thumbnail image can be found. Used to render program thumbnails.
title
Get Signature
get title():string
Gets the title of the program.
Returns
string
The title or name for the specific program. For example, “MCIS: Los Angeles”.
