Getting Started

@capgo/capacitor-background-task lets a Capacitor app register named periodic jobs for sync, cache refreshes, analytics delivery, and other background fetch operations.

Ready to paste

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 Setup

バックグラウンド処理モードと許可されたタスク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';

タスクを定義する

モジュールスコープでコールバックを定義する必要があります。これにより、オペレーティングシステムによってアプリケーションが起動されたときにすぐに登録されます。

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

スケジュールを登録する

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

本番環境の注意点

• バックグラウンドのスケジュールは、厳密ではありません。
• 作業を短くし、再帰的であることを保証します。
• __CAPGO_KEEP_0__で必要なすべての状態を永続化する BackgroundTaskResult.Success.
• ユーザーに表示される期限やアラームに依存してはなりません。

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

「Getting Started」を使用している場合 「Getting Started」 ネイティブ プラグインの作業を計画する場合、__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-background-taskを使用して接続します。 capgo/capacitor-background-taskを使用してネイティブの機能を接続します。 「@capgo/capacitor-background-task」を使用します。 Capgo プラグイン ディレクトリ Capgo プラグイン ディレクトリの製品ワークフローについて Capacitor プラグイン (Capgo によって提供) Capacitor プラグイン (Capgo によって提供)の実装詳細について プラグインの追加または更新 プラグインの追加または更新の実装詳細について、 Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフローについて