@ capgo/ 电容器- 后地任务

在 iOS 和 Android 上运行您的 Capacitor app 中定期的背景任务, 并带有在 app 重新启动中幸存的命名任务 。 在应用程序未打开时同步数据或刷新内容 .

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-background-task 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 加入@capgo/capor-background-task 到我的Capacitor app,并把它连接起来。" 代理设置指南 • 妇女 主机磁共振

主要特点

• 命名任务数字 : registerTaskAsync() 财务报告和审定财务报表 unregisterTaskAsync() 选项 minimumInterval 财务报告和审定财务报表 requiresNetwork。 。 。 .
• 状态数字 : isTaskRegisteredAsync(), (中文(简体) ), getRegisteredTasksAsync() 财务报告和审定财务报表 getStatusAsync() 报告已安排和可用的情况.
• 运行失败数字 : getPendingTaskRunsAsync() 返回在 JavaScript 准备好之前在本地记录.
• 测试数字 : triggerTaskWorkerForTestingAsync() 在开发过程中立即运行所有已登记的任务.
• 熟悉的 API: 博览会背景 任务样式 API + React 原生背景任务兼容 schedule(), (中文(简体) ), cancel() 财务报告和审定财务报表 finish()。 。 。 .
• 平台: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-22. iOS使用"背景任务",Android使用"WorkManager". Web是根茎.

它会做什么

• 与 WorkManager 定期安排关于Android的背景工作.
• 用 BGTaskScheduler 来排程 iOS 上的背景处理 .
• 支持多个命名任务 minimumInterval 几分钟后.
• Emits 保留任务事件, 因此任务运行在 JavaScript 准备好之前可以被排出 .
• 提供小型 react-native-background-task 相容的 API : define, (中文(简体) ), schedule, (中文(简体) ), cancel, (中文(简体) ), statusAsync,以及 finish。 。 。 .

限制

• 背景任务不是精确的定时器 。 Android和iOS决定工作实际运行时间.
• Android执行15分最小间隔.
• iOS可能基于电池,网络和用户行为进行大量延迟运行.
• iOS背景任务不运行于模拟器;使用物理设备.
• 此插件无法在背景中无限期运行应用程序 .

兼容性

政策:

• 新的插件从版本开始 8.0.0 (8号电站基线).
• 对更古老的Capacitor主机的后向相容性按需支持.

安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-background-task` plugin in my project.

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

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>

使用量

定义模块范围的任务,以便在操作系统启动应用程序后立即提供.

import { BackgroundTask, BackgroundTaskResult } from '@capgo/capacitor-background-task';

const SYNC_TASK = 'sync-offline-data';

BackgroundTask.defineTask(SYNC_TASK, async () => {
  try {
    await fetch('https://example.com/sync', { method: 'POST' });
    return BackgroundTaskResult.Success;
  } catch {
    return BackgroundTaskResult.Failed;
  }
});

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

测试

await BackgroundTask.triggerTaskWorkerForTestingAsync();

反应本地兼容性

import { BackgroundTask } from '@capgo/capacitor-background-task';

BackgroundTask.define(async () => {
  await fetch('https://example.com/sync', { method: 'POST' });
});

await BackgroundTask.schedule({
  period: 1800,
});

示例应用

这个 example-app/ 文件夹通过 file:.. 用于验证开发期间的本地接线.

API 密码

• defineTask(...)
• registerTaskAsync(...)
• unregisterTaskAsync(...)
• isTaskRegisteredAsync(...)
• getRegisteredTasksAsync()
• getPendingTaskRunsAsync()
• getStatusAsync()
• triggerTaskWorkerForTestingAsync()
• addExpirationListener(...)
• define(...)
• schedule(...)
• cancel()
• statusAsync()
• finish(...)
• 接口
• 类型异名
• 数字

定义任务(...)

defineTask(taskName: string, callback: BackgroundTaskCallback) => void

定义 JavaScript 回调任务 。 将此调用到模块/ 全球范围 .

注册任务Async(...)

registerTaskAsync(taskName: string, options?: BackgroundTaskOptions | undefined) => Promise<void>

注册一个命名的定期背景任务 .

未注册的任务Async (...)

unregisterTaskAsync(taskName: string) => Promise<void>

取消一个命名的周期性背景任务 .

是任务注册的 Async (...)

isTaskRegisteredAsync(taskName: string) => Promise<boolean>

检查是否注册了命名的任务 .

回返情况: Promise<boolean>

获得注册的任务Async ()

getRegisteredTasksAsync() => Promise<string[]>

返回所有已注册的任务名称 .

回返情况: Promise<string[]>

获取“ 指定任务” Async ()

getPendingTaskRunsAsync() => Promise<BackgroundTaskEvent[]>

返回未完成的任务运行在 JavaScript 准备好之前的本地记录 .

回返情况: Promise<BackgroundTaskEvent[]>

获取状态

getStatusAsync() => Promise<BackgroundTaskStatus>

返回本地背景任务可用性 .

回返情况: Promise<BackgroundTaskStatus>

触发工作任务测试

triggerTaskWorkerForTestingAsync() => Promise<boolean>

立即触发所有已登记的任务进行开发/测试.

回返情况: Promise<boolean>

添加扩展倾听器(...)

addExpirationListener(listener: (event: BackgroundTaskEvent) => void) => Promise<PluginListenerHandle>

听iOS过期回调.

回返情况: Promise<PluginListenerHandle>

定义(...)

define(callback: BackgroundTaskCallback) => void

React 原生背景任务相容的单任务定义助手.

调度(...)

schedule(options?: ReactNativeBackgroundTaskOptions | undefined) => Promise<void>

反应本地背景任务相容的单任务调度器 .

取消( )

cancel() => Promise<void>

React 原生背景任务相容的单任务取消帮助器.

状态 Async ()

statusAsync() => Promise<ReactNativeBackgroundTaskStatus>

反应本地背景任务相容状态助手 .

回返情况: Promise<ReactNativeBackgroundTaskStatus>

结束(...)

finish(result?: BackgroundTaskResult | undefined) => Promise<void>

反应本地背景任务相容的完成帮助器 。 普通博览会风格 调用自动完成 .

接口

背景任务活动

当本地调度要求 JavaScript 执行任务时, 有效载荷已释放 .

背景任务选项

定期登记背景任务的选项.

插件听筒

反活动背景任务选项

反应本地背景任务兼容调度选项 .

ReactNativeBackground 任务状态

反应原生背景任务相容状态有效载荷.

类型异名

背景任务调用

为背景任务执行的函数 .

(event: BackgroundTaskEvent): void | BackgroundTaskResult | Promise<void | BackgroundTaskResult>

数字

背景任务结果

背景任务状态