@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.

インストール

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

iOS セットアップ

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/

Capacitorの@capgo/capacitor-background-taskを使用し続けてください。

Capacitorの@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-background-taskを使用している場合 Capacitorの@capgo/capacitor-background-taskを使用して、ネイティブプラグインの作業を計画し、Capacitorの@capgo/capacitor-background-taskと接続してください。 __CAPGO_KEEP_0__: https://capgo.com/Cap-go/capacitor-background-task/ @capgo/capacitor-バックグラウンドタスクの実装詳細について Getting Started @__CAPGO_KEEP_0__/Getting Startedの実装詳細について Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and プラグインの追加または更新プラグインの追加または更新の実装詳細について

バックグラウンドタスク