跳过主要内容
返回插件
@capgo/capacitor-后台任务
教程
@capgo/capacitor-后台任务

后台任务

使用 Expo 风格的任务注册,定期在 iOS 和 Android 上调度后台抓取任务

指南

背景任务教程

在设备上测试

下载Capgo应用,扫描QRcode

背景任务插件预览二维码 code

使用 @capgo/capacitor-background-task

在具有命名任务、持久注册、状态检查、注销和开发触发器的 Capacitor 应用程序中,定期排程背景抓取工作。该插件使用 Android WorkManager 和 iOS BGTaskScheduler。

安装

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

此插件暴露的内容

  • defineTask - 为命名任务定义 JavaScript 回调。
  • registerTaskAsync - 持久和排程一个周期任务。
  • unregisterTaskAsync - 取消一个任务。
  • isTaskRegisteredAsync - 检查一个任务的注册状态。
  • getRegisteredTasksAsync - 已注册的任务名称列表。
  • getStatusAsync - 检查本地后台任务的可用性。
  • triggerTaskWorkerForTestingAsync - 在开发环境下,立即触发已注册的任务。
  • addExpirationListener - 当 iOS 过期一个任务时,会触发此事件。

- 示例用法

- 在模块范围内定义任务,使其在系统唤醒应用时可用:

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

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

- 检查状态和已注册的任务名称:

const status = await BackgroundTask.getStatusAsync();
const tasks = await BackgroundTask.getRegisteredTasksAsync();

console.log({ status, tasks });

- 运行开发环境:

await BackgroundTask.triggerTaskWorkerForTestingAsync();

- 取消任务:

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

- 平台说明

  • - 后台任务的调度是机会性的,而不是精确的定时器。
  • - Android 的周期性工作有 15 分钟的最小间隔。
  • iOS被视为 minimumInterval 的最早开始日期,并可能稍后运行。
  • 在物理设备上测试iOS背景处理。

完整参考

继续使用@capgo/capacitor-background-task

如果您正在使用 使用@capgo/capacitor-background-task 规划原生插件工作,连接它到 @capgo/capacitor-background-task 为 @capgo/capacitor-background-task 的实现细节, 开始使用 为 Getting Started 的实现细节, Capgo 插件目录 为 Capgo 插件目录中的产品工作流, Capacitor 由 Capgo 提供的插件 为 Capacitor 插件由 Capgo 提供的实现细节,并且 添加或更新插件 为添加或更新插件的实现细节。