Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
dfa54037
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看板
提交
dfa54037
编写于
6月 06, 2023
作者:
H
hobbycao
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
feature: add distributedMission interface desc
Signed-off-by:
N
hobbycao
<
caohui10@huawei.com
>
上级
767c2016
变更
4
隐藏空白更改
内联
并排
Showing
4 changed file
with
278 addition
and
1 deletion
+278
-1
zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md
...n-dev/reference/apis/js-apis-distributedMissionManager.md
+177
-1
zh-cn/application-dev/reference/apis/js-apis-inner-application-continuableInfo.md
...ference/apis/js-apis-inner-application-continuableInfo.md
+35
-0
zh-cn/application-dev/reference/apis/js-apis-inner-application-continueMissionInfo.md
...nce/apis/js-apis-inner-application-continueMissionInfo.md
+46
-0
zh-cn/application-dev/reference/errorcodes/errorcode-DistributedSchedule.md
...dev/reference/errorcodes/errorcode-DistributedSchedule.md
+20
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md
浏览文件 @
dfa54037
...
...
@@ -475,6 +475,171 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback): Promi
}
```
## distributedMissionManager.continueMission<sup>10+</sup>
continueMission(parameter: ContinueMissionInfo, callback: AsyncCallback
<
void
>
): void;
通过指定包名的方式进行迁移任务,使用callback异步回调。
**需要权限**
:ohos.permission.MANAGE_MISSIONS,ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------------------- | ---- | ----- |
| parameter |
[
ContinueMissionInfo
](
./js-apis-inner-application-continueMissionInfo.md
)
| 是 | 迁移信息。 |
| callback | AsyncCallback
<
void
>
| 是 | 迁移任务完成回调函数。 |
**错误码:**
以下错误码的详细介绍请参见
[
分布式调度错误码
](
../errorcodes/errorcode-DistributedSchedule.md
)
。
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 16300501 | The system ability work abnormally. |
| 16300503 | The application is not installed on the remote end and installation-free is not supported. |
| 16300504 | The application is not installed on the remote end but installation-free is supported, try again with freeInstall flag. |
| 16300505 | The operation device must be the device where the application to be continued is located or the target device to be continued. |
| 16300506 | The local continuation task is already in progress. |
| 16300507 | Failed to get the missionInfo of the specified bundle name. |
**示例:**
```
ts
var
parameter
=
{
srcDeviceId
:
""
,
dstDeviceId
:
""
,
bundleName
:
"
ohos.test.continueapp
"
,
wantParam
:
{
"
key
"
:
"
value
"
}
};
try
{
distributedMissionManager
.
continueMission
(
parameter
,
(
error
)
=>
{
if
(
error
.
code
!=
0
)
{
console
.
error
(
'
continueMission failed, cause:
'
+
JSON
.
stringify
(
error
))
}
console
.
info
(
'
continueMission finished
'
)
})
}
catch
(
error
)
{
console
.
error
(
'
continueMission failed, cause:
'
+
JSON
.
stringify
(
error
))
}
```
## distributedMissionManager.continueMission<sup>10+</sup>
continueMission(parameter: ContinueMissionInfo): Promise
<
void
>
通过指定包名的方式进行迁移任务,使用Promise异步回调。
**需要权限**
:ohos.permission.MANAGE_MISSIONS,ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------------------- | ---- | ----- |
| parameter |
[
ContinueMissionInfo
](
./js-apis-inner-application-continueMissionInfo.md
)
| 是 | 迁移信息。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------- |
| Promise
<
void
>
| promise方式返回执行结果。 |
**错误码:**
以下错误码的详细介绍请参见
[
分布式调度错误码
](
../errorcodes/errorcode-DistributedSchedule.md
)
。
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 16300501 | The system ability work abnormally. |
| 16300503 | The application is not installed on the remote end and installation-free is not supported. |
| 16300504 | The application is not installed on the remote end but installation-free is supported, try again with freeInstall flag. |
| 16300505 | The operation device must be the device where the application to be continued is located or the target device to be continued. |
| 16300506 | The local continuation task is already in progress. |
| 16300507 | Failed to get the missionInfo of the specified bundle name. |
**示例:**
```
ts
var
parameter
=
{
srcDeviceId
:
""
,
dstDeviceId
:
""
,
bundleName
:
"
ohos.test.continueapp
"
,
wantParam
:
{
"
key
"
:
"
value
"
}
};
try
{
distributedMissionManager
.
continueMission
(
parameter
)
.
then
(
data
=>
{
console
.
info
(
'
continueMission finished,
'
+
JSON
.
stringify
(
data
));
}).
catch
(
error
=>
{
console
.
error
(
'
continueMission failed, cause:
'
+
JSON
.
stringify
(
error
));
})
}
catch
(
error
)
{
console
.
error
(
'
continueMission failed, cause:
'
+
JSON
.
stringify
(
error
))
}
```
## distributedMissionManager.on('continueStateChange')<sup>10+</sup>
on(type: 'continueStateChange', callback: Callback
<
{ state: ContinueState, info: ContinuableInfo }
>
): void
注册当前应用任务流转状态的监听。
**需要权限**
:ohos.permission.MANAGE_MISSIONS
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------- |
| type | string | 是 | 注册当前应用任务流转的状态监听,取值为continueStateChange |
| callback | Callback
<
{
state:
[ContinueState](#continuestate10),
info:
[ContinuableInfo](./js-apis-inner-application-continuableInfo.md)
}
>
| 是 | 指示要注册的应用任务流转状态监听的回调,返回应用任务流转状态和流转信息。 |
**示例:**
```
js
try
{
distributedMissionManager
.
on
(
'
continueStateChange
'
,
(
data
)
=>
{
console
.
info
(
"
continueStateChange on:
"
+
JSON
.
stringify
(
data
));
});
}
catch
(
err
)
{
console
.
error
(
"
continueStateChange errCode:
"
+
err
.
code
+
"
,errMessage:
"
+
err
.
message
);
}
```
## distributedMissionManager.off('continueStateChange')<sup>10+</sup>
off(type: 'continueStateChange', callback?: Callback<{ state: ContinueState, info: ContinuableInfo }>): void
取消当前应用任务流转的状态监听。
**需要权限**:ohos.permission.MANAGE_MISSIONS
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------- |
| type | string | 是 | 取消当前应用任务流转的状态监听,取值为continueStateChange |
| callback | Callback<{ state: [ContinueState](#continuestate10), info: [ContinuableInfo](./js-apis-inner-application-continuableInfo.md) }> | 否 | 指示要取消的应用任务流转状态监听的回调。 |
**示例:**
```
js
try {
distributedMissionManager.off('continueStateChange', (data) => {
console.info("continueStateChange on:" + JSON.stringify(data));
});
} catch (err) {
console.error("continueStateChange errCode:" + err.code + ",errMessage:" + err.message);
}
```
## MissionCallback
表示开始同步后,建立的回调函数。
...
...
@@ -513,4 +678,15 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback): Promi
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | ------ | ---- | ---- | ------- |
| deviceId | string | 是 | 是 | 表示设备ID。 |
\ No newline at end of file
| deviceId | string | 是 | 是 | 表示设备ID。 |
## ContinueState<sup>10+</sup>
ContinueState说明枚举,表示当前应用任务流转的状态。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 值 | 说明 |
| ------------- | --------- | ------------------------------------------------------------ |
| ACTIVE | 0 | 表示当前应用任务流转处于激活状态。 |
| INACTIVE | 1 | 表示当前应用任务流转处于未激活状态。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-application-continuableInfo.md
0 → 100644
浏览文件 @
dfa54037
# ContinuableInfo
当注册应用任务流转状态监听的回调时,返回应用任务流转状态和流转信息,注册详见:
[
on('continueStateChange')接口
](
js-apis-distributedMissionManager.md#distributedmissionmanageroncontinuestatechange10
)
。
> **说明:**
>
> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口为系统接口。
## 导入模块
```
ts
import
distributedMissionManager
from
'
@ohos.distributedMissionManager
'
;
```
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | ------ | ---- | ---- | ------- |
| srcDeviceId | string | 是 | 是 | 表示可任务迁移源设备ID。 |
| bundleName | string | 是 | 是 | 表示任务所属应用包名。 |
**示例:**
```
js
import
distributedMissionManager
from
'
@ohos.distributedMissionManager
'
;
try
{
distributedMissionManager
.
on
(
'
continueStateChange
'
,
(
data
)
=>
{
console
.
info
(
"
continueStateChange on:
"
+
JSON
.
stringify
(
data
));
});
}
catch
(
err
)
{
console
.
error
(
"
continueStateChange errCode:
"
+
err
.
code
+
"
,errMessage:
"
+
err
.
message
);
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inner-application-continueMissionInfo.md
0 → 100644
浏览文件 @
dfa54037
# ContinueMissionInfo
表示发起按照包名迁移时所需参数的枚举,迁移Mission详见:
[
continueMission接口
](
js-apis-distributedMissionManager.md#distributedmissionmanagercontinuemission10
)
。
> **说明:**
>
> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口为系统接口。
## 导入模块
```
ts
import
distributedMissionManager
from
'
@ohos.distributedMissionManager
'
;
```
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | ------ | ---- | ---- | ------- |
| srcDeviceId | string | 是 | 是 | 表示任务迁移源设备ID。 |
| dstDeviceId | string | 是 | 是 | 表示任务迁移目标设备ID。 |
| bundleName | string | 是 | 是 | 表示任务所属应用包名。 |
| wantParam | {[key: string]: any} | 是 | 是 | 表示扩展参数。 |
**示例:**
```
ts
import
distributedMissionManager
from
'
@ohos.distributedMissionManager
'
;
var
parameter
=
{
srcDeviceId
:
""
,
dstDeviceId
:
""
,
bundleName
:
"
ohos.test.continueapp
"
,
wantParam
:
{
"
key
"
:
"
value
"
}
};
try
{
distributedMissionManager
.
continueMission
(
parameter
,
(
error
)
=>
{
if
(
error
.
code
!=
0
)
{
console
.
error
(
'
continueMission failed, cause:
'
+
JSON
.
stringify
(
error
))
}
console
.
info
(
'
continueMission finished
'
)
})
}
catch
(
error
)
{
console
.
error
(
'
continueMission failed, cause:
'
+
JSON
.
stringify
(
error
))
}
```
zh-cn/application-dev/reference/errorcodes/errorcode-DistributedSchedule.md
浏览文件 @
dfa54037
...
...
@@ -193,6 +193,26 @@ The local continuation task is already in progress.
请检查是否已经发起了迁移并未结束。
## 16300507 获取指定的bundleName的missionInfo失败
**错误描述**
当调用distributedMissionManager.continueMission接口获取指定bundleName的missionInfo失败时,会报此错误码。
**错误信息**
Failed to get the missionInfo of the specified bundle name.
**可能原因**
该错误码表示获取指定的bundleName的missionInfo失败,可能原因如下。
1.
bundleName输入错误。
2.
bundleName对应的missionInfo确实不存在。
**处理步骤**
请检查输入的bundleName是否正确。
## 3 序列化对象失败
**错误描述**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录