未验证 提交 1b57febd 编写于 作者: O openharmony_ci 提交者: Gitee

!14617 continuationManager.on和off修改事件名-汇合monthly

Merge pull request !14617 from 杜智海/monthly_20221018
......@@ -155,6 +155,8 @@ registerContinuation(callback: AsyncCallback\<number>): void;
注册流转管理服务,并获取对应的注册token,无过滤条件,使用AsyncCallback方式作为异步方法。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
......@@ -196,6 +198,8 @@ registerContinuation(options: ContinuationExtraParams, callback: AsyncCallback\<
连接流转管理服务,并获取对应的注册token,使用AsyncCallback方式作为异步方法。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
......@@ -241,6 +245,8 @@ registerContinuation(options?: ContinuationExtraParams): Promise\<number>;
连接流转管理服务,并获取对应的注册token,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
......@@ -292,7 +298,7 @@ on(type: "deviceConnect", callback: Callback\<ContinuationResult>): void;
异步方法,监听设备连接状态,使用Callback形式返回连接的设备信息。
> 从API version 9开始不再维护,建议使用[on](#continuationmanagerondeviceconnect9)替代。
> 从API version 9开始不再维护,建议使用[on](#continuationmanagerondeviceselected9)替代。
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
......@@ -331,7 +337,7 @@ on(type: "deviceDisconnect", callback: Callback\<string>): void;
异步方法,监听设备断开状态,使用Callback形式返回断开的设备信息。
> 从API version 9开始不再维护,建议使用[on](#continuationmanagerondevicedisconnect9)替代。
> 从API version 9开始不再维护,建议使用[on](#continuationmanagerondeviceunselected9)替代。
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
......@@ -368,7 +374,7 @@ off(type: "deviceConnect", callback?: Callback\<ContinuationResult>): void;
异步方法,取消监听设备连接状态,使用Callback形式返回连接的设备信息。
> 从API version 9开始不再维护,建议使用[off](#continuationmanageroffdeviceconnect9)替代。
> 从API version 9开始不再维护,建议使用[off](#continuationmanageroffdeviceselected9)替代。
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
......@@ -407,7 +413,7 @@ off(type: "deviceDisconnect", callback?: Callback\<string>): void;
异步方法,取消监听设备断开状态,使用Callback形式返回连接的设备信息。
> 从API version 9开始不再维护,建议使用[off](#continuationmanageroffdevicedisconnect9)替代。
> 从API version 9开始不再维护,建议使用[off](#continuationmanageroffdeviceunselected9)替代。
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
......@@ -438,19 +444,21 @@ off(type: "deviceDisconnect", callback?: Callback\<string>): void;
});
```
## continuationManager.on("deviceConnect")<sup>9+</sup>
## continuationManager.on("deviceSelected")<sup>9+</sup>
on(type: "deviceConnect", token: number, callback: Callback\<Array\<ContinuationResult>>): void;
on(type: "deviceSelected", token: number, callback: Callback\<Array\<ContinuationResult>>): void;
异步方法,监听设备连接状态,使用Callback形式返回连接的设备信息。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听的事件类型,固定值"deviceConnect"。 |
| type | string | 是 | 监听的事件类型,固定值"deviceSelected"。 |
| token | number | 是 | 注册后的token。 |
| callback | Callback\<Array\<[ContinuationResult](js-apis-continuation-continuationResult.md)>> | 是 | 当用户从设备选择模块中选择设备时调用,返回设备ID、设备类型和设备名称供开发者使用。 |
......@@ -469,12 +477,12 @@ on(type: "deviceConnect", token: number, callback: Callback\<Array\<Continuation
```ts
let token = 1;
try {
continuationManager.on("deviceConnect", token, (data) => {
console.info('onDeviceConnect len: ' + data.length);
continuationManager.on("deviceSelected", token, (data) => {
console.info('onDeviceSelected len: ' + data.length);
for (let i = 0; i < data.length; i++) {
console.info('onDeviceConnect deviceId: ' + JSON.stringify(data[i].id));
console.info('onDeviceConnect deviceType: ' + JSON.stringify(data[i].type));
console.info('onDeviceConnect deviceName: ' + JSON.stringify(data[i].name));
console.info('onDeviceSelected deviceId: ' + JSON.stringify(data[i].id));
console.info('onDeviceSelected deviceType: ' + JSON.stringify(data[i].type));
console.info('onDeviceSelected deviceName: ' + JSON.stringify(data[i].name));
}
});
} catch (err) {
......@@ -482,21 +490,23 @@ on(type: "deviceConnect", token: number, callback: Callback\<Array\<Continuation
}
```
## continuationManager.on("deviceDisconnect")<sup>9+</sup>
## continuationManager.on("deviceUnselected")<sup>9+</sup>
on(type: "deviceDisconnect", token: number, callback: Callback\<Array\<string>>): void;
on(type: "deviceUnselected", token: number, callback: Callback\<Array\<ContinuationResult>>): void;
异步方法,监听设备断开状态,使用Callback形式返回断开的设备信息。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听的事件类型,固定值"deviceDisconnect"。 |
| type | string | 是 | 监听的事件类型,固定值"deviceUnselected"。 |
| token | number | 是 | 注册后的token。 |
| callback | Callback\<Array\<string>> | 是 | 当用户从设备选择模块中断开设备时调用,返回设备ID供开发者使用。 |
| callback | Callback\<Array\<[ContinuationResult](js-apis-continuation-continuationResult.md)>> | 是 | 当用户从设备选择模块中断开设备时调用,返回设备ID、设备类型和设备名称供开发者使用。 |
**错误码:**
......@@ -513,31 +523,35 @@ on(type: "deviceDisconnect", token: number, callback: Callback\<Array\<string>>)
```ts
let token = 1;
try {
continuationManager.on("deviceDisconnect", token, (data) => {
console.info('onDeviceDisconnect len: ' + data.length);
continuationManager.on("deviceUnselected", token, (data) => {
console.info('onDeviceUnselected len: ' + data.length);
for (let i = 0; i < data.length; i++) {
console.info('onDeviceDisconnect deviceId: ' + JSON.stringify(data[i]));
console.info('onDeviceUnselected deviceId: ' + JSON.stringify(data[i].id));
console.info('onDeviceUnselected deviceType: ' + JSON.stringify(data[i].type));
console.info('onDeviceUnselected deviceName: ' + JSON.stringify(data[i].name));
}
console.info('onDeviceDisconnect finished.');
console.info('onDeviceUnselected finished.');
});
} catch (err) {
console.error('on failed, cause: ' + JSON.stringify(err));
}
```
## continuationManager.off("deviceConnect")<sup>9+</sup>
## continuationManager.off("deviceSelected")<sup>9+</sup>
off(type: "deviceConnect", token: number): void;
off(type: "deviceSelected", token: number): void;
取消监听设备连接状态。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取消监听的事件类型,固定值"deviceConnect"。 |
| type | string | 是 | 取消监听的事件类型,固定值"deviceSelected"。 |
| token | number | 是 | 注册后的token。 |
**错误码:**
......@@ -555,25 +569,27 @@ off(type: "deviceConnect", token: number): void;
```ts
let token = 1;
try {
continuationManager.off("deviceConnect", token);
continuationManager.off("deviceSelected", token);
} catch (err) {
console.error('off failed, cause: ' + JSON.stringify(err));
}
```
## continuationManager.off("deviceDisconnect")<sup>9+</sup>
## continuationManager.off("deviceUnselected")<sup>9+</sup>
off(type: "deviceDisconnect", token: number): void;
off(type: "deviceUnselected", token: number): void;
取消监听设备断开状态。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取消监听的事件类型,固定值"deviceDisconnect"。 |
| type | string | 是 | 取消监听的事件类型,固定值"deviceUnselected"。 |
| token | number | 是 | 注册后的token。 |
**错误码:**
......@@ -591,7 +607,7 @@ off(type: "deviceDisconnect", token: number): void;
```ts
let token = 1;
try {
continuationManager.off("deviceDisconnect", token);
continuationManager.off("deviceUnselected", token);
} catch (err) {
console.error('off failed, cause: ' + JSON.stringify(err));
}
......@@ -745,6 +761,8 @@ startContinuationDeviceManager(token: number, callback: AsyncCallback\<void>): v
拉起设备选择模块,可显示组网内可选择设备列表信息,无过滤条件,使用AsyncCallback方式作为异步方法。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
......@@ -786,6 +804,8 @@ startContinuationDeviceManager(token: number, options: ContinuationExtraParams,
拉起设备选择模块,可显示组网内可选择设备列表信息,使用AsyncCallback方式作为异步方法。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
......@@ -831,6 +851,8 @@ startContinuationDeviceManager(token: number, options?: ContinuationExtraParams)
拉起设备选择模块,可显示组网内可选择设备列表信息,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
......@@ -978,6 +1000,8 @@ updateContinuationState(token: number, deviceId: string, status: DeviceConnectSt
通知设备选择模块,更新当前的连接状态,使用AsyncCallback方式作为异步方法。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
......@@ -1022,6 +1046,8 @@ updateContinuationState(token: number, deviceId: string, status: DeviceConnectSt
通知设备选择模块,更新当前的连接状态,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
......@@ -1157,6 +1183,8 @@ unregisterContinuation(token: number, callback: AsyncCallback\<void>): void;
解注册流转管理服务,传入注册时获取的token进行解注册,使用AsyncCallback方式作为异步方法。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
......@@ -1198,6 +1226,8 @@ unregisterContinuation(token: number): Promise\<void>;
解注册流转管理服务,传入注册时获取的token进行解注册,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**:SystemCapability.Ability.DistributedAbilityManager
**参数:**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册