Interface ILiveEventProvider
interface ILiveEventProvider
Extends com.amazon.apmf.IStandard
Interface representing the data provider object used for replacing the list of live events.
This provider is used to set/replace all the live events to a whole new set of live events.
The new set of live events can be created by calling the add() function multiple times with different lists of live events,
and then when the commit() function is finally called, all previous live events will be replaced with the entire
set of new live events. If the provider object is destroyed before calling commit(), all changes that are queued up will be lost.
Methods
add()
Add a list of live events to the commit queue. This function can be called one or more times to add live event data. Will skip any live events that fail to be inserted and will continue to try to insert the rest of the live events provided, the list of failed live events will be returned. Inserted data will only be committed when theIAddLiveEventFailure*[]add(com.amazon.kepler.tv.epg_provider_models.ILiveEvent*[]liveEvents)
commit() function is called.
Parameters
liveEvents
com.amazon.kepler.tv.epg_provider_models.ILiveEvent*[] — Required
An array of live event instances to be inserted.
Returns
IAddLiveEventFailure*[]
A list of live events that failed to be added to the commit queue and the error causing the failure.
Throws
IllegalStateError— if this function is called after the sameLiveEventProviderhas already returned an error previously.InternalError— if this function encounters an unrecoverable error such as data store connection issues, etc. Provider should be aborted upon receiving this error.StorageLimitError— if this function encounters an error due to ingested data exceeding the storage limit. Consult with your Amazon contact if you encounter this error.
commit()
Deletes all current live event data and saves the pending live event data added to the commit queue. This function should be called once after all data has been added to the commit queue using thevoidcommit(stringversion)
add() function. When the provider is committed, all preexisting live events will be removed from the data store,
and replaced with all of the live events added to this provider object.
Parameters
version
string — Required
A string representing the version of the live events that are being committed.
Please refer to the developer guide for more information on how to use this field.
Throws
IllegalStateError— if this function is called after the sameLiveEventProviderhas already returned anInternalErrorpreviously.InternalError— if the data cannot be committed to the LiveTV Providers data store. Provider should be aborted upon receiving this error.
