AmazonNativeLiveEventProvider

Interface for the Live Event Lineup Provider Turbo Module that allows VegaScript code to use Native Live Event Lineup Provider API functions so that program data can be provided from VegaScript apps.

​

Extends

• KeplerTurboModule

​

Properties

​

getConstants()?

readonly optional getConstants: () => object

​

Returns

object

​

Inherited from

KeplerTurboModule.getConstants

---

​

getMajorVersion()

getMajorVersion: () => number

​

Returns

number

​

Overrides

KeplerTurboModule.getMajorVersion

---

​

getMinorVersion()

getMinorVersion: () => number

​

Returns

number

​

Overrides

KeplerTurboModule.getMinorVersion

---

​

getPatchVersion()

getPatchVersion: () => number

​

Returns

number

​

Overrides

KeplerTurboModule.getPatchVersion

​

Methods

​

add()

add(liveEvents): Promise<Object> Add a list of live events to the commit queue.

​

Parameters

liveEvents

ILiveEvent[] An array of live event instances to be inserted.

​

Returns

Promise<Object> A JavaScript object with with properties “failures”, “statusCode”, and “errorMessage”.. Status 0 is returned for success, and positive numbers for various errors.

​

Details

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. If there is any error returned due to ingested data exceeding the storage limit, a StorageLimitError will be thrown. Inserted data will only be committed when the commit() function is called.

---

​

commit()

commit(version): Promise<Object> Commits any pending operations to the data store.

​

Parameters

version

string A string representing the version of the live events that will be in the data store as a result of this commit.

​

Returns

Promise<Object> A status object with a numeric error code and string message. Status 0 is returned for success, and positive numbers for various errors.

​

Details

This function should be called once after performing operations on the provider using the other methods in the provider interface.

---

​

getLastCommittedVersion()

getLastCommittedVersion(): Promise<Object> Gets the version of the most recently committed live events.

​

Returns

Promise<Object> A JavaScript object with properties “version”, “statusCode”, and “errorMessage”. Numeric statusCode 0 is returned for success, and positive numbers for various errors.

​

Details

The live event version can be checked to determine if the last persisted live event data needs to be replaced with a newer version. If no version has been previously committed, the fixed string “NO_VERSION” will be returned.

---