使用 @capgo/capacitor-background-task
在具有命名任务、持久注册、状态检查、注销和开发触发器的 Capacitor 应用中定期执行背景 fetch 工作。该插件使用 Android WorkManager 和 iOS BGTaskScheduler。
安装
npm install @capgo/capacitor-background-task
npx cap sync
iOS 设置
向 __CAPGO_KEEP_0__ 添加背景处理支持 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 过期任务时进行反应。
- 示例用法
- 在模块范围内定义任务，使其在 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;
}
});
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背景处理。
完整参考
- GitHub: https://github.com/Cap-go/capacitor-background-task/
- 文档：/docs/plugins/background-task/
继续使用@capgo/capacitor-background-task
如果您正在使用 使用@capgo/capacitor-background-task 计划本地插件工作，连接它 @capgo/capacitor-background-task 查看@capgo/capacitor-background-task的实现细节 开始使用 查看开始使用的实现细节 Capgo 插件目录 了解Capgo 插件目录中的产品工作流程 Capacitor 由Capgo 提供的插件 查看Capacitor 由Capgo 提供的插件的实现细节 添加或更新插件 查看添加或更新插件的实现细节