はじめに

@capgo/capacitor-background-task Capacitor アプリは、同期、キャッシュ更新、分析データの送信、他のバックグラウンドフェッチオペレーションなど、定期的なジョブの登録を許可します。

インストール

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

インポート

import { BackgroundTask, BackgroundTaskResult } from '@capgo/capacitor-background-task';

タスクを定義

モジュールスコープでコールバックを定義し、システムがアプリケーションを起動するとすぐに登録されるようにします。

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;
  }
});

スケジュールを登録

アプリケーションがバックグラウンドジョブを有効にするのに十分なコンテキストを持っている後、呼び出してください。 registerTaskAsync モジュールスコープでコールバックを定義し、システムがアプリケーションを起動するとすぐに登録されるようにします。

await BackgroundTask.registerTaskAsync(SYNC_TASK, {
  minimumInterval: 30,
  requiresNetwork: true,
});

minimumInterval は分数で表されます。Androidは15分以上の最小値を強制します。iOSは値を最早の開始日として扱い、実行が遅れる可能性があります。

ステータスを確認

const status = await BackgroundTask.getStatusAsync();
const isRegistered = await BackgroundTask.isTaskRegisteredAsync(SYNC_TASK);
const registeredTasks = await BackgroundTask.getRegisteredTasksAsync();

console.log({ status, isRegistered, registeredTasks });

テスト実行をトリガー

開発またはQAでテストトリガーを使用します。登録済みのタスクをすべて即座に呼び出します。

await BackgroundTask.triggerTaskWorkerForTestingAsync();

タスクを登録解除

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

__CAPGO_KEEP_0__

iOS は、JavaScript の実行が完了する前にバックグラウンドタスクを停止することができます。有効期限イベントをリスンすることで、クリーンアップやチェックポイントが必要な場合に備えてください。

const expiration = await BackgroundTask.addExpirationListener((event) => {
  console.warn('Background task expired', event.taskName, event.taskId);
});

await expiration.remove();

React Native バックグラウンドタスク互換性

コピー react-native-background-task.

import { BackgroundTask } from '@capgo/capacitor-background-task';

BackgroundTask.define(async () => {
  await fetch('https://api.example.com/sync', { method: 'POST' });
});

await BackgroundTask.schedule({
  period: 1800,
});

バックグラウンドスケジューリングは、厳密なタイムアウトではありません。

• Copy to clipboard
• React Native バックグラウンドタスク互換性
• __CAPGO_KEEP_0__を保存しておく BackgroundTaskResult.Success.
• __CAPGO_KEEP_0__に依存してください