提交 8fd482e6 编写于 作者: G Gloria

Update docs against 14069

Signed-off-by: wusongqing<wusongqing@huawei.com>
上级 4083258f
...@@ -249,8 +249,6 @@ getTrustedDeviceListSync(): Array&lt;DeviceInfo&gt; ...@@ -249,8 +249,6 @@ getTrustedDeviceListSync(): Array&lt;DeviceInfo&gt;
Obtains all trusted devices synchronously. Obtains all trusted devices synchronously.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Return value** **Return value**
...@@ -283,8 +281,6 @@ getTrustedDeviceList(callback:AsyncCallback&lt;Array&lt;DeviceInfo&gt;&gt;): voi ...@@ -283,8 +281,6 @@ getTrustedDeviceList(callback:AsyncCallback&lt;Array&lt;DeviceInfo&gt;&gt;): voi
Obtains all trusted devices. This API uses an asynchronous callback to return the result. Obtains all trusted devices. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -323,8 +319,6 @@ getTrustedDeviceList(): Promise&lt;Array&lt;DeviceInfo&gt;&gt; ...@@ -323,8 +319,6 @@ getTrustedDeviceList(): Promise&lt;Array&lt;DeviceInfo&gt;&gt;
Obtains all trusted devices. This API uses a promise to return the result. Obtains all trusted devices. This API uses a promise to return the result.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Return value** **Return value**
...@@ -357,8 +351,6 @@ getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo) ...@@ -357,8 +351,6 @@ getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo)
Obtains local device information synchronously. Obtains local device information synchronously.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Return value** **Return value**
...@@ -391,8 +383,6 @@ getLocalDeviceInfo(callback:AsyncCallback&lt;DeviceInfo&gt;): void ...@@ -391,8 +383,6 @@ getLocalDeviceInfo(callback:AsyncCallback&lt;DeviceInfo&gt;): void
Obtains local device information. This API uses an asynchronous callback to return the result. Obtains local device information. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -431,8 +421,6 @@ getLocalDeviceInfo(): Promise&lt;DeviceInfo&gt; ...@@ -431,8 +421,6 @@ getLocalDeviceInfo(): Promise&lt;DeviceInfo&gt;
Obtains local device information. This API uses a promise to return the result. Obtains local device information. This API uses a promise to return the result.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Return value** **Return value**
...@@ -465,8 +453,6 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo): void ...@@ -465,8 +453,6 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo): void
Starts to discover peripheral devices. Starts to discover peripheral devices.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -511,8 +497,6 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void ...@@ -511,8 +497,6 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void
Starts to discover peripheral devices and filters discovered devices. Starts to discover peripheral devices and filters discovered devices.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -567,8 +551,6 @@ stopDeviceDiscovery(subscribeId: number): void ...@@ -567,8 +551,6 @@ stopDeviceDiscovery(subscribeId: number): void
Stops device discovery. Stops device discovery.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -588,8 +570,9 @@ For details about the error codes, see [Device Management Error Codes](../errorc ...@@ -588,8 +570,9 @@ For details about the error codes, see [Device Management Error Codes](../errorc
**Example** **Example**
```js ```js
// The subscribeId input must be the same as that automatically generated in startDeviceDiscovery.
try { try {
// stopDeviceDiscovery and startDeviceDiscovery must be used in pairs, and the input parameter **subscribeId** passed in them must be the same.
var subscribeId = 12345;
dmInstance.stopDeviceDiscovery(subscribeId); dmInstance.stopDeviceDiscovery(subscribeId);
} catch (err) { } catch (err) {
console.error("stopDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message); console.error("stopDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
...@@ -602,8 +585,6 @@ publishDeviceDiscovery(publishInfo: PublishInfo): void ...@@ -602,8 +585,6 @@ publishDeviceDiscovery(publishInfo: PublishInfo): void
Publishes device information for discovery purposes. Publishes device information for discovery purposes.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -630,7 +611,7 @@ For details about the error codes, see [Device Management Error Codes](../errorc ...@@ -630,7 +611,7 @@ For details about the error codes, see [Device Management Error Codes](../errorc
"publishId": publishId, "publishId": publishId,
"mode": 0xAA, // Active discovery "mode": 0xAA, // Active discovery
"freq": 2, // High frequency "freq": 2, // High frequency
"ranging": 1 // The device supports reporting the distance to the discovery initiator. "ranging": true // The device supports reporting the distance to the discovery initiator.
}; };
try { try {
dmInstance.publishDeviceDiscovery(publishInfo); // A callback is invoked to notify the application when the device information is published. dmInstance.publishDeviceDiscovery(publishInfo); // A callback is invoked to notify the application when the device information is published.
...@@ -645,8 +626,6 @@ unPublishDeviceDiscovery(publishId: number): void ...@@ -645,8 +626,6 @@ unPublishDeviceDiscovery(publishId: number): void
Stops publishing device information. Stops publishing device information.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -666,8 +645,9 @@ For details about the error codes, see [Device Management Error Codes](../errorc ...@@ -666,8 +645,9 @@ For details about the error codes, see [Device Management Error Codes](../errorc
**Example** **Example**
```js ```js
// The publishId input must be the same as that automatically generated in publishDeviceDiscovery.
try { try {
// unPublishDeviceDiscovery and publishDeviceDiscovery must be used in pairs, and the input parameter **publishId** passed in them must be the same.
var publishId = 12345;
dmInstance.unPublishDeviceDiscovery(publishId); dmInstance.unPublishDeviceDiscovery(publishId);
} catch (err) { } catch (err) {
console.error("unPublishDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message); console.error("unPublishDeviceDiscovery errCode:" + err.code + ",errMessage:" + err.message);
...@@ -680,8 +660,6 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async ...@@ -680,8 +660,6 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async
Authenticates a device. Authenticates a device.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -708,11 +686,19 @@ For details about the error codes, see [Device Management Error Codes](../errorc ...@@ -708,11 +686,19 @@ For details about the error codes, see [Device Management Error Codes](../errorc
var deviceInfo ={ var deviceInfo ={
"deviceId": "XXXXXXXX", "deviceId": "XXXXXXXX",
"deviceName": "", "deviceName": "",
deviceType: 0x0E "deviceType": 0x0E,
"networkId" : "xxxxxxx",
"range" : 0
}; };
let extraInfo = {
'targetPkgName': 'ohos.samples.xxx',
'appName': 'xxx',
'appDescription': 'xxx',
'business': '0'
}
let authParam = { let authParam = {
"authType": 1, // Authentication type. The value 1 means no account PIN authentication. 'authType': 1, // Authentication type. The value 1 means no account PIN authentication.
"extraInfo": {} 'extraInfo': extraInfo
} }
try { try {
dmInstance.authenticateDevice(deviceInfo, authParam, (err, data) => { dmInstance.authenticateDevice(deviceInfo, authParam, (err, data) => {
...@@ -734,8 +720,6 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void ...@@ -734,8 +720,6 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void
Deauthenticates a device. Deauthenticates a device.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -756,6 +740,13 @@ For details about the error codes, see [Device Management Error Codes](../errorc ...@@ -756,6 +740,13 @@ For details about the error codes, see [Device Management Error Codes](../errorc
```js ```js
try { try {
var deviceInfo ={
"deviceId": "XXXXXXXX",
"deviceName": "",
"deviceType": 0x0E,
"networkId" : "xxxxxxx",
"range" : 0
};
dmInstance.unAuthenticateDevice(deviceInfo); dmInstance.unAuthenticateDevice(deviceInfo);
} catch (err) { } catch (err) {
console.error("unAuthenticateDevice errCode:" + err.code + ",errMessage:" + err.message); console.error("unAuthenticateDevice errCode:" + err.code + ",errMessage:" + err.message);
...@@ -768,8 +759,6 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback&lt;{deviceId: string, ...@@ -768,8 +759,6 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback&lt;{deviceId: string,
Verifies authentication information. Verifies authentication information.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -792,7 +781,7 @@ For details about the error codes, see [Device Management Error Codes](../errorc ...@@ -792,7 +781,7 @@ For details about the error codes, see [Device Management Error Codes](../errorc
```js ```js
let authInfo = { let authInfo = {
"authType": 1, "authType": 1,
"token": xxxxxx, "token": 123456,
"extraInfo": {} "extraInfo": {}
} }
try { try {
...@@ -814,8 +803,6 @@ setUserOperation(operateAction: number, params: string): void; ...@@ -814,8 +803,6 @@ setUserOperation(operateAction: number, params: string): void;
Sets a user operation. Sets a user operation.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -838,7 +825,7 @@ Sets a user operation. ...@@ -838,7 +825,7 @@ Sets a user operation.
operateAction = 5 - Confirm the input in the PIN input box. operateAction = 5 - Confirm the input in the PIN input box.
*/ */
let operation = 0; let operation = 0;
this.dmInstance.setUserOperation(operation, "extra") dmInstance.setUserOperation(operation, "extra")
} catch (err) { } catch (err) {
console.error("setUserOperation errCode:" + err.code + ",errMessage:" + err.message); console.error("setUserOperation errCode:" + err.code + ",errMessage:" + err.message);
} }
...@@ -850,8 +837,6 @@ on(type: 'uiStateChange', callback: Callback&lt;{ param: string}&gt;): void; ...@@ -850,8 +837,6 @@ on(type: 'uiStateChange', callback: Callback&lt;{ param: string}&gt;): void;
Subscribes to UI status changes. Subscribes to UI status changes.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -868,11 +853,8 @@ Subscribes to UI status changes. ...@@ -868,11 +853,8 @@ Subscribes to UI status changes.
dmInstance.on('uiStateChange', (data) => { dmInstance.on('uiStateChange', (data) => {
console.log("uiStateChange executed, dialog closed" + JSON.stringify(data)) console.log("uiStateChange executed, dialog closed" + JSON.stringify(data))
var tmpStr = JSON.parse(data.param) var tmpStr = JSON.parse(data.param)
this.isShow = tmpStr.verifyFailed var isShow = tmpStr.verifyFailed
console.log("uiStateChange executed, dialog closed" + this.isShow) console.log("uiStateChange executed, dialog closed" + isShow)
if (!this.isShow) {
this.destruction()
}
}); });
} catch (err) { } catch (err) {
console.error("uiStateChange errCode:" + err.code + ",errMessage:" + err.message); console.error("uiStateChange errCode:" + err.code + ",errMessage:" + err.message);
...@@ -885,8 +867,6 @@ off(type: 'uiStateChange', callback?: Callback&lt;{ param: string}&gt;): void; ...@@ -885,8 +867,6 @@ off(type: 'uiStateChange', callback?: Callback&lt;{ param: string}&gt;): void;
Unsubscribes from UI status changes. Unsubscribes from UI status changes.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -912,8 +892,6 @@ on(type: 'deviceStateChange', callback: Callback&lt;{ action: DeviceStateChange ...@@ -912,8 +892,6 @@ on(type: 'deviceStateChange', callback: Callback&lt;{ action: DeviceStateChange
Subscribes to changes in the device state. Subscribes to changes in the device state.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -941,8 +919,6 @@ off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChang ...@@ -941,8 +919,6 @@ off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChang
Unsubscribes from changes in the device state. Unsubscribes from changes in the device state.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -970,8 +946,6 @@ on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: Dev ...@@ -970,8 +946,6 @@ on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: Dev
Subscribes to device discovery events. Subscribes to device discovery events.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -999,8 +973,6 @@ off(type: 'deviceFound', callback?: Callback&lt;{ subscribeId: number, device: D ...@@ -999,8 +973,6 @@ off(type: 'deviceFound', callback?: Callback&lt;{ subscribeId: number, device: D
Unsubscribes from device discovery events. Unsubscribes from device discovery events.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -1028,8 +1000,6 @@ on(type: 'discoverFail', callback: Callback&lt;{ subscribeId: number, reason: nu ...@@ -1028,8 +1000,6 @@ on(type: 'discoverFail', callback: Callback&lt;{ subscribeId: number, reason: nu
Subscribes to device discovery failures. Subscribes to device discovery failures.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -1057,8 +1027,6 @@ off(type: 'discoverFail', callback?: Callback&lt;{ subscribeId: number, reason: ...@@ -1057,8 +1027,6 @@ off(type: 'discoverFail', callback?: Callback&lt;{ subscribeId: number, reason:
Unsubscribes from device discovery failures. Unsubscribes from device discovery failures.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -1086,8 +1054,6 @@ on(type: 'publishSuccess', callback: Callback&lt;{ publishId: number }&gt;): voi ...@@ -1086,8 +1054,6 @@ on(type: 'publishSuccess', callback: Callback&lt;{ publishId: number }&gt;): voi
Subscribes to device information publication success events. Subscribes to device information publication success events.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -1116,8 +1082,6 @@ off(type: 'publishSuccess', callback?: Callback&lt;{ publishId: number }&gt;): v ...@@ -1116,8 +1082,6 @@ off(type: 'publishSuccess', callback?: Callback&lt;{ publishId: number }&gt;): v
Unsubscribes from device information publication success events. Unsubscribes from device information publication success events.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -1145,8 +1109,6 @@ on(type: 'publishFail', callback: Callback&lt;{ publishId: number, reason: numbe ...@@ -1145,8 +1109,6 @@ on(type: 'publishFail', callback: Callback&lt;{ publishId: number, reason: numbe
Subscribes to device information publication failures. Subscribes to device information publication failures.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -1174,8 +1136,6 @@ off(type: 'publishFail', callback?: Callback&lt;{ publishId: number, reason: num ...@@ -1174,8 +1136,6 @@ off(type: 'publishFail', callback?: Callback&lt;{ publishId: number, reason: num
Unsubscribes from device information publication failures. Unsubscribes from device information publication failures.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -1203,8 +1163,6 @@ on(type: 'serviceDie', callback: () =&gt; void): void ...@@ -1203,8 +1163,6 @@ on(type: 'serviceDie', callback: () =&gt; void): void
Subscribes to dead events of the **DeviceManager** service. Subscribes to dead events of the **DeviceManager** service.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
...@@ -1232,8 +1190,6 @@ off(type: 'serviceDie', callback?: () =&gt; void): void ...@@ -1232,8 +1190,6 @@ off(type: 'serviceDie', callback?: () =&gt; void): void
Unsubscribes from dead events of the **DeviceManager** service. Unsubscribes from dead events of the **DeviceManager** service.
**Required permissions**: ohos.permission.ACCESS_SERVICE_DM (available only to system applications)
**System capability**: SystemCapability.DistributedHardware.DeviceManager **System capability**: SystemCapability.DistributedHardware.DeviceManager
**Parameters** **Parameters**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册