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

本文主要是介绍鸿蒙开发接口资源调度:【@ohos.backgroundTaskManager (后台任务管理)】,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

 后台任务管理

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

当应用或业务模块处于后台(无可见界面)时,如果有需要继续执行或者后续执行的业务,可基于业务类型,申请短时任务延迟挂起(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星河版开发学习文档》  

这篇关于鸿蒙开发接口资源调度:【@ohos.backgroundTaskManager (后台任务管理)】的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1028383

相关文章

Linux kill正在执行的后台任务 kill进程组使用详解

《Linuxkill正在执行的后台任务kill进程组使用详解》文章介绍了两个脚本的功能和区别,以及执行这些脚本时遇到的进程管理问题,通过查看进程树、使用`kill`命令和`lsof`命令,分析了子... 目录零. 用到的命令一. 待执行的脚本二. 执行含子进程的脚本,并kill2.1 进程查看2.2 遇到的

一文详解Python如何开发游戏

《一文详解Python如何开发游戏》Python是一种非常流行的编程语言,也可以用来开发游戏模组,:本文主要介绍Python如何开发游戏的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、python简介二、Python 开发 2D 游戏的优劣势优势缺点三、Python 开发 3D

Linux创建服务使用systemctl管理详解

《Linux创建服务使用systemctl管理详解》文章指导在Linux中创建systemd服务,设置文件权限为所有者读写、其他只读,重新加载配置,启动服务并检查状态,确保服务正常运行,关键步骤包括权... 目录创建服务 /usr/lib/systemd/system/设置服务文件权限:所有者读写js,其他

基于Python开发Windows自动更新控制工具

《基于Python开发Windows自动更新控制工具》在当今数字化时代,操作系统更新已成为计算机维护的重要组成部分,本文介绍一款基于Python和PyQt5的Windows自动更新控制工具,有需要的可... 目录设计原理与技术实现系统架构概述数学建模工具界面完整代码实现技术深度分析多层级控制理论服务层控制注

MySQL中C接口的实现

《MySQL中C接口的实现》本节内容介绍使用C/C++访问数据库,包括对数据库的增删查改操作,主要是学习一些接口的调用,具有一定的参考价值,感兴趣的可以了解一下... 目录准备mysql库使用mysql库编译文件官方API文档对象的创建和关闭链接数据库下达sql指令select语句前言:本节内容介绍使用C/

在Node.js中使用.env文件管理环境变量的全过程

《在Node.js中使用.env文件管理环境变量的全过程》Node.js应用程序通常依赖于环境变量来管理敏感信息或配置设置,.env文件已经成为一种流行的本地管理这些变量的方法,本文将探讨.env文件... 目录引言为什么使php用 .env 文件 ?如何在 Node.js 中使用 .env 文件最佳实践引

Java中的分布式系统开发基于 Zookeeper 与 Dubbo 的应用案例解析

《Java中的分布式系统开发基于Zookeeper与Dubbo的应用案例解析》本文将通过实际案例,带你走进基于Zookeeper与Dubbo的分布式系统开发,本文通过实例代码给大家介绍的非常详... 目录Java 中的分布式系统开发基于 Zookeeper 与 Dubbo 的应用案例一、分布式系统中的挑战二

python库pydantic数据验证和设置管理库的用途

《python库pydantic数据验证和设置管理库的用途》pydantic是一个用于数据验证和设置管理的Python库,它主要利用Python类型注解来定义数据模型的结构和验证规则,本文给大家介绍p... 目录主要特点和用途:Field数值验证参数总结pydantic 是一个让你能够 confidentl

基于Go语言开发一个 IP 归属地查询接口工具

《基于Go语言开发一个IP归属地查询接口工具》在日常开发中,IP地址归属地查询是一个常见需求,本文将带大家使用Go语言快速开发一个IP归属地查询接口服务,有需要的小伙伴可以了解下... 目录功能目标技术栈项目结构核心代码(main.go)使用方法扩展功能总结在日常开发中,IP 地址归属地查询是一个常见需求:

基于 Cursor 开发 Spring Boot 项目详细攻略

《基于Cursor开发SpringBoot项目详细攻略》Cursor是集成GPT4、Claude3.5等LLM的VSCode类AI编程工具,支持SpringBoot项目开发全流程,涵盖环境配... 目录cursor是什么?基于 Cursor 开发 Spring Boot 项目完整指南1. 环境准备2. 创建