__CAPGO_KEEP_0__

@capgo/capacitor-background-task Capacitorアプリが、同期、キャッシュ更新、分析データの送信、背景のフェッチオペレーションなど、定期的なジョブの登録を許可する。

インストール

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

iOS設定

背景処理モードと許可されたタスクIDを追加し、 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';

タスクを定義する

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

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 ステータスを確認

ステータスを確認

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

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

ステータスを確認

クリップボードにコピー

await BackgroundTask.triggerTaskWorkerForTestingAsync();

__CAPGO_KEEP_0__

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

iOSの有効期限

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

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

await expiration.remove();

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

プラグインは、Capacitorから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,
});

実稼働に関する注意

• バックグラウンド スケジュールは、厳密ではありません。
• 作業を短くし、idempotent にしてください。
• __CAPGO_KEEP_0__ が必要な場合にのみ、状態を永続化してください。 BackgroundTaskResult.Success.
• ユーザーに表示される期限やアラームに依存してはなりません。

Getting Started から続けてください。

Capacitor を使用している場合、 Getting Started から続けてください。 Capacitor のプラグインディレクトリを使用して、 Using @capgo/capacitor-background-task for the native capability in Using @capgo/capacitor-background-task, Capgo Plugin Directory 製品ワークフローについての説明は、Capgo プラグインディレクトリで行います。 Capacitor プラグインは、Capgo によって提供されています。 実装の詳細については、Capacitor プラグインの Capgo を参照してください。 プラグインの追加または更新 実装の詳細については、プラグインの追加または更新を参照してください。 Ionic Enterprise プラグインの代替 製品ワークフローについての説明は、Ionic Enterprise プラグインの代替で行います。