开始

@capgo/capacitor-background-task 允许一个 Capacitor 应用程序注册周期性任务、缓存刷新、分析数据传递和其他后台抓取操作。

安装

您可以使用我们的AI辅助设置来安装插件。将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.

如果您prefer手动设置，安装插件并运行以下命令，遵循以下平台特定的说明:

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

注册调度

Call registerTaskAsync 在应用程序有足够的上下文后，启用后台作业。

await BackgroundTask.registerTaskAsync(SYNC_TASK, {
  minimumInterval: 30,
  requiresNetwork: true,
});

minimumInterval 时间单位为分钟。Android强制执行最小15分钟。iOS将值视为最早开始日期，并可能稍后运行。

Check Status

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后台任务兼容性

该插件还暴露了从 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 来规划原生插件工作，连接它与 使用 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-background-task 来实现在使用 @capgo/capacitor-background-task 中的原生能力 for the native capability in Using @capgo/capacitor-background-task, Capgo 插件目录 为产品工作流程在 Capgo 插件目录中 Capacitor 由 Capgo 提供的插件 为实现细节在 Capacitor 由 Capgo 提供的插件中 添加或更新插件 为实现细节在添加或更新插件中，并 Ionic 企业插件替代品 为产品工作流程在 Ionic 企业插件替代品中