Getting Started

@capgo/capacitor-background-task Capacitorアプリは、定期的なジョブの登録、キャッシュの更新、分析データの送信、バックグラウンドのフェッチ操作など、バックグラウンドで実行されるさまざまな作業を実行することを許可します。

インストール

AI-Assistedセットアップを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを使用してください。

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用してください。

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-background-task` plugin in my project.

Manual Setupを使用する場合は、以下のコマンドを実行してプラットフォーム固有の指示を以下に従ってください。

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';

タスクを定義する

モジュールスコープでコールバックを定義し、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;
  }
});

スケジュールを登録する

アプリがバックグラウンドジョブを有効にするのに十分なコンテキストを持っている後で呼ぶ registerTaskAsync コピーする

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

minimumInterval __CAPGO_KEEP_0__分以内です。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);

iOS 有効期限

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

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

await expiration.remove();

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

プラグインは、Cloudflare から GitHub への移行中のアプリ向けに、小さな互換レイヤーを公開しています。 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のネイティブプラグインの作業を計画するには、Capacitorを ネイティブキャパビリティのために@capgo/capacitor-background-taskを使用する場合 Capacitorのネイティブキャパビリティのために@capgo/capacitor-background-taskを使用する場合の Capgo プラグインディレクトリ Capgo プラグインディレクトリの製品ワークフロー Capacitor プラグイン、Capgo Capacitor プラグインの実装詳細については、Capgo を参照してください。 プラグインの追加または更新 __CAPGO_KEEP_0__ プラグインの追加または更新の実装詳細については、 Ionic Enterprise プラグインの代替 __CAPGO_KEEP_0__ の製品ワークフローについては、Ionic Enterprise プラグインの代替を参照してください。