ガイド
Capacitor でバックグラウンド タスクを使用する方法
@capgo/capacitor-background-taskを使用
Capacitorアプリで、名前付きタスク、永続的登録、ステータスチェック、アンレジストリング、開発用トリガーを使用して、定期的なバックグラウンドフェッチワークを設定します。プラグインはAndroid WorkManagerとiOS BGTaskSchedulerを使用します。
インストール
npm install @capgo/capacitor-background-task
npx cap sync
iOS設定
バックグラウンド処理のサポートを追加します。 ios/App/App/Info.plist:
<key>UIBackgroundModes</key>
<array>
<string>processing</string>
</array>
<key>BGTaskSchedulerPermittedIdentifiers</key>
<array>
<string>app.capgo.backgroundtask.processing</string>
</array>
次に実行してください:
npx cap sync ios
This Plugin Exposes
defineTask- 名前付きタスクのためのJavaScriptコールバックを定義します。registerTaskAsync- 期間を設定し、タスクを保存します。unregisterTaskAsync- 1 つのタスクをキャンセルします。isTaskRegisteredAsync- 1 つのタスクの登録状態を確認します。getRegisteredTasksAsync- 登録されたタスク名の一覧を表示します。getStatusAsync- ネイティブのバックグラウンドタスクの利用可能性を確認します。triggerTaskWorkerForTestingAsync- 開発用に登録されたタスクを即時実行します。addExpirationListener- iOS がタスクを期限切れにしたときに反応します。
例の使用方法
モジュールスコープでタスクを定義して、OSがアプリを起動するときに利用できるようにします:
import { BackgroundTask, BackgroundTaskResult } from '@capgo/capacitor-background-task';
const SYNC_TASK = 'sync-offline-data';
BackgroundTask.defineTask(SYNC_TASK, async () => {
try {
await fetch('https://api.example.com/sync', { method: 'POST' });
return BackgroundTaskResult.Success;
} catch {
return BackgroundTaskResult.Failed;
}
});
await BackgroundTask.registerTaskAsync(SYNC_TASK, {
minimumInterval: 30,
requiresNetwork: true,
});
ステータスと登録されたタスク名を確認します:
const status = await BackgroundTask.getStatusAsync();
const tasks = await BackgroundTask.getRegisteredTasksAsync();
console.log({ status, tasks });
開発用の実行をトリガーします:
await BackgroundTask.triggerTaskWorkerForTestingAsync();
タスクをキャンセルします:
await BackgroundTask.unregisterTaskAsync(SYNC_TASK);
プラットフォームに関する注意事項
- バックグラウンドタスクのスケジュールは、厳密なタイマーではなく、機会に応じて実行されます。
- Androidの周期的作業には、15分間隔の最小間隔があります。
- iOSは
minimumIntervalを最短の開始日として扱い、実行が遅れる可能性があります。 - iOSのバックグラウンド処理を物理デバイスでテストします。
フルリファレンス
- GitHub: https://github.com/Cap-go/capacitor-background-task/
- ドキュメント: /docs/plugins/background-task/
Using @capgo/capacitor-background-task
Capacitorを使用している場合 Using @capgo/capacitor-background-task native plugin work を計画するには、を接続する @capgo/capacitor-バックグラウンドタスク @capgo/capacitorバックグラウンドタスクの実装詳細 Getting Startedの実装詳細についてはGetting Startedを参照してください Capacitor プラグイン ディレクトリ Capgo プラグインディレクトリ for the product workflow in Capgo Plugin Directory, Capacitor Capgoのプラグイン Capacitor プラグインの実装詳細については、Capgo によって提供されるプラグインです。 Capacitor Capacitor