Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
a0cbf986
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
a0cbf986
编写于
3月 10, 2022
作者:
O
openharmony_ci
提交者:
Gitee
3月 10, 2022
浏览文件
操作
浏览文件
下载
差异文件
!1889 修改后台任务管理文档说明
Merge pull request !1889 from 张鑫/master
上级
caa477ce
702cd284
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
39 addition
and
25 deletion
+39
-25
zh-cn/application-dev/background-task-management/background-task-dev-guide.md
...v/background-task-management/background-task-dev-guide.md
+2
-2
zh-cn/application-dev/background-task-management/background-task-overview.md
...ev/background-task-management/background-task-overview.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md
...ation-dev/reference/apis/js-apis-backgroundTaskManager.md
+35
-21
未找到文件。
zh-cn/application-dev/background-task-management/background-task-dev-guide.md
浏览文件 @
a0cbf986
...
...
@@ -13,7 +13,7 @@ import backgroundTaskManager from '@ohos.backgroundTaskManager';
## 短时任务
**表1**
backgroundTaskManager
主要接口
**表1**
短时任务
主要接口
| 接口名 | 描述 |
| -------- | -------- |
...
...
@@ -106,7 +106,7 @@ ohos.permission.KEEP_BACKGROUND_RUNNING
| function stopBackgroundRunning(context: Context, callback: AsyncCallback
<
void
>
): void;
<br/>
function stopBackgroundRunning(context: Context): Promise
<
void
>
; | 停止后台长时任务的运行 |
其中,wantAgent的信息详见(
[
WantAgent
](
#zh-cn/application-dev/reference/apis/js-apis-notification.md#WantAgent接口
)
)
其中,wantAgent的信息详见(
[
WantAgent
](
../reference/apis/js-apis-notification.md#WantAgent接口
)
**表4**
后台模式类型
...
...
zh-cn/application-dev/background-task-management/background-task-overview.md
浏览文件 @
a0cbf986
...
...
@@ -57,6 +57,6 @@ OpenHarmony提供了九种后台模式,供需要在后台做长时任务的业
### 长时任务使用约束
-
如果用户选择可感知业务(如播音、导航、上传下载等),触发对应后台模式,在任务启动时,系统会强制弹出通知提醒用户。
-
如果任务结束,应用应主动退出后台模式。若在后台运行期间,系统检测到应用并未使用对应后台模式的资源,则会被挂起(Suspend)。
-
避免不合理地申请后台长时任务,长时任务类型要与应用的业务类型匹配。如
表1所示。如
果执行的任务和申请的类型不匹配,也会被系统检测到并被挂起(Suspend)。
-
避免不合理地申请后台长时任务,长时任务类型要与应用的业务类型匹配。如果执行的任务和申请的类型不匹配,也会被系统检测到并被挂起(Suspend)。
-
长时任务是为了真正在后台长时间执行某个任务,如果一个应用申请了长时任务,但在实际运行过程中,并未真正运行或执行此类任务时,也会被系统检测到并被挂起(Suspend)。
-
每个Ability同一时刻只能申请运行一个长时任务。
\ No newline at end of file
-
一个Ability同一时刻只能申请运行一个长时任务。
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md
浏览文件 @
a0cbf986
...
...
@@ -10,10 +10,6 @@
import backgroundTaskManager from '@ohos.backgroundTaskManager';
```
## 系统能力
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
## 权限列表
长时任务需要申请如下权限:
...
...
@@ -29,6 +25,8 @@ requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspen
延迟挂起时间一般情况下默认值为180000,低电量(依据系统低电量广播)时默认值为60000。
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
-
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
...
...
@@ -55,6 +53,8 @@ getRemainingDelayTime(requestId: number, callback: AsyncCallback<number>):
获取应用程序进入挂起状态前的剩余时间,使用callback形式返回。
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
-
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
...
...
@@ -80,6 +80,8 @@ getRemainingDelayTime(requestId: number): Promise<number>
获取应用程序进入挂起状态前的剩余时间,使用Promise形式返回。
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
-
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
...
...
@@ -107,6 +109,8 @@ cancelSuspendDelay(requestId: number): void
取消延迟挂起。
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
-
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
...
...
@@ -122,6 +126,8 @@ cancelSuspendDelay(requestId: number): void
延迟挂起信息。
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| requestId | number | 是 | 延迟挂起的请求ID。 |
...
...
@@ -129,16 +135,18 @@ cancelSuspendDelay(requestId: number): void
## backgroundTaskManager.startBackgroundRunning
<sup>
[8]
</sup>
startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent, callback: AsyncCallback
<
void
>
): void;
startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent, callback: AsyncCallback
<
void
>
): void;
<sup>
8+
</sup>
向系统申请长时任务,使用callback形式返回结果。
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
-
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | Context | 是 | 应用运行的上下文 |
| bgMode | BackgroundMode | 是 | 向系统申请的后台模式 |
| wantAgent |
WantAgent | 是 | 通知参数,用于指定长时任务通知点击跳转的界面。使用方式参考:
<sup>
[8]
</sup>
|
| wantAgent |
[
WantAgent
](
js-apis-notification.md#WantAgent接口
)
| 是 | 通知参数,用于指定长时任务通知点击后跳转的界面。
|
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动长时任务的结果 |
-
**示例**
:
...
...
@@ -176,16 +184,18 @@ wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
## backgroundTaskManager.startBackgroundRunning
<sup>
[8]
</sup>
startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise
<
void
>
startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise
<
void
>
;
<sup>
8+
</sup>
向系统申请长时任务,使用promise形式返回结果。
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
-
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | Context | 是 | 应用运行的上下文 |
| bgMode | BackgroundMode | 是 | 向系统申请的后台模式 |
| wantAgent |
WantAgent
| 是 | 通知参数,用于指定长时任务通知点击跳转的界面 |
| wantAgent |
[
WantAgent
](
js-apis-notification.md#WantAgent接口
)
| 是 | 通知参数,用于指定长时任务通知点击跳转的界面 |
-
**返回值**
| 类型 | 说明 |
...
...
@@ -223,10 +233,12 @@ wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
## backgroundTaskManager.stopBackgroundRunning
<sup>
[8]
</sup>
stopBackgroundRunning(context: Context, callback: AsyncCallback
<
void
>
): void;
stopBackgroundRunning(context: Context, callback: AsyncCallback
<
void
>
): void;
<sup>
8+
</sup>
向系统申请取消长时任务,使用callback形式返回结果。
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
-
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
...
...
@@ -252,10 +264,12 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext(), callbac
## backgroundTaskManager.stopBackgroundRunning
<sup>
[8]
</sup>
stopBackgroundRunning(context: Context): Promise
<
void
>
;
stopBackgroundRunning(context: Context): Promise
<
void
>
;
<sup>
8+
</sup>
向系统申请取消长时任务,使用promise形式返回结果。
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
-
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
...
...
@@ -279,16 +293,16 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(()
```
##
<sup>[8]</sup> BackgroundMode
##
BackgroundMode <sup>8+</sup>
| 参数名 | 参数 | 描述 |
| 参数名 | 参数
值
| 描述 |
| ----------------------- | -------- | -------- |
| DATA_TRANSFER | 1 | 数据传输 |
| AUDIO_PLAYBACK | 2 | 音频播放 |
| AUDIO_RECORDING | 3 | 录音 |
| LOCATION | 4 | 定位导航 |
| BLUETOOTH_INTERACTION | 5 | 蓝牙相关 |
| MULTI_DEVICE_CONNECTION | 6 | 多设备互联 |
| WIFI_INTERACTION | 7 | WLAN相关(系统保留) |
| VOIP | 8 | 音视频通话(系统保留) |
| TASK_KEEPING | 9 | 计算任务(仅供PC使用) |
\ No newline at end of file
| DATA_TRANSFER | 1 | 数据传输
<br/>
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| AUDIO_PLAYBACK | 2 | 音频播放
<br/>
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| AUDIO_RECORDING | 3 | 录音
<br/>
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| LOCATION | 4 | 定位导航
<br/>
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| BLUETOOTH_INTERACTION | 5 | 蓝牙相关
<br/>
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| MULTI_DEVICE_CONNECTION | 6 | 多设备互联
<br/>
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| WIFI_INTERACTION | 7 | WLAN相关(系统保留)
<br/>
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| VOIP | 8 | 音视频通话(系统保留)
<br/>
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| TASK_KEEPING | 9 | 计算任务(仅供PC使用)
<br/>
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录