Getting Started

@capgo/capacitor-background-task アプリケーションがCapacitorで定期的なジョブを登録できるようにします。ジョブには同期、キャッシュの更新、分析データの送信、背景のフェッチなどが含まれます。

インストール

CapgoのAI-Assisted Setupを使用してプラグインをインストールできます。次のコマンドを使用して、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';

タスクを定義

モジュールスコープでコールバックを定義してください。アプリケーションがオペレーティングシステムによって開始されたときにすぐに登録されます。

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

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-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に保ちましょう。
• 必要な状態を保存する前に戻りましょう。 BackgroundTaskResult.Success.
• ユーザーに表示される期限やアラームに依存してはなりません。

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

あなたが使用している場合 「Getting Started」 を使用してネイティブプラグインの作業を計画する場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-background-task を使用してネイティブの機能を@capgo/capacitor-background-task for the native capability in Using @capgo/capacitor-background-task, Capgo プラグインディレクトリ Capgo製品ワークフロー向けに Capgo プラグインディレクトリ Capacitor Capgo によって提供されるプラグイン Capgo製品ワークフロー向けに Capacitor Capgo によって提供されるプラグイン プラグインの追加または更新 プラグインの追加または更新の実装詳細については、 イオニック エンタープライズ プラグインの代替 イオニック エンタープライズ プラグインの代替の製品ワークフロー