はじめに

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

インストール

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

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を使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の手順に従ってください。

bun add @capgo/capacitor-background-task
bunx 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>

次に実行します。

bunx 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を使用してネイティブ機能と接続する。 プラグインの開発を計画するには、nativeプラグインと接続する必要があります。 Using @capgo/capacitor-background-task Capacitorのネイティブ機能の使用のために@capgo/capacitor-バックグラウンドタスク Capgo プラグインディレクトリ for the product workflow in Capgo Plugin Directory, Capacitor プラグインは Capgo によって提供されます。 Capgoのプラグインの実装詳細については、Capacitor プラグインによって Capgo で実装されます。 プラグインの追加または更新 プラグインの実装詳細については、プラグインの追加または更新を参照してください。 Ionic エンタープライズ プラグインの代替 Ionic エンタープライズ プラグインの製品ワークフローについては、Ionic エンタープライズ プラグインの代替を参照してください。