IProgramLineupProvider2

コミットの部分的な成功をサポートし、コミットできない番組に対してエラーフィードバックを提供するIProgramLineupProviderの更新済みインターフェイス。

このプロバイダーは、EPGの番組ラインナップを更新するために使用します。同じプロバイダーオブジェクト内でupsert()関数を複数回呼び出して、コミットキューに番組を追加できます。プロバイダー内で実行したすべての操作は、commit()関数が呼び出されたときに保持されます。このインターフェイスはスレッドセーフではないことに注意してください。非決定的な動作を避けるため、このオブジェクトの複数のインスタンスを作成して異なるスレッドで使用しないでください。このオブジェクトのいずれかのメソッドでエラーがスローされた場合は、このオブジェクトを破棄して新しいインスタンスを作成してください。

プロパティ

clearAllPrograms

clearAllPrograms: () => Promise<void>

データストアからすべての番組を消去します。

データストアからすべての番組を削除します。このアクションは、commit()が呼び出されるまで永続化されません。これによってデータストアからチャンネル情報が消去されることはありません。この機能は、追加した番組を電子番組表（EPG）から削除する必要がある場合にのみ使用してください。clearAllPrograms()の関数呼び出しは、同じトランザクション内でupsert()を最初に呼び出す前に実行する必要があります。

メソッド

upsert()

upsert(programs: IProgram[]): Promise<IUpsertProgramFailure[]>

EPGの番組ラインナップの番組リストをアップサートします。挿入できなかった番組はすべてスキップし、提供された残りの番組の挿入を続行します。

ライブTVプロバイダーのデータストアに番組を挿入します。このアクションは、commit()が呼び出されるまで永続化されません。

パラメーター

programs

IProgram[]

挿入する番組インスタンスの配列。

エラー

• プロバイダーのいずれかのメソッドからエラーがスローされた後にこの関数を呼び出した場合、IllegalStateErrorがスローされます。
• その他の理由でデータをコミットキューに追加できない場合、InternalErrorがスローされます。
• 取り込まれたデータがストレージ制限を超えたためにこの関数でエラーが発生した場合、StorageLimitErrorがスローされます。このエラーが発生した場合は、Amazonの担当者に問い合わせてください。

戻り値

Promise<IUpsertProgramFailure[]>

IUpsertProgramFailure*[]は、コミットキューに追加できなかった番組と失敗の原因となったエラーのリストです。すべての番組がコミットキューに正常に追加された場合は、空のリストが返されます。

---

commit()

commit(version: string): Promise<void>

IUpsertProgramFailureにならなかった保留中の操作をすべてデータストアにコミットします。

この関数は、プロバイダーインターフェイスのほかのメソッドを使用してプロバイダーで操作を実行した後に呼び出す必要があります。この呼び出しが成功した後で、EpgLineupInformation.getLastCommittedProgramLineupVersion()がこのバージョン値を返し始めます。

パラメーター

version

string

このコミットの結果としてデータストアに格納される番組ラインナップのバージョンを表す文字列。

エラー

• プロバイダーのいずれかのメソッドからInternalErrorがスローされた後にこの関数を呼び出した場合、IllegalStateErrorがスローされます。
• データをデータストアにコミットできない場合、InternalErrorがスローされます。

戻り値

Promise<void>

---

Last updated: 2026年7月22日