HarmonyOS API：通用能力的接口

joytrian

发布于 2023-4-2 10:04

浏览

0收藏

版本：v3.1 Beta

@ohos.continuation.continuationManager (continuationManager)

更新时间: 2023-02-17 09:19

continuationManager模块提供了流转/协同入口管理服务能力，包括连接/取消流转管理服务，注册/解注册设备连接变化监听，拉起设备选择模块，更新连接状态。

本模块接口用于拉起系统中的设备选择模块，由于该模块功能暂不完备，因此流转能力整体暂不支持用于应用开发。

说明

本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import continuationManager from '@ohos.continuation.continuationManager'

continuationManager.register

注册流转管理服务，并获取对应的注册token，无过滤条件，使用AsyncCallback方式作为异步方法。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	AsyncCallback形式返回流转管理服务连接后生成的token。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object.
7	The object is null.
29360207	The number of registrations has reached the upper limit.

示例：

let token = -1;
continuationManager.register((err, data) => {
  if (err.code != 0) {
    console.error('register failed, cause: ' + JSON.stringify(err));
    return;
  }
  console.info('register finished, ' + JSON.stringify(data));
  token = data;
});

continuationManager.register

连接流转管理服务，并获取对应的注册token，使用AsyncCallback方式作为异步方法。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
options	ContinuationExtraParams	是	过滤可选择设备列表的额外参数。
callback	AsyncCallback<number>	是	AsyncCallback形式返回流转管理服务连接后生成的token。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object.
7	The object is null.
29360207	The number of registrations has reached the upper limit.
29360216	Invalid continuation mode.

示例：

let token = -1;
let continuationExtraParams = {
  deviceType: ["00E"]
};
continuationManager.register(continuationExtraParams, (err, data) => {
  if (err.code != 0) {
    console.error('register failed, cause: ' + JSON.stringify(err));
    return;
  }
  console.info('register finished, ' + JSON.stringify(data));
  token = data;
});

continuationManager.register

连接流转管理服务，并获取对应的注册token，使用Promise方式作为异步方法。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
options	ContinuationExtraParams	否	过滤可选择设备列表的额外参数，该参数可缺省

返回值：

类型	说明
Promise<number>	Promise形式返回流转管理服务连接后生成的token。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object
7	The object is null.
29360207	The number of registrations has reached the upper limit.
29360216	Invalid continuation mode.

示例：

let token = -1;
let continuationExtraParams = {
  deviceType: ["00E"]
};
continuationManager.register(continuationExtraParams)
  .then((data) => {
    console.info('register finished, ' + JSON.stringify(data));
    token = data;
  })
  .catch((err) => {
    console.error('register failed, cause: ' + JSON.stringify(err));
  });

continuationManager.off("deviceConnect")⁹⁺

off(type: "deviceConnect", token: number): void;

取消监听设备连接状态。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
type	string	是	取消监听的事件类型，固定值"deviceConnect"。
token	number	是	注册后的token。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
16600001	The system ability works abnormally.
16600002	The specified token or callback is not registered.
16600004	The specified callback has been registered.

示例：

let token = 1;
try {
  continuationManager.off("deviceConnect", token);
} catch (err) {
  console.error('off failed, cause: ' + JSON.stringify(err));
}

continuationManager.off("deviceDisconnect")⁹⁺

off(type: "deviceDisconnect", token: number): void;

取消监听设备断开状态。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
type	string	是	取消监听的事件类型，固定值"deviceDisconnect"。
token	number	是	注册后的token。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
16600001	The system ability works abnormally.
16600002	The specified token or callback is not registered.
16600004	The specified callback has been registered.

示例：

let token = 1;
try {
  continuationManager.off("deviceDisconnect", token);
} catch (err) {
  console.error('off failed, cause: ' + JSON.stringify(err));
}

continuationManager.on("deviceConnect")^(deprecated)

on(type: "deviceConnect", callback: Callback<ContinuationResult>): void;

异步方法，监听设备连接状态，使用Callback形式返回连接的设备信息。

从API version 9开始不再维护。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
type	string	是	监听的事件类型，固定值"deviceConnect"。
callback	Callback<ContinuationResult>	否	当用户从设备选择模块中选择设备时调用，返回设备ID、设备类型和设备名称供开发者使用。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object.
7	The object is null.
29360208	The token is not registered.
29360210	The callback is not registered.
29360214	The type of callback is not supported.

示例：

continuationManager.on("deviceConnect", (data) => {
  console.info('onDeviceConnect deviceId: ' + JSON.stringify(data.id));
  console.info('onDeviceConnect deviceType: ' + JSON.stringify(data.type));
  console.info('onDeviceConnect deviceName: ' + JSON.stringify(data.name));
});

continuationManager.off("deviceConnect")^(deprecated)

off(type: "deviceConnect", callback?: Callback<ContinuationResult>): void;

异步方法，取消监听设备连接状态，使用Callback形式返回连接的设备信息。

从API version 9开始不再维护。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
type	string	是	取消监听的事件类型，固定值"deviceConnect"。
callback	Callback<ContinuationResult>	否	当用户从设备选择模块中选择设备时调用，返回设备ID、设备类型和设备名称供开发者使用。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object.
7	The object is null.
29360208	The token is not registered.
29360210	The callback is not registered.
29360214	The type of callback is not supported.

示例：

continuationManager.off("deviceConnect", (data) => {
  console.info('offDeviceConnect deviceId: ' + JSON.stringify(data.id));
  console.info('offDeviceConnect deviceType: ' + JSON.stringify(data.type));
  console.info('offDeviceConnect deviceName: ' + JSON.stringify(data.name));
});

continuationManager.on("deviceDisconnect")^(deprecated)

on(type: "deviceDisconnect", callback?: Callback<string>): void;

异步方法，监听设备断开状态，使用Callback形式返回断开的设备信息。

从API version 9开始不再维护。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
type	string	是	监听的事件类型，固定值"deviceDisconnect"。
callback	Callback<string>	否	当用户从设备选择模块中断开设备时调用，返回设备ID供开发者使用。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object.
7	The object is null.
29360208	The token is not registered.
29360210	The callback is not registered.
29360214	The type of callback is not supported.

示例：

continuationManager.on("deviceDisconnect", (data) => {
  console.info('onDeviceDisconnect deviceId: ' + JSON.stringify(data));
});

continuationManager.off("deviceDisconnect")^(deprecated)

off(type: "deviceDisconnect", callback?: Callback<string>): void;

异步方法，取消监听设备断开状态，使用Callback形式返回断开的设备信息。

从API version 9开始不再维护。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
type	string	是	取消监听的事件类型，固定值"deviceDisconnect"。
callback	Callback<string>	否	当用户从设备选择模块中断开设备时调用，返回设备ID供开发者使用。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object.
7	The object is null.
29360208	The token is not registered.
29360210	The callback is not registered.
29360214	The type of callback is not supported.

示例：

continuationManager.off("deviceDisconnect", (data) => {
  console.info('offDeviceDisconnect deviceId: ' + JSON.stringify(data));
});

continuationManager.startDeviceManager

startDeviceManager(token: number, callback: AsyncCallback<void>): void;

拉起设备选择模块，可显示组网内可选择设备列表信息，无过滤条件，使用AsyncCallback方式作为异步方法。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
token	number	是	注册后的token。
callback	AsyncCallback<void>	是	AsyncCallback形式返回接口调用结果。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object.
7	The object is null.
29360208	The token is not registered.
29360210	The callback is not registered.
29360211	Failed to connect to the ability.
29360216	Invalid continuation mode.

示例：

let token = 1;
continuationManager.startDeviceManager(token, (err, data) => {
  if (err.code != 0) {
    console.error('startDeviceManager failed, cause: ' + JSON.stringify(err));
    return;
  }
  console.info('startDeviceManager finished, ' + JSON.stringify(data));
});

continuationManager.startDeviceManager

startDeviceManager(token: number, options: ContinuationExtraParams, callback: AsyncCallback<void>): void;

拉起设备选择模块，可显示组网内可选择设备列表信息，使用AsyncCallback方式作为异步方法。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
token	number	是	注册后的token。
options	ContinuationExtraParams	是	过滤可选择设备列表的额外参数。
callback	AsyncCallback<void>	是	AsyncCallback形式返回接口调用结果。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object
7	The object is null
29360208	The token is not registered.
29360210	The callback is not registered.
29360211	Failed to connect to the ability.
29360216	Invalid continuation mode.

示例：

let token = 1;
let continuationExtraParams = {
  deviceType: ["00E"]
};
continuationManager.startDeviceManager(token, continuationExtraParams, (err, data) => {
  if (err.code != 0) {
    console.error('startDeviceManager failed, cause: ' + JSON.stringify(err));
    return;
  }
  console.info('startDeviceManager finished, ' + JSON.stringify(data));
});

continuationManager.startDeviceManager

startDeviceManager(token: number, options?: ContinuationExtraParams): Promise<void>;

拉起设备选择模块，可显示组网内可选择设备列表信息，使用Promise方式作为异步方法。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
token	number	是	注册后的token。
options	ContinuationExtraParams	否	过滤可选择设备列表的额外参数，该参数可缺省

返回值：

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

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object
7	The object is null
29360208	The token is not registered.
29360210	The callback is not registered.
29360211	Failed to connect to the ability.
29360216	Invalid continuation mode.

示例：

let token = 1;
let continuationExtraParams = {
  deviceType: ["00E"]
};
continuationManager.startDeviceManager(token, continuationExtraParams)
  .then((data) => {
    console.info('startDeviceManager finished, ' + JSON.stringify(data));
  })
  .catch((err) => {
    console.error('startDeviceManager failed, cause: ' + JSON.stringify(err));
  });

continuationManager.updateConnectStatus

updateConnectStatus(token: number, deviceId: string, status: DeviceConnectState, callback: AsyncCallback<void>): void;

通知设备选择模块，更新当前的连接状态，使用AsyncCallback方式作为异步方法。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
token	number	是	注册后的token。
deviceId	string	是	设备ID。
status	DeviceConnectState	是	设备连接状态。
callback	AsyncCallback<void>	是	AsyncCallback形式返回接口调用结果。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object.
7	The object is null.
29360208	The token is not registered.
29360210	The callback is not registered.
29360211	Failed to connect to the ability.
29360215	Invalid connection state.

示例：

let token = 1;
let deviceId: string = "test deviceId";
continuationManager.updateConnectStatus(token, deviceId, continuationManager.DeviceConnectState.CONNECTED, (err, data) => {
  if (err.code != 0) {
    console.error('updateConnectStatus failed, cause: ' + JSON.stringify(err));
    return;
  }
  console.info('updateConnectStatus finished, ' + JSON.stringify(data));
});

continuationManager.updateConnectStatus

updateConnectStatus(token: number, deviceId: string, status: DeviceConnectState): Promise<void>;

通知设备选择模块，更新当前的连接状态，使用Promise方式作为异步方法。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
token	number	是	注册后的token。
deviceId	string	是	设备ID。
status	DeviceConnectState	是	设备连接状态。

返回值：

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

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object.
7	The object is null.
29360208	The token is not registered.
29360210	The callback is not registered.
29360211	Failed to connect to the ability.
29360215	Invalid connection state.

示例：

let token = 1;
let deviceId: string = "test deviceId";
continuationManager.updateConnectStatus(token, deviceId, continuationManager.DeviceConnectState.CONNECTED)
  .then((data) => {
    console.info('updateConnectStatus finished, ' + JSON.stringify(data));
  })
  .catch((err) => {
    console.error('updateConnectStatus failed, cause: ' + JSON.stringify(err));
  });

continuationManager.unregister

unregister(token: number, callback: AsyncCallback<void>): void;

解注册流转管理服务，传入注册时获取的token进行解注册，使用AsyncCallback方式作为异步方法。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
token	number	是	注册后的token。
callback	AsyncCallback<void>	是	AsyncCallback形式返回接口调用结果。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object.
7	The object is null.
29360208	The token is not registered.

示例：

let token = 1;
continuationManager.unregister(token, (err, data) => {
  if (err.code != 0) {
    console.error('unregister failed, cause: ' + JSON.stringify(err));
    return;
  }
  console.info('unregister finished, ' + JSON.stringify(data));
});

continuationManager.unregister

unregister(token: number): Promise<void>;

解注册流转管理服务，传入注册时获取的token进行解注册，使用Promise方式作为异步方法。

系统能力：SystemCapability.Ability.DistributedAbilityManager

参数：

参数名	类型	必填	说明
token	number	是	注册后的token。

返回值：

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

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
3	Failed to flatten the object.
7	The object is null.
29360208	The token is not registered.

示例：

let token = 1;
continuationManager.unregister(token)
  .then((data) => {
    console.info('unregister finished, ' + JSON.stringify(data));
  })
  .catch((err) => {
    console.error('unregister failed, cause: ' + JSON.stringify(err));
  });

DeviceConnectState

设备连接状态。

系统能力：SystemCapability.Ability.DistributedAbilityManager

名称	值	说明
IDLE	0	设备连接初始状态。
CONNECTING	1	设备连接中状态。
CONNECTED	2	设备已连接状态。
DISCONNECTING	3	设备断开连接状态。

ContinuationMode

设备选择模块连接模式。

系统能力：SystemCapability.Ability.DistributedAbilityManager

名称	值	说明
COLLABORATION_SINGLE	0	设备选择模块单选模式。
COLLABORATION_MULTIPLE	1	设备选择模块多选模式。

文章转载自：https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-continuation-continuationmanager-0000001427745004-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001427745004__导入模块

分类

卡片开发

三方库

标签

HarmonyOS API

已于2023-4-2 10:04:50修改

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：通用能力的接口

@ohos.continuation.continuationManager (continuationManager)

导入模块

continuationManager.register

continuationManager.register

continuationManager.register

continuationManager.off("deviceConnect")⁹⁺

continuationManager.off("deviceDisconnect")⁹⁺

continuationManager.on("deviceConnect")^(deprecated)

continuationManager.off("deviceConnect")^(deprecated)

continuationManager.on("deviceDisconnect")^(deprecated)

continuationManager.off("deviceDisconnect")^(deprecated)

continuationManager.startDeviceManager

continuationManager.startDeviceManager

continuationManager.startDeviceManager

continuationManager.updateConnectStatus

continuationManager.updateConnectStatus

continuationManager.unregister

continuationManager.unregister

DeviceConnectState

ContinuationMode

目录

订阅鸿蒙技术特刊，精选内容抢先看

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：通用能力的接口

@ohos.continuation.continuationManager (continuationManager)

导入模块

continuationManager.register

continuationManager.register

continuationManager.register

continuationManager.off("deviceConnect")9+

continuationManager.off("deviceDisconnect")9+

continuationManager.on("deviceConnect")(deprecated)

continuationManager.off("deviceConnect")(deprecated)

continuationManager.on("deviceDisconnect")(deprecated)

continuationManager.off("deviceDisconnect")(deprecated)

continuationManager.startDeviceManager

continuationManager.startDeviceManager

continuationManager.startDeviceManager

continuationManager.updateConnectStatus

continuationManager.updateConnectStatus

continuationManager.unregister

continuationManager.unregister

DeviceConnectState

ContinuationMode

目录

订阅鸿蒙技术特刊，精选内容抢先看

continuationManager.off("deviceConnect")⁹⁺

continuationManager.off("deviceDisconnect")⁹⁺

continuationManager.on("deviceConnect")^(deprecated)

continuationManager.off("deviceConnect")^(deprecated)

continuationManager.on("deviceDisconnect")^(deprecated)

continuationManager.off("deviceDisconnect")^(deprecated)