メインコンテンツへスキップ

@capgo/capacitor-background-task

iOSおよびAndroidでの定期的なバックグラウンドフェッチタスク。

モジュールスコープのタスクを定義し、間隔をスケジュールして、同期とキャッシュウォームアップ用にOSが理解できる結果を返します。

プラットフォームサポート備考
iOSとはいInfo.plist の BGTaskScheduler identifier
AndroidでははいWorkManager スタイルのジョブ
WebいいえService Worker を使用
  • defineTask - 名前付きタスクの JavaScript コールバックを登録します。
  • registerTaskAsync - 定期タスクを永続化してスケジュールします。
  • unregisterTaskAsync - 1 つのタスクの将来の実行をキャンセルします。
  • isTaskRegisteredAsync - タスクが登録されているか確認します。
  • getRegisteredTasksAsync - 現在登録されているタスク名の一覧を取得します。
  • getPendingTaskRunsAsync - JavaScript が準備完了になる前に記録されたネイティブタスクイベントを調査します。
  • getStatusAsync - ネイティブバックグラウンドタスクの可用性を確認します。
  • triggerTaskWorkerForTestingAsync - 開発中に登録されたタスクを即座に実行します。
  • addExpirationListener - iOS の期限切れコールバックを処理します。
  • define, schedule, cancel, statusAsyncや finish - 互換性ヘルパー react-native-background-task.

バックグラウンドタスクは正確なタイマーではありません。Android と iOS は、バッテリー、ネットワーク、アプリの使用状況、システムポリシーに基づいて、スケジュールされたタスクの実行タイミングを決定します。

プラットフォームネイティブスケジューラー重要な動作
AndroidではWorkManager定期タスクの最小間隔は 15 分です。
iOSとBGTaskSchedulerminimumInterval は、保証された頻度ではなく、開始可能な最も早い日付です。
Webテスト用のフォールバック実際のバックグラウンドスケジューラは利用できません。
メソッド説明
defineTask名前付きタスクの JavaScript コールバックを定義します。
registerTaskAsync名前付きの定期バックグラウンドタスクを登録します。
unregisterTaskAsync今後のタスク実行をキャンセルします。
isTaskRegisteredAsyncタスクが登録されているかどうかを返します。
getRegisteredTasksAsync登録済みのタスク名を一覧表示します。
getPendingTaskRunsAsync完了待ちのネイティブタスクイベントを一覧表示します。
getStatusAsyncネイティブのバックグラウンドスケジューリングが利用可能か返します。
triggerTaskWorkerForTestingAsync開発とQA用に登録済みタスクをトリガーします。
addExpirationListeneriOSの期限切れイベントをリッスンします。

このリファレンスは以下から同期されています: src/definitions.ts における capacitor-background-task.

使用している場合 @capgo/capacitor-background-task ネイティブプラグインの作業を計画するには、次と連携してください: @capgo/capacitor-background-task の使い方 「Using @capgo/capacitor-background-task」のネイティブ機能については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新における実装詳細については、および Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案におけるプロダクトワークフローについては。