ILiveEvent

​

Interface ILiveEvent

interface ILiveEvent

Extends com.amazon.apmf.IStandard

​

Methods

​

getIdentifier()

string getIdentifier()

Gets the unique identifier of the live event.

​

Returns

string The unique identifier for the live event. The identifier is unique across all live events within the application package.

---

​

getEventType()

EventType getEventType()

Gets the type of the live event.

​

Returns

EventType The type of the live event.

---

​

getPlaybackReference()

IPlaybackReference* getPlaybackReference()

Gets the playback reference associated with the live event, which describes how to start playback.

​

Returns

IPlaybackReference* The playback reference of the live event.

---

​

getStartTime()

com.amazon.apmf.RealTimeInstant? getStartTime()

Gets the start time of the live event, if one is specified.

​

Returns

com.amazon.apmf.RealTimeInstant? The return value is optional and might be absent. The epoch time indicating the start time of a live event.

---

​

getEndTime()

com.amazon.apmf.RealTimeInstant? getEndTime()

Gets the end time of the live event, if one is specified.

​

Returns

com.amazon.apmf.RealTimeInstant? The return value is optional and might be absent. The epoch time indicating the end time of a live event.

---

​

getTitle()

string getTitle()

Gets the title of the live event.

​

Returns

string The title or name for the specific live event.

---

​

getDescription()

string getDescription()

Gets the brief description of the live event.

​

Returns

string The brief description for the specific live event. Empty string is returned if there is no description associated with this live event.

---

​

getRatings()

string[] getRatings()

Gets the list of ratings for the live event.

​

Returns

string[] The list of strings used to indicate the level of parental guidance recommended for a particular live event. This can be any rating system used in the country or region where the live event 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 live event.

​

Returns

string[] The list of genres that apply to the live event. Please refer to the developer guide for a recommended list of canonical values for this field.

---

​

getLogoUrl()

string getLogoUrl()

Gets the logo url for the live event.

​

Returns

string The url where the logo image can be found. Used to render the event logo. Empty string is returned if there is no thumbnail url associated with this live event.

---

​

getPosterArtUrl()

string getPosterArtUrl()

Gets the poster art url for the live event.

​

Returns

string The url where the poster art image can be found. Used to render the event tile and background when live preview is not available. Empty string is returned if there is no poster art url associated with this live event.

---

​

getAttributes()

string[] getAttributes()

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

​

Returns

string[] The list of attributes of the live event.

---

​

getSortRank()

i32 getSortRank()

Gets the sort rank of the live event.

​

Returns

i32 The sort rank of this live event relative to other live events. Live events with lower integer values for the sort rank will be displayed before live events with higher sort rank values in the row for this app. This is set to MAX Int32 by default if none was provided. Please reach out to your Amazon contact if you want to display live events according to their sort rank values.

---