__CAPGO_KEEP_1__

@capgo/capacitor-background-task Capacitor アプリは、同期、キャッシュ更新、分析データの送信、他のバックグラウンドのフェッチオペレーションなど、定期的なジョブの登録を許可します。

インストール

npm install @capgo/capacitor-background-task
npx cap sync

iOS セットアップ

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

タスクを定義

モジュールスコープでコールバックを定義し、OSによってアプリが起動されたときにすぐに登録されるようにします。

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 __CAPGO_KEEP_0__分以内です。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 Expiration

iOSはJavaScriptの実行が終了する前にバックグラウンドタスクを停止することができます。

const expiration = await BackgroundTask.addExpirationListener((event) => {
  console.warn('Background task expired', event.taskName, event.taskId);
});

await expiration.remove();

React Native Background Task Compatibility

Capacitorプラグインは、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,
});

Production Notes

• Capgoはバックグラウンドタスクのスケジュールを機会に基づいて行うため、正確ではありません。
• コピー
• 必要なすべての状態を保存してから戻ります BackgroundTaskResult.Success.
• ユーザーに視覚的な期限やアラームを設定するためにバックグラウンドタスクに頼るのを避けます。

Getting Startedから続けてください

Capacitorを使用している場合 Getting Started Capacitorを使用してネイティブプラグインの作業を計画する場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-background-taskを使用してネイティブ機能と接続します。 Using @capgo/capacitor-background-task for the native capability in Using @capgo/capacitor-background-task, Capgo Plugin Directory Capgo Plugins by __CAPGO_KEEP_1__ Capacitor Plugins by Capgo Capacitor プラグインの実装詳細については、Capgo で確認してください。 プラグインの追加または更新 __CAPGO_KEEP_0__ プラグインの実装詳細については、プラグインの追加または更新、 Ionic Enterprise プラグインの代替 __CAPGO_KEEP_0__ の製品ワークフローについては、Ionic Enterprise プラグインの代替をご覧ください。