IChannelLineupProvider
EPGのチャンネルリストを置き換えるために使用されるデータプロバイダーオブジェクト。
このプロバイダーを使用すると、EPGのすべてのチャンネルを新しいチャンネルセットに設定／置換できます。新しいチャンネルセットを作成するには、チャンネルリストごとにadd()関数を呼び出します。その後、最終的にcommit()関数が呼び出されると、EPG内の以前のすべてのチャンネルが新しいチャンネルセットに置き換えられます。commit()を呼び出す前にプロバイダーオブジェクトが破棄されると、キューに入れられていたすべての変更が失われます。このインターフェイスはスレッドセーフではないことに注意してください。非決定的な動作を避けるため、このオブジェクトの複数のインスタンスを作成して異なるスレッドで使用しないでください。このオブジェクトのいずれかのメソッドでエラーがスローされた場合は、このオブジェクトを破棄して新しいインスタンスを作成してください。
メソッド
add()
add(channels: IChannelInfo
[]):Promise<void>
コミットキューにチャンネルのリストを追加します。
EPG用のチャンネルデータを追加するために、この関数を1回以上呼び出すことができます。挿入されたデータは、commit()関数が呼び出されたときにのみコミットされます。
パラメーター
channels
挿入するチャンネルの配列。
エラー
- 同じ
IChannelLineupProviderが以前にいずれかのメソッドでエラーをスローしており、その後でこの関数が呼び出された場合、IllegalStateErrorがスローされます。 - 指定されたチャンネルのいずれかが無効な場合、InvalidArgumentErrorがスローされます。エラーメッセージには、失敗した挿入の合計数と、失敗した最初の5つのチャンネルの理由が含まれます。エラーメッセージの例は開発者ガイドに記載されています。
- データストア接続の問題などの回復不可能なエラーがこの関数で発生した場合、InternalErrorがスローされます。エラーメッセージには、障害が発生したチャンネルと障害の原因となったエラーが含まれます。
- 取り込まれたデータがストレージ制限を超えたためにこの関数でエラーが発生した場合、StorageLimitErrorがスローされます。このエラーが発生した場合は、Amazonの担当者に問い合わせてください。
戻り値
Promise<void>
commit()
commit(version:
string):Promise<void>
現在のチャンネルデータを、コミットキューに追加された保留中のチャンネルデータに置き換えます。
この関数は、add()関数を使用してすべてのデータをコミットキューに追加した後に呼び出す必要があります。プロバイダーがコミットされると、既存のチャンネルはすべてデータストアから削除され、このプロバイダーオブジェクトに追加されたすべてのチャンネルに置き換えられます。この呼び出しが成功した後で、EpgLineupInformation.getLastCommittedChannelLineupVersion()がこのバージョン値を返し始めます。
パラメーター
version
string
コミット対象のチャンネルラインナップのバージョンを表す文字列。
エラー
- プロバイダーがいずれかのメソッドでエラーをスローしており、その後でこの関数が呼び出された場合、
IllegalStateErrorがスローされます。 - データをデータストアにコミットできない場合、
InternalErrorがスローされます。
戻り値
Promise<void>
Last updated: 2026年7月22日
