名前付きタスク、永続的な登録、ステータスチェック、アンレジストリ、開発用トリガーを使用して、@capgo/capacitor-background-taskで定期的なバックグラウンドフェッチワークを実行します。

Schedule periodic background fetch work in a Capacitor app with named tasks, persistent registration, status checks, unregistering, and a development trigger. The plugin uses Android WorkManager and iOS BGTaskScheduler.

iOS設定

npm install @capgo/capacitor-background-task
npx cap sync

Androidと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

このプラグインが公開するもの

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

Capgoを使用している場合 @capgo/capacitor-background-task Capgoを使用してネイティブプラグインの作業を計画する場合、Capgoと接続します。 @capgo/capacitor-background-task Capgoの実装詳細については、@capgo/capacitor-background-task Getting Started Getting Startedの実装詳細については Capgo プラグインディレクトリ Capgo プラグインディレクトリの製品ワークフローについて Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and プラグインの追加または更新プラグインの追加または更新の実装詳細

バックグラウンドタスク