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

製品ノート

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

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

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