ILiveEventProvider
ライブイベントのリストを置き換えるために使用されるデータプロバイダーオブジェクトです。
詳細
このプロバイダーを使用すると、すべてのライブイベントをまったく新しいライブイベントセットに設定／置換できます。新しいライブイベントセットを作成するには、ライブイベントリストごとにadd()関数を呼び出します。その後、最終的にcommit()関数が呼び出されると、以前のすべてのライブイベントが新しいライブイベントセットに置き換えられます。commit()を呼び出す前にプロバイダーオブジェクトが破棄されると、キューに入れられているすべての変更が失われます。
メソッド
add()
add(
liveEvents):Promise<IAddLiveEventFailure[]>
コミットキューにライブイベントのリストを追加します。
パラメーター
liveEvents
挿入するライブイベントインスタンスの配列です。
戻り値
Promise<IAddLiveEventFailure[]>
コミットキューに追加できなかったライブイベントと失敗の原因となったエラーのリストです。
詳細
ライブイベントデータを追加するために、この関数を1回以上呼び出すことができます。挿入できなかったライブイベントはすべてスキップし、提供された残りのライブイベントの挿入を続行します。挿入できなかったライブイベントのリストが返されます。挿入されたデータは、commit()関数が呼び出されたときにのみコミットされます。
スロー
同じLiveEventProviderのいずれかのメソッドからエラーが返された後でこの関数が呼び出された場合にスローされます。
スロー
この関数でデータストア接続の問題などの回復不可能なエラーが発生した場合にスローされます。このエラーを受け取ったら、プロバイダーを中止する必要があります。
スロー
取り込まれたデータがストレージ制限を超えたためにこの関数でエラーが発生した場合、StorageLimitErrorがスローされます。このエラーが発生した場合は、Amazonの担当者に問い合わせてください。
commit()
commit(
version):Promise<void>
現在のライブイベントデータをすべて削除し、コミットキューに追加された保留中のライブイベントデータを保存します。
パラメーター
version
string
コミット対象のライブイベントのバージョンを表す文字列です。このフィールドの使用方法の詳細については、開発者ガイドを参照してください。
戻り値
Promise<void>
詳細
この関数は、add()関数を使用してすべてのデータをコミットキューに追加した後に1回だけ呼び出す必要があります。プロバイダーがコミットされると、既存のライブイベントはすべてデータストアから削除され、このプロバイダーオブジェクトに追加されたすべてのライブイベントに置き換えられます。
スロー
同じLiveEventProviderからInternalErrorが返された後でこの関数が呼び出された場合にスローされます。
スロー
データをライブTVプロバイダーのデータストアにコミットできない場合にスローされます。このエラーを受け取ったら、プロバイダーを中止する必要があります。
Last updated: 2025年9月30日
