未验证 提交 48a80cda 编写于 作者: 熊欢 提交者: Gitee

!4 docs 修改格式

Merge pull request !4 from 史晓晓/master
...@@ -35,24 +35,23 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager ...@@ -35,24 +35,23 @@ createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------------- | ---- | ------------------------------------ | | ---------- | ---------------------------------------- | ---- | ------------------------------------ |
| bundleName | string | 是 | 指示应用程序的包名。 | | bundleName | string | 是 | 指示应用程序的包名。 |
| callback | AsyncCallback<[DeviceManager](#devicemanager)> | 是 | DeviceManager实例创建时调用的回调,返回设备管理器对象实例。 | | callback | AsyncCallback<[DeviceManager](#devicemanager)> | 是 | DeviceManager实例创建时调用的回调,返回设备管理器对象实例。 |
**错误码** **错误码**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
| 11600102 | Failed to obtain the service. | | 11600102 | Failed to obtain the service. |
**示例** **示例**
```js ```js
try { try {
...@@ -229,15 +228,15 @@ release(): void ...@@ -229,15 +228,15 @@ release(): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**错误码** **错误码**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
**示例** **示例**
```js ```js
try { try {
...@@ -255,21 +254,21 @@ getTrustedDeviceListSync(): Array<DeviceInfo> ...@@ -255,21 +254,21 @@ getTrustedDeviceListSync(): Array<DeviceInfo>
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**返回值** **返回值**
| 名称 | 说明 | | 名称 | 说明 |
| -------------------------------------- | --------- | | -------------------------------------- | --------- |
| Array<[DeviceInfo](#deviceinfo)> | 返回可信设备列表。 | | Array<[DeviceInfo](#deviceinfo)> | 返回可信设备列表。 |
**错误码** **错误码**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
**示例** **示例**
```js ```js
try { try {
...@@ -287,22 +286,21 @@ getTrustedDeviceList(callback:AsyncCallback<Array<DeviceInfo>>): voi ...@@ -287,22 +286,21 @@ getTrustedDeviceList(callback:AsyncCallback<Array<DeviceInfo>>): voi
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------- | | -------- | ---------------------------------------- | ---- | --------------------- |
| callback | AsyncCallback<Array<[DeviceInfo](#deviceinfo)>> | 是 | 获取所有可信设备列表的回调,返回设备信息。 | | callback | AsyncCallback<Array<[DeviceInfo](#deviceinfo)>> | 是 | 获取所有可信设备列表的回调,返回设备信息。 |
**错误码** **错误码:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
**示例** **示例**
```js ```js
try { try {
...@@ -326,21 +324,21 @@ getTrustedDeviceList(): Promise<Array<DeviceInfo>> ...@@ -326,21 +324,21 @@ getTrustedDeviceList(): Promise<Array<DeviceInfo>>
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | --------------------- | | ---------------------------------------- | --------------------- |
| Promise<Array<[DeviceInfo](#deviceinfo)>> | Promise实例,用于获取异步返回结果。 | | Promise<Array<[DeviceInfo](#deviceinfo)>> | Promise实例,用于获取异步返回结果。 |
**错误码** **错误码**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
**示例** **示例**
```js ```js
dmInstance.getTrustedDeviceList().then((data) => { dmInstance.getTrustedDeviceList().then((data) => {
...@@ -358,21 +356,21 @@ getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo) ...@@ -358,21 +356,21 @@ getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo)
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**返回值** **返回值**
| 名称 | 说明 | | 名称 | 说明 |
| ------------------------- | ---------------- | | ------------------------- | ---------------- |
| [DeviceInfo](#deviceinfo) | 返回本地设备列表。 | | [DeviceInfo](#deviceinfo) | 返回本地设备列表。 |
**错误码** **错误码**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
**示例** **示例**
```js ```js
try { try {
...@@ -390,22 +388,21 @@ getLocalDeviceInfo(callback:AsyncCallback<DeviceInfo>): void ...@@ -390,22 +388,21 @@ getLocalDeviceInfo(callback:AsyncCallback<DeviceInfo>): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- | | -------- | ---------------------------------------- | ---- | --------- |
| callback | AsyncCallback<[DeviceInfo](#deviceinfo)> | 是 | 获取本地设备信息。 | | callback | AsyncCallback<[DeviceInfo](#deviceinfo)> | 是 | 获取本地设备信息。 |
**错误码** **错误码:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
**示例** **示例**
```js ```js
try { try {
...@@ -429,22 +426,22 @@ getLocalDeviceInfo(): Promise<DeviceInfo> ...@@ -429,22 +426,22 @@ getLocalDeviceInfo(): Promise<DeviceInfo>
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**返回值** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | --------------------- | | ---------------------------------------- | --------------------- |
| Promise<[DeviceInfo](#deviceinfo)> | Promise实例,用于获取异步返回结果。 | | Promise<[DeviceInfo](#deviceinfo)> | Promise实例,用于获取异步返回结果。 |
**错误码** **错误码**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------------------------- | | ------- | --------------------------------------------------------------- |
| 11600101| Failed to execute the function. | | 11600101| Failed to execute the function. |
**示例** **示例**
- 示例:
```js ```js
dmInstance.getLocalDeviceInfo().then((data) => { dmInstance.getLocalDeviceInfo().then((data) => {
console.log('get local device info: ' + JSON.stringify(data)); console.log('get local device info: ' + JSON.stringify(data));
...@@ -461,24 +458,22 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo): void ...@@ -461,24 +458,22 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ----- | | ------------- | ------------------------------- | ---- | ----- |
| subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。| | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。|
**错误码** **错误码:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
| 201 | Permission verify failed. |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
| 11600104 | Discovery invalid. | | 11600104 | Discovery invalid. |
**示例** **示例**
```js ```js
// 生成发现标识,随机数确保每次调用发现接口的标识不一致 // 生成发现标识,随机数确保每次调用发现接口的标识不一致
...@@ -507,25 +502,23 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void ...@@ -507,25 +502,23 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ----- | | ------------- | ------------------------------- | ---- | ----- |
| subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。 | | subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。 |
| filterOptions | string | 否 | 发现设备过滤信息。| | filterOptions | string | 否 | 发现设备过滤信息。|
**错误码** **错误码:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
| 201 | Permission verify failed. |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
| 11600104 | Discovery invalid. | | 11600104 | Discovery invalid. |
**示例** **示例**
```js ```js
// 生成发现标识,随机数确保每次调用发现接口的标识不一致 // 生成发现标识,随机数确保每次调用发现接口的标识不一致
...@@ -563,23 +556,21 @@ stopDeviceDiscovery(subscribeId: number): void ...@@ -563,23 +556,21 @@ stopDeviceDiscovery(subscribeId: number): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ----- | | ----------- | ------ | ---- | ----- |
| subscribeId | number | 是 | 发现标识。 | | subscribeId | number | 是 | 发现标识。 |
**错误码** **错误码**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
| 201 | Permission verify failed. |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
**示例** **示例**
```js ```js
// 入参需要和startDeviceDiscovery接口传入的subscribeId配对使用 // 入参需要和startDeviceDiscovery接口传入的subscribeId配对使用
...@@ -598,24 +589,22 @@ publishDeviceDiscovery(publishInfo: PublishInfo): void ...@@ -598,24 +589,22 @@ publishDeviceDiscovery(publishInfo: PublishInfo): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------- | ------------------------------- | ---- | ----- | | ------------- | ------------------------------- | ---- | ----- |
| publishInfo | [PublishInfo](#publishinfo) | 是 | 发布设备发现信息。 | | publishInfo | [PublishInfo](#publishinfo) | 是 | 发布设备发现信息。 |
**错误码** **错误码**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
| 201 | Permission verify failed. |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
| 11600105 | Publish invalid. | | 11600105 | Publish invalid. |
**示例** **示例**
```js ```js
// 生成发布标识,随机数确保每次调用发布接口的标识不一致 // 生成发布标识,随机数确保每次调用发布接口的标识不一致
...@@ -641,23 +630,21 @@ unPublishDeviceDiscovery(publishId: number): void ...@@ -641,23 +630,21 @@ unPublishDeviceDiscovery(publishId: number): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ----------- | -------- | ---- | ----- | | ----------- | -------- | ---- | ----- |
| publishId | number | 是 | 发布标识。 | | publishId | number | 是 | 发布标识。 |
**错误码** **错误码**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
| 201 | Permission verify failed. |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
**示例** **示例**
```js ```js
// 入参需要和publishDeviceDiscovery接口传入的publishId配对使用 // 入参需要和publishDeviceDiscovery接口传入的publishId配对使用
...@@ -676,7 +663,7 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async ...@@ -676,7 +663,7 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ---------- | ---------------------------------------- | ---- | ------- | | ---------- | ---------------------------------------- | ---- | ------- |
...@@ -684,18 +671,16 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async ...@@ -684,18 +671,16 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async
| authParam | [AuthParam](#authparam) | 是 | 认证参数。 | | authParam | [AuthParam](#authparam) | 是 | 认证参数。 |
| callback | AsyncCallback<{ deviceId: string, pinToken ?: number }> | 是 | 认证结果回调。 | | callback | AsyncCallback<{ deviceId: string, pinToken ?: number }> | 是 | 认证结果回调。 |
**错误码** **错误码**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
| 201 | Permission verify failed. |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
| 11600103 | Authentication invalid. | | 11600103 | Authentication invalid. |
**示例** **示例**
```js ```js
// 认证的设备信息,可以从发现的结果中获取 // 认证的设备信息,可以从发现的结果中获取
...@@ -730,23 +715,21 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void ...@@ -730,23 +715,21 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ----- | | ---------- | ------------------------- | ---- | ----- |
| deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 | | deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 |
**错误码** **错误码**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
| 201 | Permission verify failed. |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
**示例** **示例**
```js ```js
try { try {
...@@ -764,24 +747,22 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, le ...@@ -764,24 +747,22 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, le
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------- | | -------- | ---------------------------------------- | ---- | ------- |
| authInfo | [AuthInfo](#authinfo) | 是 | 认证信息。 | | authInfo | [AuthInfo](#authinfo) | 是 | 认证信息。 |
| callback | AsyncCallback<{ deviceId: string, level: number }> | 是 | 验证结果回调。 | | callback | AsyncCallback<{ deviceId: string, level: number }> | 是 | 验证结果回调。 |
**错误码** **错误码**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md) 以下的错误码的详细介绍请参见[设备管理错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | | 错误码ID | 错误信息 |
| -------- | --------------------------------------------------------------- | | -------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
| 201 | Permission verify failed. |
| 11600101 | Failed to execute the function. | | 11600101 | Failed to execute the function. |
**示例** **示例**
```js ```js
let authInfo = { let authInfo = {
...@@ -810,22 +791,14 @@ setUserOperation(operateAction: number, params: string): void; ...@@ -810,22 +791,14 @@ setUserOperation(operateAction: number, params: string): void;
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------- | --------------- | ---- | ------------------- | | ------------- | --------------- | ---- | ------------------- |
| operateAction | number | 是 | 用户操作动作。 | | operateAction | number | 是 | 用户操作动作。 |
| params | string | 是 | 表示用户的输入参数。 | | params | string | 是 | 表示用户的输入参数。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -852,22 +825,14 @@ ui状态变更回调。 ...@@ -852,22 +825,14 @@ ui状态变更回调。
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------------ | | -------- | ------------------------------------ | ---- | ------------------------------ |
| type | string | 是 | 注册的设备管理器 ui 状态回调,以便在状态改变时通知应用。 | | type | string | 是 | 注册的设备管理器 ui 状态回调,以便在状态改变时通知应用。 |
| callback | Callback&lt;{&nbsp;param: string}&gt; | 是 | 指示要注册的设备管理器 ui 状态回调,返回ui状态。 | | callback | Callback&lt;{&nbsp;param: string}&gt; | 是 | 指示要注册的设备管理器 ui 状态回调,返回ui状态。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -893,22 +858,14 @@ off(type: 'uiStateChange', callback?: Callback<{ param: string}>): void; ...@@ -893,22 +858,14 @@ off(type: 'uiStateChange', callback?: Callback<{ param: string}>): void;
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------ | | -------- | ------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 取消注册的设备管理器 ui 状态回调。 | | type | string | 是 | 取消注册的设备管理器 ui 状态回调。 |
| callback | Callback&lt;{&nbsp;param: string}&gt; | 是 | 指示要取消注册的设备管理器 ui 状态,返回UI状态。 | | callback | Callback&lt;{&nbsp;param: string}&gt; | 是 | 指示要取消注册的设备管理器 ui 状态,返回UI状态。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -926,22 +883,14 @@ on(type: 'deviceStateChange', callback: Callback&lt;{ action: DeviceStateChange ...@@ -926,22 +883,14 @@ on(type: 'deviceStateChange', callback: Callback&lt;{ action: DeviceStateChange
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------ | | -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 注册设备状态回调,固定为deviceStateChange。 | | type | string | 是 | 注册设备状态回调,固定为deviceStateChange。 |
| callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要注册的设备状态回调,返回设备状态和设备信息。 | | callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要注册的设备状态回调,返回设备状态和设备信息。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -961,22 +910,14 @@ off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChang ...@@ -961,22 +910,14 @@ off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChang
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------------- | | -------- | ---------------------------------------- | ---- | --------------------------- |
| type | string | 是 | 根据应用程序的包名取消注册设备状态回调。 | | type | string | 是 | 根据应用程序的包名取消注册设备状态回调。 |
| callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;&nbsp;}&gt; | 是 | 指示要取消注册的设备状态回调,返回设备状态和设备信息。 | | callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;&nbsp;}&gt; | 是 | 指示要取消注册的设备状态回调,返回设备状态和设备信息。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -988,7 +929,6 @@ off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChang ...@@ -988,7 +929,6 @@ off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChang
} }
``` ```
### on('deviceFound') ### on('deviceFound')
on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: DeviceInfo }&gt;): void on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: DeviceInfo }&gt;): void
...@@ -997,22 +937,14 @@ on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: Dev ...@@ -997,22 +937,14 @@ on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: Dev
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------- | | -------- | ---------------------------------------- | ---- | -------------------------- |
| type | string | 是 | 注册设备发现回调,以便在发现周边设备时通知应用程序。 | | type | string | 是 | 注册设备发现回调,以便在发现周边设备时通知应用程序。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, device: DeviceInfo&nbsp;}&gt; | 是 | 注册设备发现的回调方法。 | | callback | Callback&lt;{&nbsp;subscribeId: number, device: DeviceInfo&nbsp;}&gt; | 是 | 注册设备发现的回调方法。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -1032,22 +964,14 @@ off(type: 'deviceFound', callback?: Callback&lt;{ subscribeId: number, device: D ...@@ -1032,22 +964,14 @@ off(type: 'deviceFound', callback?: Callback&lt;{ subscribeId: number, device: D
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------------- | | -------- | ---------------------------------------- | ---- | --------------------------- |
| type | string | 是 | 取消注册设备发现回调。 | | type | string | 是 | 取消注册设备发现回调。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, device: [DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要取消注册的设备发现回调,返回设备状态和设备信息。 | | callback | Callback&lt;{&nbsp;subscribeId: number, device: [DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要取消注册的设备发现回调,返回设备状态和设备信息。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -1067,22 +991,14 @@ on(type: 'discoverFail', callback: Callback&lt;{ subscribeId: number, reason: nu ...@@ -1067,22 +991,14 @@ on(type: 'discoverFail', callback: Callback&lt;{ subscribeId: number, reason: nu
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------ | | -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 注册设备发现失败回调,以便在发现周边设备失败时通知应用程序。 | | type | string | 是 | 注册设备发现失败回调,以便在发现周边设备失败时通知应用程序。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 注册设备发现失败的回调方法。 | | callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 注册设备发现失败的回调方法。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -1102,22 +1018,14 @@ off(type: 'discoverFail', callback?: Callback&lt;{ subscribeId: number, reason: ...@@ -1102,22 +1018,14 @@ off(type: 'discoverFail', callback?: Callback&lt;{ subscribeId: number, reason:
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ----------------- | | -------- | ---------------------------------------- | ---- | ----------------- |
| type | string | 是 | 取消注册设备发现失败回调。 | | type | string | 是 | 取消注册设备发现失败回调。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 指示要取消注册的设备发现失败回调。 | | callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 指示要取消注册的设备发现失败回调。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -1137,22 +1045,15 @@ on(type: 'publishSuccess', callback: Callback&lt;{ publishId: number }&gt;): voi ...@@ -1137,22 +1045,15 @@ on(type: 'publishSuccess', callback: Callback&lt;{ publishId: number }&gt;): voi
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------- | | -------- | ---------------------------------------- | ---- | -------------------------- |
| type | string | 是 | 注册发布设备成功回调,以便将发布成功时通知应用程序。 | | type | string | 是 | 注册发布设备成功回调,以便将发布成功时通知应用程序。 |
| callback | Callback&lt;{ publishId: number }&gt; | 是 | 注册设备发布成功的回调方法。 | | callback | Callback&lt;{ publishId: number }&gt; | 是 | 注册设备发布成功的回调方法。 |
**错误码**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 | **示例:**
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -1172,22 +1073,14 @@ off(type: 'publishSuccess', callback?: Callback&lt;{ publishId: number }&gt;): v ...@@ -1172,22 +1073,14 @@ off(type: 'publishSuccess', callback?: Callback&lt;{ publishId: number }&gt;): v
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------------- | | -------- | ---------------------------------------- | ---- | --------------------------- |
| type | string | 是 | 取消注册设备发布成功回调。 | | type | string | 是 | 取消注册设备发布成功回调。 |
| callback | Callback&lt;{ publishId: number }&gt; | 是 | 指示要取消注册的设备发布成功回调。 | | callback | Callback&lt;{ publishId: number }&gt; | 是 | 指示要取消注册的设备发布成功回调。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -1207,22 +1100,14 @@ on(type: 'publishFail', callback: Callback&lt;{ publishId: number, reason: numbe ...@@ -1207,22 +1100,14 @@ on(type: 'publishFail', callback: Callback&lt;{ publishId: number, reason: numbe
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------ | | -------- | ----------------------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 注册设备发布失败回调,以便在发布设备失败时通知应用程序。 | | type | string | 是 | 注册设备发布失败回调,以便在发布设备失败时通知应用程序。 |
| callback | Callback&lt;{ publishId: number, reason: number }&gt; | 是 | 注册设备发布失败的回调方法。 | | callback | Callback&lt;{ publishId: number, reason: number }&gt; | 是 | 注册设备发布失败的回调方法。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -1242,22 +1127,14 @@ off(type: 'publishFail', callback?: Callback&lt;{ publishId: number, reason: num ...@@ -1242,22 +1127,14 @@ off(type: 'publishFail', callback?: Callback&lt;{ publishId: number, reason: num
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ----------------- | | -------- | ----------------------------------------------------- | ---- | ----------------- |
| type | string | 是 | 取消注册设备发布失败回调。 | | type | string | 是 | 取消注册设备发布失败回调。 |
| callback | Callback&lt;{ publishId: number, reason: number }&gt; | 是 | 指示要取消注册设备发布失败回调。 | | callback | Callback&lt;{ publishId: number, reason: number }&gt; | 是 | 指示要取消注册设备发布失败回调。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -1277,22 +1154,14 @@ on(type: 'serviceDie', callback: () =&gt; void): void ...@@ -1277,22 +1154,14 @@ on(type: 'serviceDie', callback: () =&gt; void): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ---------------------------------------- | | -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 | | type | string | 是 | 注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 |
| callback | ()&nbsp;=&gt;&nbsp;void | 是 | 注册serviceDie的回调方法。 | | callback | ()&nbsp;=&gt;&nbsp;void | 是 | 注册serviceDie的回调方法。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
...@@ -1304,7 +1173,6 @@ on(type: 'serviceDie', callback: () =&gt; void): void ...@@ -1304,7 +1173,6 @@ on(type: 'serviceDie', callback: () =&gt; void): void
} }
``` ```
### off('serviceDie') ### off('serviceDie')
off(type: 'serviceDie', callback?: () =&gt; void): void off(type: 'serviceDie', callback?: () =&gt; void): void
...@@ -1313,22 +1181,14 @@ off(type: 'serviceDie', callback?: () =&gt; void): void ...@@ -1313,22 +1181,14 @@ off(type: 'serviceDie', callback?: () =&gt; void): void
**系统能力**:SystemCapability.DistributedHardware.DeviceManager **系统能力**:SystemCapability.DistributedHardware.DeviceManager
**参数** **参数**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ---------------------------------------- | | -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 取消注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 | | type | string | 是 | 取消注册serviceDie回调,以便在devicemanager服务异常终止时通知应用程序。 |
| callback | ()&nbsp;=&gt;&nbsp;void | 否 | 取消注册serviceDie的回调方法。 | | callback | ()&nbsp;=&gt;&nbsp;void | 否 | 取消注册serviceDie的回调方法。 |
**错误码** **示例:**
以下的错误码的详细介绍请参见[分布式硬件子系统错误码](../errorcodes/errorcode-device-manager.md)
| 类型 | 说明 |
| ------- | --------------------------------------------------------------- |
| 401 | Input parameter error. |
**示例**
```js ```js
try { try {
......
# 分布式硬件子系统错误码 # 设备管理错误码
## 11600101 服务调用异常 ## 11600101 服务调用异常
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册