add()関数を呼び出します。その後、最終的にcommit()関数が呼び出されると、以前のすべてのライブイベントが新しいライブイベントセットに置き換えられます。commit()を呼び出す前にプロバイダーオブジェクトが破棄されると、キューに入れられているすべての変更が失われます。
メソッド
add()
add(liveEvents: ILiveEvent[]): Promise<IAddLiveEventFailure[]>
コミットキューにライブイベントのリストを追加します。
ライブイベントデータを追加するために、この関数を1回以上呼び出すことができます。挿入できなかったライブイベントはすべてスキップし、提供された残りのライブイベントの挿入を続行します。挿入できなかったライブイベントのリストが返されます。挿入されたデータは、commit()関数が呼び出されたときにのみコミットされます。
パラメーター
liveEvents
ILiveEvent[]
挿入するライブイベントインスタンスの配列です。
エラー
- 同じ
LiveEventProviderのいずれかのメソッドからエラーが返された後でこの関数が呼び出された場合、IllegalStateErrorがスローされます。 - データストア接続の問題などの回復不可能なエラーがこの関数で発生した場合、InternalErrorがスローされます。このエラーを受け取ったら、プロバイダーを中止する必要があります。
- 取り込まれたデータがストレージ制限を超えたためにこの関数でエラーが発生した場合、StorageLimitErrorがスローされます。このエラーが発生した場合は、Amazonの担当者に問い合わせてください。
戻り値
Promise<IAddLiveEventFailure[]>
IAddLiveEventFailure[]は、コミットキューに追加できなかったライブイベントと失敗の原因となったエラーのリストです。
commit()
commit(version:string): Promise<void>
保留中のすべての操作をこのプロバイダーオブジェクトからデータストアにコミットします。
この関数は、プロバイダーインターフェイスのほかのメソッドを使用してプロバイダーで操作を実行した後に一度だけ呼び出す必要があります。
パラメーター
version
string
このコミットの結果としてデータストアに格納されるライブイベントラインナップのバージョンを表す文字列。
エラー
- プロバイダーから
InternalErrorが返された後でこの関数が呼び出された場合、IllegalStateErrorがスローされます。 - データをデータストアにコミットできない場合、
InternalErrorがスローされます。
戻り値
Promise<void>
