AmazonNativeLiveEventProvider
VegaScriptコードでネイティブライブイベントラインナッププロバイダーのAPI関数を使用できるようにする、ライブイベントラインナッププロバイダーターボモジュールのインターフェイスです。これにより、VegaScriptアプリから番組データを提供できるようになります。
拡張
KeplerTurboModule
プロパティ
getConstants()?
readonlyoptionalgetConstants: () =>object
戻り値
object
継承元
KeplerTurboModule.getConstants
getMajorVersion()
getMajorVersion: () =>
number
戻り値
number
オーバーライド
KeplerTurboModule.getMajorVersion
getMinorVersion()
getMinorVersion: () =>
number
戻り値
number
オーバーライド
KeplerTurboModule.getMinorVersion
getPatchVersion()
getPatchVersion: () =>
number
戻り値
number
オーバーライド
KeplerTurboModule.getPatchVersion
メソッド
add()
add(
liveEvents):Promise<Object>
コミットキューにライブイベントのリストを追加します。
パラメーター
liveEvents
挿入するライブイベントインスタンスの配列です。
戻り値
Promise<Object>
「failures」、「statusCode」、「errorMessage」の各プロパティを持つJavaScriptオブジェクト。成功するとステータス「0」が返され、各種エラーについてはそれぞれ正の数値が返されます。
詳細
ライブイベントデータを追加するために、この関数を1回以上呼び出すことができます。挿入できなかったライブイベントはすべてスキップし、提供された残りのライブイベントの挿入を続行します。挿入できなかったライブイベントのリストが返されます。取り込まれたデータがストレージ制限を超えたためにエラーが返された場合、StorageLimitErrorがスローされます。挿入されたデータは、commit()関数が呼び出されたときにのみコミットされます。
commit()
commit(
version):Promise<Object>
データストアに対する保留中の操作すべてをコミットします。
パラメーター
version
string
このコミットの結果としてデータストアに格納されるライブイベントのバージョンを表す文字列。
戻り値
Promise<Object>
数値のエラーコードと文字列のメッセージを含むステータスオブジェクト。成功するとステータス「0」が返され、各種エラーについてはそれぞれ正の数値が返されます。
詳細
この関数は、プロバイダーインターフェイスの他のメソッドを使用してプロバイダーで操作を実行した後に1回だけ呼び出す必要があります。
getLastCommittedVersion()
getLastCommittedVersion():
Promise<Object>
一番最後にコミットされたライブイベントのバージョンを取得します。
戻り値
Promise<Object>
「version」、「statusCode」、「errorMessage」の各プロパティを持つJavaScriptオブジェクト。成功すると数値のstatusCode「0」が返され、各種エラーについてはそれぞれ正の数値が返されます。
詳細
ライブイベントのバージョンを確認して、最後に永続化されたライブイベントデータを新しいバージョンに置き換える必要があるかどうかを判断できます。コミット済みのバージョンがない場合は、固定文字列「NO_VERSION」が返されます。
Last updated: 2025年9月30日
