当前位置： 首页 > news >正文

鸿蒙开发接口资源调度：【@ohos.backgroundTaskManager (后台任务管理)】

news 来源：原创 2024/9/29 10:25:26

 后台任务管理

本模块提供后台任务管理能力。

当应用或业务模块处于后台（无可见界面）时，如果有需要继续执行或者后续执行的业务，可基于业务类型，申请短时任务延迟挂起（Suspend）或者长时任务避免进入挂起状态。

应用有不可中断且短时间能完成的任务时（如，用户在文件管理器上点击垃圾文件清理，若清理未完成时退到后台，文件管理器需要申请短时任务完成清理），可以使用短时任务机制。

应用中存在用户能够直观感受到的且需要一直在后台运行的业务时（如，后台播放音乐），可以使用长时任务机制。

icon-note.gif

  说明：  本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 开发前请熟悉鸿蒙开发指导文档： gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md点击或者复制转到。

导入模块

import backgroundTaskManager from '@ohos.backgroundTaskManager';

backgroundTaskManager.requestSuspendDelay

requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspendInfo

后台应用申请延迟挂起。

延迟挂起时间一般情况下默认值为180000，低电量（依据系统低电量广播）时默认值为60000。

系统能力:  SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

参数：

参数名类型必填说明
reasonstring是延迟挂起申请的原因。
callbackCallback<void>是延迟即将超时的回调函数，一般在超时前6秒通过此回调通知应用。

返回值：

类型说明
[DelaySuspendInfo]返回延迟挂起信息。

示例：

let myReason = 'test requestSuspendDelay';
let delayInfo = backgroundTaskManager.requestSuspendDelay(myReason, () => {console.info("Request suspension delay will time out.");
})var id = delayInfo.requestId;
var time = delayInfo.actualDelayTime;
console.info("The requestId is: " + id);
console.info("The actualDelayTime is: " + time);

backgroundTaskManager.getRemainingDelayTime

getRemainingDelayTime(requestId: number, callback: AsyncCallback<number>): void

获取应用程序进入挂起状态前的剩余时间，使用callback形式返回。

系统能力:  SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

参数：

参数名类型必填说明
requestIdnumber是延迟挂起的请求ID。
callbackAsyncCallback<number>是指定的callback回调方法。用于返回应用程序进入挂起状态之前的剩余时间，以毫秒为单位。

示例：

let id = 1;
backgroundTaskManager.getRemainingDelayTime(id, (err, res) => {if(err) {console.log('callback => Operation getRemainingDelayTime failed. Cause: ' + err.code);} else {console.log('callback => Operation getRemainingDelayTime succeeded. Data: ' + JSON.stringify(res));}
})

backgroundTaskManager.getRemainingDelayTime

getRemainingDelayTime(requestId: number): Promise<number>

获取应用程序进入挂起状态前的剩余时间，使用Promise形式返回。

系统能力:  SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

参数：

参数名类型必填说明
requestIdnumber是延迟挂起的请求ID。

返回值：

类型说明
Promise<number>指定的Promise回调方法。返回应用程序进入挂起状态之前的剩余时间，以毫秒为单位。

示例：

let id = 1;
backgroundTaskManager.getRemainingDelayTime(id).then( res => {console.log('promise => Operation getRemainingDelayTime succeeded. Data: ' + JSON.stringify(res));
}).catch( err => {console.log('promise => Operation getRemainingDelayTime failed. Cause: ' + err.code);
})

backgroundTaskManager.cancelSuspendDelay

cancelSuspendDelay(requestId: number): void

取消延迟挂起。

系统能力:  SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

参数：

参数名类型必填说明
requestIdnumber是延迟挂起的请求ID。

示例：

let id = 1;
backgroundTaskManager.cancelSuspendDelay(id);

backgroundTaskManager.startBackgroundRunning8+

startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent, callback: AsyncCallback<void>): void

向系统申请长时任务，使用callback形式返回结果。

需要权限:  ohos.permission.KEEP_BACKGROUND_RUNNING

系统能力:  SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

参数：

参数名类型必填说明
context[Context]是应用运行的上下文。
bgMode[BackgroundMode]是向系统申请的后台模式。
wantAgent[WantAgent]是通知参数，用于指定长时任务通知点击后跳转的界面。
callbackAsyncCallback<void>是callback形式返回启动长时任务的结果。

示例：

import backgroundTaskManager from '@ohos.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility';
import wantAgent from '@ohos.wantAgent';function callback(err, data) {if (err) {console.error("Operation startBackgroundRunning failed Cause: " + err);} else {console.info("Operation startBackgroundRunning succeeded");}
}let wantAgentInfo = {wants: [{bundleName: "com.example.myapplication",abilityName: "com.example.myapplication.MainAbility"}],operationType: wantAgent.OperationType.START_ABILITY,requestCode: 0,wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
};wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {backgroundTaskManager.startBackgroundRunning(featureAbility.getContext(),backgroundTaskManager.BackgroundMode.DATA_TRANSFER, wantAgentObj, callback)
});

backgroundTaskManager.startBackgroundRunning8+

startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise<void>

向系统申请长时任务，使用promise形式返回结果。

需要权限:  ohos.permission.KEEP_BACKGROUND_RUNNING

系统能力:  SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

参数：

参数名类型必填说明
context[Context]是应用运行的上下文。
bgMode[BackgroundMode]是向系统申请的后台模式。
wantAgent[WantAgent]是通知参数，用于指定长时任务通知点击跳转的界面。

返回值

类型说明
Promise<void>使用Promise形式返回结果。

示例：

import backgroundTaskManager from '@ohos.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility';
import wantAgent from '@ohos.wantAgent';let wantAgentInfo = {wants: [{bundleName: "com.example.myapplication",abilityName: "com.example.myapplication.MainAbility"}],operationType: wantAgent.OperationType.START_ABILITY,requestCode: 0,wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
};wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {backgroundTaskManager.startBackgroundRunning(featureAbility.getContext(),backgroundTaskManager.BackgroundMode.DATA_TRANSFER, wantAgentObj).then(() => {console.info("Operation startBackgroundRunning succeeded");}).catch((err) => {console.error("Operation startBackgroundRunning failed Cause: " + err);});
});

backgroundTaskManager.stopBackgroundRunning8+

stopBackgroundRunning(context: Context, callback: AsyncCallback<void>): void

向系统申请取消长时任务，使用callback形式返回结果。

系统能力:  SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

参数：

参数名类型必填说明
context[Context]是应用运行的上下文。
callbackAsyncCallback<void>是callback形式返回启动长时任务的结果。

示例：

import backgroundTaskManager from '@ohos.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility';function callback(err, data) {if (err) {console.error("Operation stopBackgroundRunning failed Cause: " + err);} else {console.info("Operation stopBackgroundRunning succeeded");}
}

backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext(), callback);

backgroundTaskManager.stopBackgroundRunning8+

stopBackgroundRunning(context: Context): Promise<void>

向系统申请取消长时任务，使用promise形式返回结果。

系统能力:  SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

参数：

参数名类型必填说明
context[Context]是应用运行的上下文。

返回值

类型说明
Promise<void>使用Promise形式返回结果。

示例：

import backgroundTaskManager from '@ohos.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility';backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(() => {console.info("Operation stopBackgroundRunning succeeded");
}).catch((err) => {console.error("Operation stopBackgroundRunning failed Cause: " + err);
});

DelaySuspendInfo

延迟挂起信息。

系统能力:  以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

参数名类型必填说明
requestIdnumber是延迟挂起的请求ID。
actualDelayTimenumber是应用的实际挂起延迟时间，以毫秒为单位。 一般情况下默认值为180000，低电量（依据系统低电量广播）时默认值为60000。

BackgroundMode8+

系统能力:  以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

搜狗高速浏览器截图20240326151450.png

参数名参数值描述 HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿
DATA_TRANSFER1数据传输
AUDIO_PLAYBACK2音频播放
AUDIO_RECORDING3录音
LOCATION4定位导航
BLUETOOTH_INTERACTION5蓝牙相关
MULTI_DEVICE_CONNECTION6多设备互联
WIFI_INTERACTION7WLAN相关 系统API：此接口为系统接口，三方应用不支持调用。
VOIP8音视频通话 系统API：此接口为系统接口，三方应用不支持调用。
TASK_KEEPING9计算任务（仅在特定设备生效）

鸿蒙Next核心技术分享

1、鸿蒙基础知识←《鸿蒙NEXT星河版开发学习文档》

2、鸿蒙ArkUI←《鸿蒙NEXT星河版开发学习文档》

3、鸿蒙进阶技术←《鸿蒙NEXT星河版开发学习文档》

 4、鸿蒙就业高级技能←《鸿蒙NEXT星河版开发学习文档》 

 5、鸿蒙多媒体技术←《鸿蒙NEXT星河版开发学习文档》 

6、鸿蒙南向驱动开发←《鸿蒙NEXT星河版开发学习文档》  

7、鸿蒙南向内核设备开发←《鸿蒙NEXT星河版开发学习文档》  

 8、鸿蒙系统裁剪与移植←《鸿蒙NEXT星河版开发学习文档》  

相关文章：

  • uni微信小程序editor富文本组件如何插入图片
  • Linux离线一键安装Docker及docker-compose环境
  • Double Add
  • linux中最基础使用的命令
  • iOS AVFoundation 音视频源码分享
  • LNMP 环境下使用 Zstd 压缩优化网站备份脚本
  • 【机器学习】机器学习与大模型在人工智能领域的融合应用与性能优化新探索
  • PostgreSQL设置自增主键
  • 【动手学深度学习】softmax回归从零开始实现的研究详情
  • 简历–自我介绍–中文–个人–结婚祝语
  • element-plus关于表单数据自定义参数校验
  • 深入了解Linux命令：zcat
  • postman教程-10-使用cookie
  • 快速了解Https通信原理
  • python第五次作业
  • 【编码】-360实习笔试编程题（二）-2016.03.29
  • canvas 绘制双线技巧
  • Laravel Telescope：优雅的应用调试工具
  • Linux gpio口使用方法
  • react 代码优化(一) ——事件处理
  • 理解 C# 泛型接口中的协变与逆变（抗变）
  • 使用SAX解析XML
  • 双管齐下，VMware的容器新战略
  • 微服务入门【系列视频课程】
  • 在 Chrome DevTools 中调试 JavaScript 入门
  • 深度学习之轻量级神经网络在TWS蓝牙音频处理器上的部署
  • PostgreSQL之连接数修改
  • #include到底该写在哪
  • #中的引用型是什么意识_Java中四种引用有什么区别以及应用场景
  • $.ajax()参数及用法
  • （1）(1.13) SiK无线电高级配置（六）
  • （51单片机）第五章-A/D和D/A工作原理-A/D
  • (done) 声音信号处理基础知识(2) （重点知识：pitch）(Sound Waveforms)
  • （Matalb分类预测）GA-BP遗传算法优化BP神经网络的多维分类预测
  • （第8天）保姆级 PL/SQL Developer 安装与配置
  • （附源码）spring boot公选课在线选课系统 毕业设计 142011
  • （附源码）springboot社区居家养老互助服务管理平台 毕业设计 062027
  • (三)uboot源码分析
  • (数位dp) 算法竞赛入门到进阶 书本题集
  • (译) 理解 Elixir 中的宏 Macro, 第四部分：深入化
  • （原创）可支持最大高度的NestedScrollView
  • (转)如何上传第三方jar包至Maven私服让maven项目可以使用第三方jar包
  • (自用)交互协议设计——protobuf序列化
  • ****** 二十三 ******、软设笔记【数据库】-数据操作-常用关系操作、关系运算
  • **CI中自动类加载的用法总结
  • *2 echo、printf、mkdir命令的应用
  • .NET 某和OA办公系统全局绕过漏洞分析
  • .NET/C# 判断某个类是否是泛型类型或泛型接口的子类型
  • .NET/C# 使窗口永不激活（No Activate 永不获得焦点）
  • .NET3.5下用Lambda简化跨线程访问窗体控件,避免繁复的delegate,Invoke(转)
  • .netcore 如何获取系统中所有session_如何把百度推广中获取的线索（基木鱼，电话，百度商桥等）同步到企业微信或者企业CRM等企业营销系统中...
  • .net经典笔试题
  • .net快速开发框架源码分享
  • .net生成的类，跨工程调用显示注释
  • .NET之C#编程：懒汉模式的终结，单例模式的正确打开方式