as

Settings
Sign out
Notifications
Alexa
Amazonアプリストア
AWS
ドキュメント
Support
Contact Us
My Cases
開発
設計と開発
公開
リファレンス
サポート

IEpgSyncTaskScheduler

IEpgSyncTaskScheduler

概要

EPG同期タスクをスケジュールするための関数を公開するインターフェイス。

プロパティ

cancelScheduledTasks()

cancelScheduledTasks: () => Promise<void>

戻り値

Promise<void>

操作が正常に完了するとvoidに解決されるプロミス。

概要

既存のスケジュール済みEPG同期タスクをキャンセルする関数。

詳細

この関数は、scheduleTask()またはscheduleTaskWithExecutionWindow()によって登録された、スケジュール済みのEPG同期タスクをキャンセルします。現在スケジュールされているタスクがなくても成功します。

スロー

スケジュール済み同期タスクのキャンセル中にエラーが発生した場合、InternalErrorがスローされます。


scheduleTask()

scheduleTask: (componentId, interval) => Promise<void>

パラメーター

componentId

string

スケジュールする必要があるJSバックグラウンドタスクのコンポーネントID。

interval

number

OSが次の同期タスクをトリガーするまで待機する時間(分)。

戻り値

Promise<void>

操作が正常に完了するとvoidに解決されるプロミス。

概要

指定されたEPG同期タスクを指定された時間間隔でスケジュールする関数。

詳細

この関数は、まずEPGタスクをすぐに実行するようにスケジュールします。次に、EPG同期タスクを指定された時間間隔で実行するようにスケジュールします。この関数に渡される時間間隔は分単位で、5分~1440分の間で指定する必要があります。どの時点においても、スケジュールできるEPG同期タスクは1つだけです。最後に呼び出したEPG同期タスクメソッドが有効になり、再起動しても永続化されます。

スロー

同期タスクのスケジュール中にエラーが発生した場合、InternalErrorがスローされます。


scheduleTaskWithExecutionWindow()

scheduleTaskWithExecutionWindow: (componentId, timeProperties) => Promise<void>

パラメーター

componentId

string

スケジュールする必要があるJSバックグラウンドタスクのコンポーネントID。

timeProperties

ITimeProperties

EPG同期タスクに関連付ける時間プロパティ。

戻り値

Promise<void>

操作が正常に完了するとvoidに解決されるプロミス。

概要

指定された時間枠の制約を使用して、指定された定期的なEPG同期タスクの実行をスケジュールする関数。

詳細

この関数は、まずEPGタスクをすぐに実行するようにスケジュールします。次に、指定された開始時刻(UTC)と実行時間に基づき、EPG同期タスクが毎日実行されるようにスケジュールします。どの時点においても、スケジュールできるEPG同期タスクは1つだけです。最後に呼び出したEPG同期タスクメソッドが有効になり、再起動しても永続化されます。

スロー

同期タスクのスケジュール中にエラーが発生した場合、InternalErrorがスローされます。


Last updated: 2025年10月2日