IProgram

​

Interface IProgram

interface IProgram

Extends com.amazon.apmf.IStandard Interface that represents a Program object.

​

Methods

​

getIdentifier()

string getIdentifier()

Gets the identifier for the program.

​

Returns

string The identifier for a program in an electronic program guide list.

---

​

getChannelDescriptor()

IChannelDescriptor* getChannelDescriptor()

Gets the channel descriptor to which this program is associated.

​

Returns

IChannelDescriptor* The descriptor of the channel on which this program is airing.

---

​

getStartTime()

com.amazon.apmf.RawTimeValue getStartTime()

Gets the start time of the program.

​

Returns

com.amazon.apmf.RawTimeValue The epoch time indicating the start time of a program. This field can represent a past or future value.

---

​

getEndTime()

com.amazon.apmf.RawTimeValue getEndTime()

Gets the end time of the program.

​

Returns

com.amazon.apmf.RawTimeValue The epoch time indicating the end time of a program. This field can represent a past or future value.

---

​

getTitle()

string getTitle()

Gets the title of the program.

​

Returns

string The title or name for the specific program. For example, “MCIS: Los Angeles”.

---

​

getSubtitle()

string getSubtitle()

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 the series “MCIS: Los Angeles”. Empty string is returned if there is no subtitle associated with this Program.

---

​

getDescription()

string getDescription()

Gets the description of the program.

​

Returns

string The brief description for the specific program. For example, a description of an episode. Empty string is returned if there is no description associated with this Program.

---

​

getRatings()

string[] getRatings()

Gets the list of ratings for a 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.

---

​

getGenres()

string[] getGenres()

Gets the list of 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.

---

​

getThumbnailUrl()

string getThumbnailUrl()

Gets the thumbnail URL for the program.

​

Returns

string The URL where the thumbnail image can be found. Used to render program thumbnails. Empty string is returned if there is no thumbnail URL associated with this Program.

---

​

getPosterArtUrl()

string getPosterArtUrl()

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. Empty string is returned if there is no poster art URL associated with this Program.

---

​

getSeriesInfo()

ISeriesInfo? getSeriesInfo()

Gets the series information for the program.

​

Returns

ISeriesInfo? The return value is optional and might be absent. Series-related information for the program, such as season and episode number.

---

​

getAttributes()

string[] getAttributes()

Gets the list of attributes for the program. Attributes are properties of the program. Please refer to the developer guide for a recommended list of canonical values for this field.

​

Returns

string[] List of attributes of the program.

---