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に移行しているアプリ向けに、小さな互換レイヤーを公開しています。 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」を使用してネイティブプラグインの作業を計画している場合、以下のステップに進んでください。 「Getting Started」を使用してネイティブプラグインの作業を計画している場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-background-taskを使用してネイティブの機能と接続してください。 「Getting Started」を使用してネイティブプラグインの作業を計画している場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-background-taskを使用してネイティブの機能と接続してください。 「Getting Started」を使用してネイティブプラグインの作業を計画している場合、@capgo/capacitor-background-taskを使用してネイティブの機能と接続してください。 「Getting Started」を使用してネイティブプラグインの作業を計画している場合、@capgo/capacitor-background-taskを使用してネイティブの機能と接続してください。 Capgo プラグイン ディレクトリ Capgo製品ワークフロー向けに Capgo プラグイン ディレクトリ Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, プラグインの追加または更新 Capgo製品ワークフロー向けにプラグインの追加または更新、 イオニック エンタープライズ プラグインの代替 Capgo製品ワークフロー向けにイオニック エンタープライズ プラグインの代替