提交 767aaff0 编写于 作者: X xsz233

Merge remote-tracking branch 'upstream/master'

Signed-off-by: Nxsz233 <xushizhe@huawei.com>
......@@ -237,6 +237,7 @@
- [@ohos.file.environment (Directory Environment Capability)](js-apis-file-environment.md)
- [@ohos.file.fileAccess (User File Access and Management)](js-apis-fileAccess.md)
- [@ohos.file.fileExtensionInfo (User File Extension Information)](js-apis-fileExtensionInfo.md)
- [@ohos.file.fileUri (File URI)](js-apis-file-fileUri.md)
- [@ohos.file.fs (File Management)](js-apis-file-fs.md)
- [@ohos.file.hash (File Hash Processing)](js-apis-file-hash.md)
- [@ohos.file.picker (Picker)](js-apis-file-picker.md)
......@@ -245,6 +246,7 @@
- [@ohos.file.storageStatistics (Application Storage Statistics)](js-apis-file-storage-statistics.md)
- [@ohos.file.volumeManager (Volume Management)](js-apis-file-volumemanager.md)
- [@ohos.filemanagement.userFileManager (User Data Management)](js-apis-userFileManager.md)
- [@ohos.fileShare (File Sharing)](js-apis-fileShare.md)
- Telephony Service
- [@ohos.contact (Contacts)](js-apis-contact.md)
......
# @ohos.file.fileUri (File URI)
The **fileUri** module allows the uniform resource identifier (URI) of a file to be obtained based on the file path. With the file URI, you can use the APIs provided by [@ohos.file.fs](js-apis-file-fs.md) to operate the file.
> **NOTE**
>
> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import
```js
import fileUri from "@ohos.file.fileUri";
```
Before using this module, you need to obtain the path of the file in the application sandbox. The following is an example:
```js
import UIAbility from '@ohos.app.ability.UIAbility';
export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage) {
let context = this.context;
let pathDir = context.filesDir;
}
}
```
## fileUri.getUriFromPath
getUriFromPath(path: string): string
Obtains the URI of a file in synchronous mode.
**System capability**: SystemCapability.FileManagement.AppFileService
**Parameters**
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | -------------------------- |
| path | string | Yes | Path of the file in the application sandbox.|
**Return value**
| Type | Description |
| ---------------------------- | ---------- |
| string | File URI obtained.|
**Error codes**
For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
| ID | Error Message |
| ---------------------------- | ---------- |
| 401 | The input parameter is invalid |
**Example**
```js
let filePath = pathDir + "test.txt";
let uri = fileUri.getUriFromPath(filePath);
```
# @ohos.fileShare (File Sharing)
The **fileShare** module provides APIs for granting the access permissions on a user file to another application by the Uniform Resource Identifier (URI). Then, the authorized application can access the file by using the APIs provided by [@ohos.file.fs](js-apis-file-fs.md).
> **NOTE**
>
> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import
```js
import fileShare from '@ohos.fileShare';
```
## fileShare.grantUriPermission
grantUriPermission(uri: string, bundleName: string, mode: number, callback: AsyncCallback&lt;void&gt;): void
Grants permissions on a user file by the URI to an application. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.WRITE_MEDIA
**System API**: This is a system API.
**System capability**: SystemCapability.FileManagement.AppFileService
**Parameters**
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | -------------------------- |
| uri | string | Yes | URI of a user file.|
| bundleName | string | Yes | Bundle name of the application to be grated with the permissions.|
| mode | number | Yes | Permissions to grant. For details, see [wantConstant.Flags](js-apis-app-ability-wantConstant.md#wantconstantflags).<br>**wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION**: permission to read the file. <br>**wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION**: permission to write the file.|
| callback | AsyncCallback&lt;void&gt; | Yes | Callback invoked to return the result. |
**Error codes**
For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
| ID | Error Message |
| ---------------------------- | ---------- |
| 201 | Permission verification failed |
| 202 | The caller is not a system application |
| 401 | The input parameter is invalid |
| 143000001 | IPC error |
**Example**
```js
import wantConstant from '@ohos.app.ability.wantConstant';
let uri = 'datashare:///media/image/8';
let bundleName = 'com.demo.test';
try {
fileShare.grantUriPermission(uri, bundleName, wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION | wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION, (err) => {
if (err) {
console.error("grantUriPermission failed with error: " + err);
return;
}
console.info("grantUriPermission success!");
});
} catch (error) {
console.error("grantUriPermission failed with error:" + error);
}
```
## fileShare.grantUriPermission
grantUriPermission(uri: string, bundleName: string, mode: number): Promise&lt;void&gt;
Grants permissions on a user file by the URI to an application. This API uses a promise to return the result.
**Required permissions**: ohos.permission.WRITE_MEDIA
**System API**: This is a system API.
**System capability**: SystemCapability.FileManagement.AppFileService
**Parameters**
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | -------------------------- |
| uri | string | Yes | URI of a user file.|
| bundleName | string | Yes | Bundle name of the application to be grated with the permissions.|
| mode | number | Yes | Permissions to grant. For details, see [wantConstant.Flags](js-apis-app-ability-wantConstant.md#wantconstantflags).<br>**wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION**: permission to read the file. <br>**wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION**: permission to write the file.|
**Return value**
| Type | Description |
| ---------------------------- | ---------- |
| Promise&lt;void&gt; | Promise that returns no value.|
**Error codes**
For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md).
| ID | Error Message |
| ---------------------------- | ---------- |
| 201 | Permission verification failed |
| 202 | The caller is not a system application |
| 401 | The input parameter is invalid |
| 143000001 | IPC error |
**Example**
```js
import wantConstant from '@ohos.app.ability.wantConstant';
let uri = 'datashare:///media/image/8';
let bundleName = 'com.demo.test';
try {
fileShare.grantUriPermission(uri, bundleName, wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION |
wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION).then(function () {
console.info("grantUriPermission success!");
}).catch(function (error) {
console.error("grantUriPermission failed with error:" + error);
});
} catch (error) {
console.error("grantUriPermission failed with error:" + error);
}
```
......@@ -158,9 +158,9 @@ OpenHarmony IDL容器数据类型与Ts数据类型、C++数据类型的对应关
> **注意**:请保证使用最新版的SDK,版本老旧可能导致部分语句报错。
若不存在,可对应版本前往[docs仓版本目录](https://gitee.com/openharmony/docs/tree/master/zh-cn/release-notes)下载SDK包,以[3.2Beta3版本](../../release-notes/OpenHarmony-v3.2-beta3.md#%E4%BB%8E%E9%95%9C%E5%83%8F%E7%AB%99%E7%82%B9%E8%8E%B7%E5%8F%96)为例,可通过镜像站点获取。
若不存在,可对应版本前往[docs仓版本目录](https://gitee.com/openharmony/docs/tree/master/zh-cn/release-notes)下载SDK包,以[3.2Beta3版本](https://gitee.com/openharmony/docs/blob/master/zh-cn/release-notes/OpenHarmony-v3.2-beta3.md)为例,可通过镜像站点获取。
关于如何替换DevEco Studio的SDK包具体操作,参考[full-SDK替换指南](../quick-start/full-sdk-switch-guide.md#full-sdk%E6%9B%BF%E6%8D%A2%E6%8C%87%E5%8D%97)中的替换方法。
关于如何替换DevEco Studio的SDK包具体操作,参考[full-SDK替换指南](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/quick-start/full-sdk-compile-guide.md)中的替换方法。
得到idl工具的可执行文件后,根据具体场景进行后续开发步骤。
......@@ -176,6 +176,8 @@ OpenHarmony IDL容器数据类型与Ts数据类型、C++数据类型的对应关
interface OHOS.IIdlTestService {
int TestIntTransaction([in] int data);
void TestStringTransaction([in] String data);
void TestMapTransaction([in] Map<int, int> data);
int TestArrayTransaction([in] String[] data);
}
```
......@@ -203,6 +205,8 @@ OpenHarmony IDL工具生成的Stub类是接口类的抽象实现,并且会声
```ts
import {testIntTransactionCallback} from "./i_idl_test_service";
import {testStringTransactionCallback} from "./i_idl_test_service";
import {testMapTransactionCallback} from "./i_idl_test_service";
import {testArrayTransactionCallback} from "./i_idl_test_service";
import IIdlTestService from "./i_idl_test_service";
import rpc from "@ohos.rpc";
......@@ -211,8 +215,8 @@ export default class IdlTestServiceStub extends rpc.RemoteObject implements IIdl
super(des);
}
async onRemoteRequestEx(code: number, data, reply, option): Promise<boolean> {
console.log("onRemoteRequestEx called, code = " + code);
async onRemoteMessageRequest(code: number, data, reply, option): Promise<boolean> {
console.log("onRemoteMessageRequest called, code = " + code);
switch(code) {
case IdlTestServiceStub.COMMAND_TEST_INT_TRANSACTION: {
let _data = data.readInt();
......@@ -231,6 +235,29 @@ export default class IdlTestServiceStub extends rpc.RemoteObject implements IIdl
});
return true;
}
case IdlTestServiceStub.COMMAND_TEST_MAP_TRANSACTION: {
let _data = new Map();
let _dataSize = data.readInt();
for (let i = 0; i < _dataSize; ++i) {
let key = data.readInt();
let value = data.readInt();
_data.set(key, value);
}
this.testMapTransaction(_data, (errCode) => {
reply.writeInt(errCode);
});
return true;
}
case IdlTestServiceStub.COMMAND_TEST_ARRAY_TRANSACTION: {
let _data = data.readStringArray();
this.testArrayTransaction(_data, (errCode, returnValue) => {
reply.writeInt(errCode);
if (errCode == 0) {
reply.writeInt(returnValue);
}
});
return true;
}
default: {
console.log("invalid request code" + code);
break;
......@@ -241,17 +268,23 @@ export default class IdlTestServiceStub extends rpc.RemoteObject implements IIdl
testIntTransaction(data: number, callback: testIntTransactionCallback): void{}
testStringTransaction(data: string, callback: testStringTransactionCallback): void{}
testMapTransaction(data: Map<number, number>, callback: testMapTransactionCallback): void{}
testArrayTransaction(data: string[], callback: testArrayTransactionCallback): void{}
static readonly COMMAND_TEST_INT_TRANSACTION = 1;
static readonly COMMAND_TEST_STRING_TRANSACTION = 2;
static readonly COMMAND_TEST_MAP_TRANSACTION = 3;
static readonly COMMAND_TEST_ARRAY_TRANSACTION = 4;
}
```
开发者需要继承.idl文件中定义的接口类并实现其中的方法。在本示例中,我们继承了IdlTestServiceStub接口类并实现了其中的testIntTransaction和testStringTransaction方法。具体的示例代码如下:
开发者需要继承.idl文件中定义的接口类并实现其中的方法。在本示例中,我们继承了IdlTestServiceStub接口类并实现了其中的testIntTransaction、testStringTransaction、testMapTransaction和testArrayTransaction方法。具体的示例代码如下:
```ts
import {testIntTransactionCallback} from "./i_idl_test_service"
import {testStringTransactionCallback} from "./i_idl_test_service"
import {testMapTransactionCallback} from "./i_idl_test_service";
import {testArrayTransactionCallback} from "./i_idl_test_service";
import IdlTestServiceStub from "./idl_test_service_stub"
......@@ -265,6 +298,14 @@ class IdlTestImp extends IdlTestServiceStub {
{
callback(0);
}
testMapTransaction(data: Map<number, number>, callback: testMapTransactionCallback): void
{
callback(0);
}
testArrayTransaction(data: string[], callback: testArrayTransactionCallback): void
{
callback(0, 1);
}
}
```
......@@ -320,11 +361,28 @@ function callbackTestStringTransaction(result: number): void {
}
}
function callbackTestMapTransaction(result: number): void {
if (result == 0) {
console.log('case 3 success');
}
}
function callbackTestArrayTransaction(result: number, ret: number): void {
if (result == 0 && ret == 124) {
console.log('case 4 success');
}
}
var onAbilityConnectDone = {
onConnect:function (elementName, proxy) {
let testProxy = new IdlTestServiceProxy(proxy);
let testMap = new Map();
testMap.set(1, 1);
testMap.set(1, 2);
testProxy.testIntTransaction(123, callbackTestIntTransaction);
testProxy.testStringTransaction('hello', callbackTestStringTransaction);
testProxy.testMapTransaction(testMap, callbackTestMapTransaction);
testProxy.testArrayTransaction(['1','2'], callbackTestMapTransaction);
},
onDisconnect:function (elementName) {
console.log('onDisconnectService onDisconnect');
......
......@@ -777,9 +777,11 @@ preloads标签示例:
**表14** **dependencies标签说明**
| 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| -------- | -------- | -------- | -------- |
| moduleName | 标识当前模块依赖的共享库模块名 | 字符串 | 不可缺省。 |
| 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| ----------- | ------------------------------ | -------- | ---------- |
| bundleName | 标识当前模块依赖的共享包包名。 | 字符串 | 可缺省。 |
| moduleName | 标识当前模块依赖的共享包模块名。| 字符串 | 不可缺省。 |
| versionCode | 标识当前共享包的版本号。 | 数值 | 可缺省。 |
dependencies标签示例:
......@@ -788,7 +790,9 @@ dependencies标签示例:
"module": {
"dependencies": [
{
"moduleName": "library"
"bundleName":"com.share.library",
"moduleName": "library",
"versionCode": 10001
}
]
}
......
......@@ -236,6 +236,7 @@
- [@ohos.file.environment (目录环境能力)](js-apis-file-environment.md)
- [@ohos.file.fileAccess (公共文件访问与管理)](js-apis-fileAccess.md)
- [@ohos.file.fileExtensionInfo (公共文件访问与管理属性信息)](js-apis-fileExtensionInfo.md)
- [@ohos.file.fileUri (文件URI)](js-apis-file-fileUri.md)
- [@ohos.file.fs (文件管理)](js-apis-file-fs.md)
- [@ohos.file.hash (文件哈希处理)](js-apis-file-hash.md)
- [@ohos.file.picker (选择器)](js-apis-file-picker.md)
......@@ -244,6 +245,7 @@
- [@ohos.file.storageStatistics (应用空间统计)](js-apis-file-storage-statistics.md)
- [@ohos.file.volumeManager (卷管理)](js-apis-file-volumemanager.md)
- [@ohos.filemanagement.userFileManager (用户数据管理)](js-apis-userFileManager.md)
- [@ohos.fileShare (文件分享)](js-apis-fileShare.md)
- 电话服务
- [@ohos.contact (联系人)](js-apis-contact.md)
......
......@@ -22,8 +22,7 @@ enableBluetooth(): boolean
开启蓝牙。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.enableBluetooth](js-apis-bluetoothManager.md#bluetoothmanagerenablebluetooth)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.enableBluetooth](js-apis-bluetoothManager.md#bluetoothmanagerenablebluetooth)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -49,8 +48,7 @@ disableBluetooth(): boolean
关闭蓝牙。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.disableBluetooth](js-apis-bluetoothManager.md#bluetoothmanagerdisablebluetooth)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.disableBluetooth](js-apis-bluetoothManager.md#bluetoothmanagerdisablebluetooth)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -76,8 +74,7 @@ getLocalName(): string
获取蓝牙本地设备名称。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.getLocalName](js-apis-bluetoothManager.md#bluetoothmanagergetlocalname)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.getLocalName](js-apis-bluetoothManager.md#bluetoothmanagergetlocalname)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -103,8 +100,7 @@ getState(): BluetoothState
获取蓝牙开关状态。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.getState](js-apis-bluetoothManager.md#bluetoothmanagergetstate)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.getState](js-apis-bluetoothManager.md#bluetoothmanagergetstate)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -127,11 +123,10 @@ let state = bluetooth.getState();
getBtConnectionState(): ProfileConnectionState
获取蓝牙设备的Profile连接状态
获取蓝牙本端的Profile连接状态,例如:任意一个支持的Profile连接状态为已连接,则此接口返回状态为已连接
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.getBtConnectionState](js-apis-bluetoothManager.md#bluetoothmanagergetbtconnectionstate)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.getBtConnectionState](js-apis-bluetoothManager.md#bluetoothmanagergetbtconnectionstate)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -157,8 +152,7 @@ setLocalName(name: string): boolean
设置蓝牙本地设备名称。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.setLocalName](js-apis-bluetoothManager.md#bluetoothmanagersetlocalname)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.setLocalName](js-apis-bluetoothManager.md#bluetoothmanagersetlocalname)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -190,8 +184,7 @@ pairDevice(deviceId: string): boolean
发起蓝牙配对。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.pairDevice](js-apis-bluetoothManager.md#bluetoothmanagerpairdevice)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.pairDevice](js-apis-bluetoothManager.md#bluetoothmanagerpairdevice)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -221,11 +214,10 @@ let result = bluetooth.pairDevice("XX:XX:XX:XX:XX:XX");
getProfileConnState(profileId: ProfileId): ProfileConnectionState
获取profile的连接状态。
依据ProfileId获取指定profile的连接状态。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.getProfileConnectionState](js-apis-bluetoothManager.md#bluetoothmanagergetprofileconnectionstate)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.getProfileConnectionState](js-apis-bluetoothManager.md#bluetoothmanagergetprofileconnectionstate)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -257,8 +249,7 @@ cancelPairedDevice(deviceId: string): boolean
删除配对的远程设备。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.cancelPairedDevice](js-apis-bluetoothManager.md#bluetoothmanagercancelpaireddevice)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.cancelPairedDevice](js-apis-bluetoothManager.md#bluetoothmanagercancelpaireddevice)替代。
**系统接口**:此接口为系统接口。
......@@ -292,8 +283,7 @@ getRemoteDeviceName(deviceId: string): string
获取对端蓝牙设备的名称。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.getRemoteDeviceName](js-apis-bluetoothManager.md#bluetoothmanagergetremotedevicename)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.getRemoteDeviceName](js-apis-bluetoothManager.md#bluetoothmanagergetremotedevicename)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -325,8 +315,7 @@ getRemoteDeviceClass(deviceId: string): DeviceClass
获取对端蓝牙设备的类别。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.getRemoteDeviceClass](js-apis-bluetoothManager.md#bluetoothmanagergetremotedeviceclass)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.getRemoteDeviceClass](js-apis-bluetoothManager.md#bluetoothmanagergetremotedeviceclass)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -358,8 +347,7 @@ getPairedDevices(): Array&lt;string&gt;
获取蓝牙配对列表。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.getPairedDevices](js-apis-bluetoothManager.md#bluetoothmanagergetpaireddevices)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.getPairedDevices](js-apis-bluetoothManager.md#bluetoothmanagergetpaireddevices)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -385,8 +373,7 @@ setBluetoothScanMode(mode: ScanMode, duration: number): boolean
设置蓝牙扫描模式,可以被远端设备发现。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.setBluetoothScanMode](js-apis-bluetoothManager.md#bluetoothmanagersetbluetoothscanmode)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.setBluetoothScanMode](js-apis-bluetoothManager.md#bluetoothmanagersetbluetoothscanmode)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -420,8 +407,7 @@ getBluetoothScanMode(): ScanMode
获取蓝牙扫描模式。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.getBluetoothScanMode](js-apis-bluetoothManager.md#bluetoothmanagergetbluetoothscanmode)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.getBluetoothScanMode](js-apis-bluetoothManager.md#bluetoothmanagergetbluetoothscanmode)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -447,8 +433,7 @@ startBluetoothDiscovery(): boolean
开启蓝牙扫描,可以发现远端设备。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.startBluetoothDiscovery](js-apis-bluetoothManager.md#bluetoothmanagerstartbluetoothdiscovery)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.startBluetoothDiscovery](js-apis-bluetoothManager.md#bluetoothmanagerstartbluetoothdiscovery)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH 和 ohos.permission.LOCATION
......@@ -479,8 +464,7 @@ stopBluetoothDiscovery(): boolean
关闭蓝牙扫描。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.stopBluetoothDiscovery](js-apis-bluetoothManager.md#bluetoothmanagerstopbluetoothdiscovery)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.stopBluetoothDiscovery](js-apis-bluetoothManager.md#bluetoothmanagerstopbluetoothdiscovery)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -506,8 +490,7 @@ setDevicePairingConfirmation(device: string, accept: boolean): boolean
设置设备配对请求确认。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.setDevicePairingConfirmation](js-apis-bluetoothManager.md#bluetoothmanagersetdevicepairingconfirmation)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.setDevicePairingConfirmation](js-apis-bluetoothManager.md#bluetoothmanagersetdevicepairingconfirmation)替代。
**需要权限**:ohos.permission.MANAGE_BLUETOOTH
......@@ -545,8 +528,7 @@ on(type: "bluetoothDeviceFind", callback: Callback&lt;Array&lt;string&gt;&gt;):
订阅蓝牙设备发现上报事件。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.on('bluetoothDeviceFind')](js-apis-bluetoothManager.md#bluetoothmanageronbluetoothdevicefind)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.on('bluetoothDeviceFind')](js-apis-bluetoothManager.md#bluetoothmanageronbluetoothdevicefind)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -580,8 +562,7 @@ off(type: "bluetoothDeviceFind", callback?: Callback&lt;Array&lt;string&gt;&gt;)
取消订阅蓝牙设备发现上报事件。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.off('bluetoothDeviceFind')](js-apis-bluetoothManager.md#bluetoothmanageroffbluetoothdevicefind)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.off('bluetoothDeviceFind')](js-apis-bluetoothManager.md#bluetoothmanageroffbluetoothdevicefind)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -616,8 +597,7 @@ on(type: "pinRequired", callback: Callback&lt;PinRequiredParam&gt;): void
订阅远端蓝牙设备的配对请求事件。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.on('pinRequired')](js-apis-bluetoothManager.md#bluetoothmanageronpinrequired)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.on('pinRequired')](js-apis-bluetoothManager.md#bluetoothmanageronpinrequired)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -651,8 +631,7 @@ off(type: "pinRequired", callback?: Callback&lt;PinRequiredParam&gt;): void
取消订阅远端蓝牙设备的配对请求事件。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.off('pinRequired')](js-apis-bluetoothManager.md#bluetoothmanageroffpinrequired)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.off('pinRequired')](js-apis-bluetoothManager.md#bluetoothmanageroffpinrequired)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -687,8 +666,7 @@ on(type: "bondStateChange", callback: Callback&lt;BondStateParam&gt;): void
订阅蓝牙配对状态改变事件。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.on('bondStateChange')](js-apis-bluetoothManager.md#bluetoothmanageronbondstatechange)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.on('bondStateChange')](js-apis-bluetoothManager.md#bluetoothmanageronbondstatechange)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -722,8 +700,7 @@ off(type: "bondStateChange", callback?: Callback&lt;BondStateParam&gt;): void
取消订阅蓝牙配对状态改变事件。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.off('bondStateChange')](js-apis-bluetoothManager.md#bluetoothmanageroffbondstatechange)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.off('bondStateChange')](js-apis-bluetoothManager.md#bluetoothmanageroffbondstatechange)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -758,8 +735,7 @@ on(type: "stateChange", callback: Callback&lt;BluetoothState&gt;): void
订阅蓝牙连接状态改变事件。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.on('stateChange')](js-apis-bluetoothManager.md#bluetoothmanageronstatechange)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.on('stateChange')](js-apis-bluetoothManager.md#bluetoothmanageronstatechange)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -793,8 +769,7 @@ off(type: "stateChange", callback?: Callback&lt;BluetoothState&gt;): void
取消订阅蓝牙连接状态改变事件。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.off('stateChange')](js-apis-bluetoothManager.md#bluetoothmanageroffstatechange)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.off('stateChange')](js-apis-bluetoothManager.md#bluetoothmanageroffstatechange)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -829,8 +804,7 @@ sppListen(name: string, option: SppOption, callback: AsyncCallback&lt;number&gt;
创建一个服务端监听Socket。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.sppListen](js-apis-bluetoothManager.md#bluetoothmanagerspplisten)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.sppListen](js-apis-bluetoothManager.md#bluetoothmanagerspplisten)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -868,8 +842,7 @@ sppAccept(serverSocket: number, callback: AsyncCallback&lt;number&gt;): void
服务端监听socket等待客户端连接。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.sppAccept](js-apis-bluetoothManager.md#bluetoothmanagersppaccept)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.sppAccept](js-apis-bluetoothManager.md#bluetoothmanagersppaccept)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -911,8 +884,7 @@ sppConnect(device: string, option: SppOption, callback: AsyncCallback&lt;number&
客户端向远端设备发起spp连接。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.sppConnect](js-apis-bluetoothManager.md#bluetoothmanagersppconnect)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.sppConnect](js-apis-bluetoothManager.md#bluetoothmanagersppconnect)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -951,8 +923,7 @@ sppCloseServerSocket(socket: number): void
关闭服务端监听Socket,入参socket由sppListen接口返回。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.sppCloseServerSocket](js-apis-bluetoothManager.md#bluetoothmanagersppcloseserversocket)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.sppCloseServerSocket](js-apis-bluetoothManager.md#bluetoothmanagersppcloseserversocket)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -984,8 +955,7 @@ sppCloseClientSocket(socket: number): void
关闭客户端socket,入参socket由sppAccept或sppConnect接口获取。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.sppCloseClientSocket](js-apis-bluetoothManager.md#bluetoothmanagersppcloseclientsocket)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.sppCloseClientSocket](js-apis-bluetoothManager.md#bluetoothmanagersppcloseclientsocket)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -1019,8 +989,7 @@ sppWrite(clientSocket: number, data: ArrayBuffer): boolean
通过socket向远端发送数据,入参clientSocket由sppAccept或sppConnect接口获取 。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.sppWrite](js-apis-bluetoothManager.md#bluetoothmanagersppwrite)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.sppWrite](js-apis-bluetoothManager.md#bluetoothmanagersppwrite)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -1066,8 +1035,7 @@ if (ret) {
on(type: "sppRead", clientSocket: number, callback: Callback&lt;ArrayBuffer&gt;): void
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.on('sppRead')](js-apis-bluetoothManager.md#bluetoothmanageronsppread)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.on('sppRead')](js-apis-bluetoothManager.md#bluetoothmanageronsppread)替代。
订阅spp读请求事件,入参clientSocket由sppAccept或sppConnect接口获取。
......@@ -1112,8 +1080,7 @@ off(type: "sppRead", clientSocket: number, callback?: Callback&lt;ArrayBuffer&gt
取消订阅spp读请求事件,入参clientSocket由sppAccept或sppConnect接口获取。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.off('sppRead')](js-apis-bluetoothManager.md#bluetoothmanageroffsppread)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.off('sppRead')](js-apis-bluetoothManager.md#bluetoothmanageroffsppread)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -1152,8 +1119,7 @@ getProfile(profileId: ProfileId): A2dpSourceProfile | HandsFreeAudioGatewayProfi
通过ProfileId,获取profile的对象实例。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.getProfileInstance](js-apis-bluetoothManager.md#bluetoothmanagergetprofileinstance)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.getProfileInstance](js-apis-bluetoothManager.md#bluetoothmanagergetprofileinstance)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -1185,8 +1151,7 @@ createGattServer(): GattServer
创建一个可使用的GattServer实例。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BLE.createGattServer](js-apis-bluetoothManager.md#bluetoothmanagerblecreategattserver)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BLE.createGattServer](js-apis-bluetoothManager.md#bluetoothmanagerblecreategattserver)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -1210,8 +1175,7 @@ createGattClientDevice(deviceId: string): GattClientDevice
创建一个可使用的GattClientDevice实例。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BLE.createGattClientDevice](js-apis-bluetoothManager.md#bluetoothmanagerblecreategattclientdevice)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BLE.createGattClientDevice](js-apis-bluetoothManager.md#bluetoothmanagerblecreategattclientdevice)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -1241,8 +1205,7 @@ getConnectedBLEDevices(): Array&lt;string&gt;
获取和当前设备连接的BLE设备。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BLE.getConnectedBLEDevices](js-apis-bluetoothManager.md#bluetoothmanagerblegetconnectedbledevices)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BLE.getConnectedBLEDevices](js-apis-bluetoothManager.md#bluetoothmanagerblegetconnectedbledevices)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -1268,8 +1231,7 @@ startBLEScan(filters: Array&lt;ScanFilter&gt;, options?: ScanOptions): void
发起BLE扫描流程。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BLE.startBLEScan](js-apis-bluetoothManager.md#bluetoothmanagerblestartblescan)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BLE.startBLEScan](js-apis-bluetoothManager.md#bluetoothmanagerblestartblescan)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH 和 ohos.permission.MANAGE_BLUETOOTH 和 ohos.permission.LOCATION
......@@ -1315,8 +1277,7 @@ stopBLEScan(): void
停止BLE扫描流程。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BLE.stopBLEScan](js-apis-bluetoothManager.md#bluetoothmanagerblestopblescan)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BLE.stopBLEScan](js-apis-bluetoothManager.md#bluetoothmanagerblestopblescan)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -1340,8 +1301,7 @@ on(type: "BLEDeviceFind", callback: Callback&lt;Array&lt;ScanResult&gt;&gt;): vo
订阅BLE设备发现上报事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BLE.on('BLEDeviceFind')](js-apis-bluetoothManager.md#bluetoothmanagerbleonbledevicefind)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BLE.on('BLEDeviceFind')](js-apis-bluetoothManager.md#bluetoothmanagerbleonbledevicefind)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -1375,8 +1335,7 @@ off(type: "BLEDeviceFind", callback?: Callback&lt;Array&lt;ScanResult&gt;&gt;):
取消订阅BLE设备发现上报事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BLE.off('BLEDeviceFind')](js-apis-bluetoothManager.md#bluetoothmanagerbleoffbledevicefind)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BLE.off('BLEDeviceFind')](js-apis-bluetoothManager.md#bluetoothmanagerbleoffbledevicefind)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -1416,8 +1375,7 @@ getConnectionDevices(): Array&lt;string&gt;
获取已连接设备列表。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BaseProfile.getConnectionDevices](js-apis-bluetoothManager.md#getconnectiondevices)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BaseProfile.getConnectionDevices](js-apis-bluetoothManager.md#getconnectiondevices)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -1443,8 +1401,7 @@ getDeviceState(device: string): ProfileConnectionState
获取设备profile的连接状态。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BaseProfile.getDeviceState](js-apis-bluetoothManager.md#getdevicestate)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BaseProfile.getDeviceState](js-apis-bluetoothManager.md#getdevicestate)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -1481,8 +1438,7 @@ connect(device: string): boolean
发起设备的A2dp服务连接请求。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.A2dpSourceProfile.connect](js-apis-bluetoothManager.md#connect)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.A2dpSourceProfile.connect](js-apis-bluetoothManager.md#connect)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -1515,8 +1471,7 @@ disconnect(device: string): boolean
断开设备的a2dp服务连接。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.A2dpSourceProfile.disconnect](js-apis-bluetoothManager.md#disconnect)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.A2dpSourceProfile.disconnect](js-apis-bluetoothManager.md#disconnect)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -1549,8 +1504,7 @@ on(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Stat
订阅a2dp连接状态变化事件。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.A2dpSourceProfile.on('connectionStateChange')](js-apis-bluetoothManager.md#onconnectionstatechange)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.A2dpSourceProfile.on('connectionStateChange')](js-apis-bluetoothManager.md#onconnectionstatechange)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -1583,8 +1537,7 @@ off(type: "connectionStateChange", callback?: Callback&lt;[StateChangeParam](#St
取消订阅a2dp连接状态变化事件。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.A2dpSourceProfile.off('connectionStateChange')](js-apis-bluetoothManager.md#offconnectionstatechange)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.A2dpSourceProfile.off('connectionStateChange')](js-apis-bluetoothManager.md#offconnectionstatechange)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -1618,8 +1571,7 @@ getPlayingState(device: string): PlayingState
获取设备的播放状态。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.A2dpSourceProfile.getPlayingState](js-apis-bluetoothManager.md#getplayingstate)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.A2dpSourceProfile.getPlayingState](js-apis-bluetoothManager.md#getplayingstate)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -1655,8 +1607,7 @@ connect(device: string): boolean
连接设备的HFP服务。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.HandsFreeAudioGatewayProfile.connect](js-apis-bluetoothManager.md#connect-1)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.HandsFreeAudioGatewayProfile.connect](js-apis-bluetoothManager.md#connect-1)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -1690,8 +1641,7 @@ disconnect(device: string): boolean
断开连接设备的HFP服务。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.HandsFreeAudioGatewayProfile.disconnect](js-apis-bluetoothManager.md#disconnect-1)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.HandsFreeAudioGatewayProfile.disconnect](js-apis-bluetoothManager.md#disconnect-1)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -1725,8 +1675,7 @@ on(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Stat
订阅HFP连接状态变化事件。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.HandsFreeAudioGatewayProfile.on('connectionStateChange')](js-apis-bluetoothManager.md#onconnectionstatechange-1)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.HandsFreeAudioGatewayProfile.on('connectionStateChange')](js-apis-bluetoothManager.md#onconnectionstatechange-1)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -1760,8 +1709,7 @@ off(type: "connectionStateChange", callback?: Callback&lt;[StateChangeParam](#St
取消订阅HFP连接状态变化事件。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.HandsFreeAudioGatewayProfile.off('connectionStateChange')](js-apis-bluetoothManager.md#offconnectionstatechange-1)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.HandsFreeAudioGatewayProfile.off('connectionStateChange')](js-apis-bluetoothManager.md#offconnectionstatechange-1)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -1801,8 +1749,7 @@ startAdvertising(setting: AdvertiseSetting, advData: AdvertiseData, advResponse?
开始发送BLE广播。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.startAdvertising](js-apis-bluetoothManager.md#startadvertising)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.startAdvertising](js-apis-bluetoothManager.md#startadvertising)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -1872,8 +1819,7 @@ stopAdvertising(): void
停止发送BLE广播。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.stopAdvertising](js-apis-bluetoothManager.md#stopadvertising)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.stopAdvertising](js-apis-bluetoothManager.md#stopadvertising)替代。
**需要权限**:ohos.permission.DISCOVER_BLUETOOTH
......@@ -1898,8 +1844,7 @@ addService(service: GattService): boolean
server端添加服务。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.addService](js-apis-bluetoothManager.md#addservice)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.addService](js-apis-bluetoothManager.md#addservice)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -1961,8 +1906,7 @@ removeService(serviceUuid: string): boolean
删除已添加的服务。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.removeService](js-apis-bluetoothManager.md#removeservice)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.removeService](js-apis-bluetoothManager.md#removeservice)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -1995,8 +1939,7 @@ close(): void
关闭服务端功能,去注册server在协议栈的注册,调用该接口后[GattServer](#gattserver)实例将不能再使用。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.close](js-apis-bluetoothManager.md#close)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.close](js-apis-bluetoothManager.md#close)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2017,8 +1960,7 @@ notifyCharacteristicChanged(deviceId: string, notifyCharacteristic: NotifyCharac
server端特征值发生变化时,主动通知已连接的client设备。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.notifyCharacteristicChanged](js-apis-bluetoothManager.md#notifycharacteristicchanged)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.notifyCharacteristicChanged](js-apis-bluetoothManager.md#notifycharacteristicchanged)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2066,8 +2008,7 @@ sendResponse(serverResponse: ServerResponse): boolean
server端回复client端的读写请求。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.sendResponse](js-apis-bluetoothManager.md#sendresponse)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.sendResponse](js-apis-bluetoothManager.md#sendresponse)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2117,8 +2058,7 @@ on(type: "characteristicRead", callback: Callback&lt;CharacteristicReadReq&gt;):
server端订阅特征值读请求事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.on('characteristicRead')](js-apis-bluetoothManager.md#oncharacteristicread)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.on('characteristicRead')](js-apis-bluetoothManager.md#oncharacteristicread)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2169,8 +2109,7 @@ off(type: "characteristicRead", callback?: Callback&lt;CharacteristicReadReq&gt;
server端取消订阅特征值读请求事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.off('characteristicRead')](js-apis-bluetoothManager.md#offcharacteristicread)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.off('characteristicRead')](js-apis-bluetoothManager.md#offcharacteristicread)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2202,8 +2141,7 @@ on(type: "characteristicWrite", callback: Callback&lt;CharacteristicWriteReq&gt;
server端订阅特征值写请求事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.on('characteristicWrite')](js-apis-bluetoothManager.md#oncharacteristicwrite)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.on('characteristicWrite')](js-apis-bluetoothManager.md#oncharacteristicwrite)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2257,8 +2195,7 @@ off(type: "characteristicWrite", callback?: Callback&lt;CharacteristicWriteReq&g
server端取消订阅特征值写请求事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.off('characteristicWrite')](js-apis-bluetoothManager.md#offcharacteristicwrite)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.off('characteristicWrite')](js-apis-bluetoothManager.md#offcharacteristicwrite)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2290,8 +2227,7 @@ on(type: "descriptorRead", callback: Callback&lt;DescriptorReadReq&gt;): void
server端订阅描述符读请求事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.on('descriptorRead')](js-apis-bluetoothManager.md#ondescriptorread)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.on('descriptorRead')](js-apis-bluetoothManager.md#ondescriptorread)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2342,8 +2278,7 @@ off(type: "descriptorRead", callback?: Callback&lt;DescriptorReadReq&gt;): void
server端取消订阅描述符读请求事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.off('descriptorRead')](js-apis-bluetoothManager.md#offdescriptorread)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.off('descriptorRead')](js-apis-bluetoothManager.md#offdescriptorread)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2375,8 +2310,7 @@ on(type: "descriptorWrite", callback: Callback&lt;DescriptorWriteReq&gt;): void
server端订阅描述符写请求事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.on('descriptorWrite')](js-apis-bluetoothManager.md#ondescriptorwrite)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.on('descriptorWrite')](js-apis-bluetoothManager.md#ondescriptorwrite)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2430,8 +2364,7 @@ off(type: "descriptorWrite", callback?: Callback&lt;DescriptorWriteReq&gt;): voi
server端取消订阅描述符写请求事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.off('descriptorWrite')](js-apis-bluetoothManager.md#offdescriptorwrite)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.off('descriptorWrite')](js-apis-bluetoothManager.md#offdescriptorwrite)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2463,8 +2396,7 @@ on(type: "connectStateChange", callback: Callback&lt;BLEConnectChangedState&gt;)
server端订阅BLE连接状态变化事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.on('connectStateChange')](js-apis-bluetoothManager.md#onconnectstatechange)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.on('connectStateChange')](js-apis-bluetoothManager.md#onconnectstatechange)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2501,8 +2433,7 @@ off(type: "connectStateChange", callback?: Callback&lt;BLEConnectChangedState&gt
server端取消订阅BLE连接状态变化事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattServer.off('connectStateChange')](js-apis-bluetoothManager.md#offconnectstatechange)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattServer.off('connectStateChange')](js-apis-bluetoothManager.md#offconnectstatechange)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2539,8 +2470,7 @@ connect(): boolean
client端发起连接远端蓝牙低功耗设备。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.connect](js-apis-bluetoothManager.md#connect-3)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.connect](js-apis-bluetoothManager.md#connect-3)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2567,8 +2497,7 @@ disconnect(): boolean
client端断开与远端蓝牙低功耗设备的连接。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.disconnect](js-apis-bluetoothManager.md#disconnect-4)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.disconnect](js-apis-bluetoothManager.md#disconnect-4)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2595,8 +2524,7 @@ close(): boolean
关闭客户端功能,注销client在协议栈的注册,调用该接口后[GattClientDevice](#gattclientdevice)实例将不能再使用。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.close](js-apis-bluetoothManager.md#close-1)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.close](js-apis-bluetoothManager.md#close-1)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2625,8 +2553,7 @@ getServices(callback: AsyncCallback&lt;Array&lt;GattService&gt;&gt;): void
client端获取蓝牙低功耗设备的所有服务,即服务发现 。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.getServices](js-apis-bluetoothManager.md#getservices)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.getServices](js-apis-bluetoothManager.md#getservices)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2671,8 +2598,7 @@ getServices(): Promise&lt;Array&lt;GattService&gt;&gt;
client端获取蓝牙低功耗设备的所有服务,即服务发现。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.getServices](js-apis-bluetoothManager.md#getservices-1)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.getServices](js-apis-bluetoothManager.md#getservices-1)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2703,8 +2629,7 @@ readCharacteristicValue(characteristic: BLECharacteristic, callback: AsyncCallba
client端读取蓝牙低功耗设备特定服务的特征值。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.readCharacteristicValue](js-apis-bluetoothManager.md#readcharacteristicvalue)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.readCharacteristicValue](js-apis-bluetoothManager.md#readcharacteristicvalue)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2761,8 +2686,7 @@ readCharacteristicValue(characteristic: BLECharacteristic): Promise&lt;BLECharac
client端读取蓝牙低功耗设备特定服务的特征值。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.readCharacteristicValue](js-apis-bluetoothManager.md#readcharacteristicvalue-1)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.readCharacteristicValue](js-apis-bluetoothManager.md#readcharacteristicvalue-1)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2811,8 +2735,7 @@ readDescriptorValue(descriptor: BLEDescriptor, callback: AsyncCallback&lt;BLEDes
client端读取蓝牙低功耗设备特定的特征包含的描述符。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.readDescriptorValue](js-apis-bluetoothManager.md#readdescriptorvalue)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.readDescriptorValue](js-apis-bluetoothManager.md#readdescriptorvalue)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2859,8 +2782,7 @@ readDescriptorValue(descriptor: BLEDescriptor): Promise&lt;BLEDescriptor&gt;
client端读取蓝牙低功耗设备特定的特征包含的描述符。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.readDescriptorValue](js-apis-bluetoothManager.md#readdescriptorvalue-1)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.readDescriptorValue](js-apis-bluetoothManager.md#readdescriptorvalue-1)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2899,8 +2821,7 @@ writeCharacteristicValue(characteristic: BLECharacteristic): boolean
client端向低功耗蓝牙设备写入特定的特征值。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.writeCharacteristicValue](js-apis-bluetoothManager.md#writecharacteristicvalue)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.writeCharacteristicValue](js-apis-bluetoothManager.md#writecharacteristicvalue)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2953,8 +2874,7 @@ writeDescriptorValue(descriptor: BLEDescriptor): boolean
client端向低功耗蓝牙设备特定的描述符写入二进制数据。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.writeDescriptorValue](js-apis-bluetoothManager.md#writedescriptorvalue)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.writeDescriptorValue](js-apis-bluetoothManager.md#writedescriptorvalue)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -2998,8 +2918,7 @@ setBLEMtuSize(mtu: number): boolean
client协商远端蓝牙低功耗设备的最大传输单元(Maximum Transmission Unit, MTU),调用[connect](#connect)接口连接成功后才能使用。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.setBLEMtuSize](js-apis-bluetoothManager.md#setblemtusize)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.setBLEMtuSize](js-apis-bluetoothManager.md#setblemtusize)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -3032,8 +2951,7 @@ setNotifyCharacteristicChanged(characteristic: BLECharacteristic, enable: boolea
向服务端发送设置通知此特征值请求。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.setNotifyCharacteristicChanged](js-apis-bluetoothManager.md#setnotifycharacteristicchanged)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.setNotifyCharacteristicChanged](js-apis-bluetoothManager.md#setnotifycharacteristicchanged)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -3079,8 +2997,7 @@ on(type: "BLECharacteristicChange", callback: Callback&lt;BLECharacteristic&gt;)
订阅蓝牙低功耗设备的特征值变化事件。需要先调用setNotifyCharacteristicChanged接口才能接收server端的通知。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.on('BLECharacteristicChange')](js-apis-bluetoothManager.md#onblecharacteristicchange)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.on('BLECharacteristicChange')](js-apis-bluetoothManager.md#onblecharacteristicchange)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -3117,8 +3034,7 @@ off(type: "BLECharacteristicChange", callback?: Callback&lt;BLECharacteristic&gt
取消订阅蓝牙低功耗设备的特征值变化事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.off('BLECharacteristicChange')](js-apis-bluetoothManager.md#offblecharacteristicchange)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.off('BLECharacteristicChange')](js-apis-bluetoothManager.md#offblecharacteristicchange)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -3150,8 +3066,7 @@ on(type: "BLEConnectionStateChange", callback: Callback&lt;BLEConnectChangedStat
client端订阅蓝牙低功耗设备的连接状态变化事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.on('BLEConnectionStateChange')](js-apis-bluetoothManager.md#onbleconnectionstatechange)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.on('BLEConnectionStateChange')](js-apis-bluetoothManager.md#onbleconnectionstatechange)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -3187,8 +3102,7 @@ off(type: "BLEConnectionStateChange", callback?: Callback&lt;BLEConnectChangedSt
取消订阅蓝牙低功耗设备的连接状态变化事件。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.off('BLEConnectionStateChange')](js-apis-bluetoothManager.md#offbleconnectionstatechange)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.off('BLEConnectionStateChange')](js-apis-bluetoothManager.md#offbleconnectionstatechange)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -3220,8 +3134,7 @@ getDeviceName(callback: AsyncCallback&lt;string&gt;): void
client获取远端蓝牙低功耗设备名。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.getDeviceName](js-apis-bluetoothManager.md#getdevicename)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.getDeviceName](js-apis-bluetoothManager.md#getdevicename)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -3256,8 +3169,7 @@ getDeviceName(): Promise&lt;string&gt;
client获取远端蓝牙低功耗设备名。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.getDeviceName](js-apis-bluetoothManager.md#getdevicename-1)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.getDeviceName](js-apis-bluetoothManager.md#getdevicename-1)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -3288,8 +3200,7 @@ getRssiValue(callback: AsyncCallback&lt;number&gt;): void
client获取远端蓝牙低功耗设备的信号强度 (Received Signal Strength Indication, RSSI),调用[connect](#connect)接口连接成功后才能使用。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.getRssiValue](js-apis-bluetoothManager.md#getrssivalue)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.getRssiValue](js-apis-bluetoothManager.md#getrssivalue)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -3325,8 +3236,7 @@ getRssiValue(): Promise&lt;number&gt;
client获取远端蓝牙低功耗设备的信号强度 (Received Signal Strength Indication, RSSI),调用[connect](#connect)接口连接成功后才能使用。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattClientDevice.getRssiValue](js-apis-bluetoothManager.md#getrssivalue-1)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattClientDevice.getRssiValue](js-apis-bluetoothManager.md#getrssivalue-1)替代。
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -3353,8 +3263,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
枚举,扫描模式。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.ScanMode](js-apis-bluetoothManager.md#scanmode)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.ScanMode](js-apis-bluetoothManager.md#scanmode)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3372,8 +3281,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
枚举,配对状态。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BondState](js-apis-bluetoothManager.md#bondstate)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BondState](js-apis-bluetoothManager.md#bondstate)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3389,8 +3297,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述spp的配置参数。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.SppOption](js-apis-bluetoothManager.md#sppoption)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.SppOption](js-apis-bluetoothManager.md#sppoption)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3406,8 +3313,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
枚举,Spp链路类型。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.SppType](js-apis-bluetoothManager.md#spptype)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.SppType](js-apis-bluetoothManager.md#spptype)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3421,8 +3327,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述service的接口参数定义。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.GattService](js-apis-bluetoothManager.md#gattservice)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.GattService](js-apis-bluetoothManager.md#gattservice)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3439,8 +3344,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述characteristic的接口参数定义 。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BLECharacteristic](js-apis-bluetoothManager.md#blecharacteristic)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BLECharacteristic](js-apis-bluetoothManager.md#blecharacteristic)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3457,8 +3361,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述descriptor的接口参数定义 。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BLEDescriptor](js-apis-bluetoothManager.md#bledescriptor)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BLEDescriptor](js-apis-bluetoothManager.md#bledescriptor)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3475,8 +3378,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述server端特征值变化时发送的特征通知参数定义。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.NotifyCharacteristic](js-apis-bluetoothManager.md#notifycharacteristic)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.NotifyCharacteristic](js-apis-bluetoothManager.md#notifycharacteristic)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3493,8 +3395,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述server端订阅后收到的特征值读请求事件参数结构。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.CharacteristicReadRequest](js-apis-bluetoothManager.md#characteristicreadrequest)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.CharacteristicReadRequest](js-apis-bluetoothManager.md#characteristicreadrequest)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3512,8 +3413,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述server端订阅后收到的特征值写请求事件参数结构。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.CharacteristicWriteRequest](js-apis-bluetoothManager.md#characteristicwriterequest)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.CharacteristicWriteRequest](js-apis-bluetoothManager.md#characteristicwriterequest)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3532,8 +3432,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述server端订阅后收到的描述符读请求事件参数结构。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.DescriptorReadRequest](js-apis-bluetoothManager.md#descriptorreadrequest)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.DescriptorReadRequest](js-apis-bluetoothManager.md#descriptorreadrequest)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3552,8 +3451,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述server端订阅后收到的描述符写请求事件参数结构。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.DescriptorWriteRequest](js-apis-bluetoothManager.md#descriptorwriterequest)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.DescriptorWriteRequest](js-apis-bluetoothManager.md#descriptorwriterequest)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3575,8 +3473,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述server端回复client端读/写请求的响应参数结构。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.ServerResponse](js-apis-bluetoothManager.md#serverresponse)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.ServerResponse](js-apis-bluetoothManager.md#serverresponse)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3594,8 +3491,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述Gatt profile连接状态 。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BLEConnectChangedState](js-apis-bluetoothManager.md#bleconnectchangedstate)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BLEConnectChangedState](js-apis-bluetoothManager.md#bleconnectchangedstate)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3610,8 +3506,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
枚举,蓝牙设备的profile连接状态。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.ProfileConnectionState](js-apis-bluetoothManager.md#profileconnectionstate)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.ProfileConnectionState](js-apis-bluetoothManager.md#profileconnectionstate)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3628,8 +3523,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
扫描过滤参数。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.ScanFilter](js-apis-bluetoothManager.md#scanfilter)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.ScanFilter](js-apis-bluetoothManager.md#scanfilter)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3645,8 +3539,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
扫描的配置参数。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.ScanOptions](js-apis-bluetoothManager.md#scanoptions)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.ScanOptions](js-apis-bluetoothManager.md#scanoptions)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3662,8 +3555,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
枚举,扫描模式。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.ScanDuty](js-apis-bluetoothManager.md#scanduty)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.ScanDuty](js-apis-bluetoothManager.md#scanduty)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3679,8 +3571,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
枚举,硬件过滤匹配模式。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.MatchMode](js-apis-bluetoothManager.md#matchmode)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.MatchMode](js-apis-bluetoothManager.md#matchmode)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3695,8 +3586,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
扫描结果上报数据。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.ScanResult](js-apis-bluetoothManager.md#scanresult)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.ScanResult](js-apis-bluetoothManager.md#scanresult)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3712,8 +3602,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
枚举,蓝牙开关状态。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BluetoothState](js-apis-bluetoothManager.md#bluetoothstate)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BluetoothState](js-apis-bluetoothManager.md#bluetoothstate)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3733,8 +3622,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述蓝牙低功耗设备发送广播的参数。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.AdvertiseSetting](js-apis-bluetoothManager.md#advertisesetting)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.AdvertiseSetting](js-apis-bluetoothManager.md#advertisesetting)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3750,8 +3638,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述BLE广播数据包的内容。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.AdvertiseData](js-apis-bluetoothManager.md#advertisedata)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.AdvertiseData](js-apis-bluetoothManager.md#advertisedata)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3767,8 +3654,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述BLE广播数据包的内容。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.ManufactureData](js-apis-bluetoothManager.md#manufacturedata)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.ManufactureData](js-apis-bluetoothManager.md#manufacturedata)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3783,8 +3669,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述广播包中服务数据内容。
> **说明:**<br/>
> 从API version 7开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.ServiceData](js-apis-bluetoothManager.md#servicedata)替代。
> 从API version 7开始支持,从API version 9开始废弃。建议使用[bluetoothManager.ServiceData](js-apis-bluetoothManager.md#servicedata)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3799,8 +3684,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述配对请求参数。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.PinRequiredParam](js-apis-bluetoothManager.md#pinrequiredparam)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.PinRequiredParam](js-apis-bluetoothManager.md#pinrequiredparam)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3815,8 +3699,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述配对状态参数。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.BondStateParam](js-apis-bluetoothManager.md#bondstateparam)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.BondStateParam](js-apis-bluetoothManager.md#bondstateparam)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3831,8 +3714,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述profile状态改变参数。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.StateChangeParam](js-apis-bluetoothManager.md#statechangeparam)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.StateChangeParam](js-apis-bluetoothManager.md#statechangeparam)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3847,8 +3729,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
描述蓝牙设备的类别。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.DeviceClass](js-apis-bluetoothManager.md#deviceclass)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.DeviceClass](js-apis-bluetoothManager.md#deviceclass)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3865,8 +3746,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
枚举,蓝牙设备主要类别。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.MajorClass](js-apis-bluetoothManager.md#majorclass)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.MajorClass](js-apis-bluetoothManager.md#majorclass)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3890,8 +3770,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
枚举,主要次要蓝牙设备类别。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.MajorMinorClass](js-apis-bluetoothManager.md#majorminorclass)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.MajorMinorClass](js-apis-bluetoothManager.md#majorminorclass)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -3990,8 +3869,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
枚举,蓝牙A2DP 播放状态。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.PlayingState](js-apis-bluetoothManager.md#playingstate)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.PlayingState](js-apis-bluetoothManager.md#playingstate)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......@@ -4006,8 +3884,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
蓝牙profile枚举,API9新增PROFILE_HID_HOST,PROFILE_PAN_NETWORK。
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[bluetoothManager.ProfileId](js-apis-bluetoothManager.md#profileid)替代。
> 从API version 8开始支持,从API version 9开始废弃。建议使用[bluetoothManager.ProfileId](js-apis-bluetoothManager.md#profileid)替代。
**系统能力**:SystemCapability.Communication.Bluetooth.Core。
......
......@@ -151,7 +151,7 @@ try {
getBtConnectionState(): ProfileConnectionState
获取蓝牙设备的Profile连接状态
获取蓝牙本端的Profile连接状态,例如:任意一个支持的Profile连接状态为已连接,则此接口返回状态为已连接
**需要权限**:ohos.permission.USE_BLUETOOTH
......@@ -263,7 +263,7 @@ try {
getProfileConnectionState(profileId: ProfileId): ProfileConnectionState
获取profile的连接状态。
依据ProfileId获取指定profile的连接状态。
**需要权限**:ohos.permission.USE_BLUETOOTH
......
......@@ -45,8 +45,8 @@ HAP信息,系统应用可以通过[bundleManager.getBundleInfo](js-apis-bundle
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework.Core。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | -------------- | ---- | ---- | --------------------------- |
|moduleName | string | 是 | 否 | 依赖共享库的模块名称。 |
|bundleName | string | 是 | 否 | 依赖共享库的包名。 |
|versionCode| number | 是 | 否 | 依赖共享库的版本号。 |
\ No newline at end of file
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------ | ---- | ---- | ---------------------- |
| bundleName | string | 是 | 否 | 标识当前模块依赖的共享包包名。 |
| moduleName | string | 是 | 否 | 标识当前模块依赖的共享包模块名。 |
| versionCode | number | 是 | 否 | 标识当前共享包的版本号。 |
\ No newline at end of file
......@@ -488,8 +488,6 @@ selectContact(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
选择联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.Contacts
**参数:**
......@@ -517,8 +515,6 @@ selectContact(): Promise&lt;Array&lt;Contact&gt;&gt;
选择联系人,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.Contacts
**返回值:**
......
......@@ -180,6 +180,93 @@ console.log('get main color =' + color);
```
![zh-ch_image_Main_Color.png](figures/zh-ch_image_Main_Color.png)
### getLargestProportionColor<sup>10+</sup>
getLargestProportionColor(): Color
读取图像占比最多的颜色值,结果写入[Color](#color)里,使用同步方式返回。
**系统能力:** SystemCapability.Multimedia.Image.Core
**返回值:**
| 类型 | 说明 |
| :------------- | :---------------------------------------------- |
| [Color](#color) | Color实例,即图像占比最多的颜色值,失败时返回null。 |
**示例:**
```js
let color = colorPicker.getLargestProportionColor();
console.log('get largest proportion color =' + color);
```
![zh-ch_image_Largest_Proportion_Color.png](figures/zh-ch_image_Largest_Proportion_Color.png)
### getHighestSaturationColor<sup>10+</sup>
getHighestSaturationColor(): Color
读取图像饱和度最高的颜色值,结果写入[Color](#color)里,使用同步方式返回。
**系统能力:** SystemCapability.Multimedia.Image.Core
**返回值:**
| 类型 | 说明 |
| :------------- | :---------------------------------------------- |
| [Color](#color) | Color实例,即图像饱和度最高的颜色值,失败时返回null。 |
**示例:**
```js
let color = colorPicker.getHighestSaturationColor();
console.log('get highest saturation color =' + color);
```
![zh-ch_image_Highest_Saturation_Color.png](figures/zh-ch_image_Highest_Saturation_Color.png)
### getAverageColor<sup>10+</sup>
getAverageColor(): Color
读取图像平均的颜色值,结果写入[Color](#color)里,使用同步方式返回。
**系统能力:** SystemCapability.Multimedia.Image.Core
**返回值:**
| 类型 | 说明 |
| :------------- | :---------------------------------------------- |
| [Color](#color) | Color实例,即图像平均的颜色值,失败时返回null。 |
**示例:**
```js
let color = colorPicker.getAverageColor();
console.log('get average color =' + color);
```
![zh-ch_image_Average_Color.png](figures/zh-ch_image_Average_Color.png)
### isBlackOrWhiteOrGrayColor<sup>10+</sup>
isBlackOrWhiteOrGrayColor(color: number): boolean
判断图像是否为黑白灰颜色,返回true或false。
**系统能力:** SystemCapability.Multimedia.Image.Core
**返回值:**
| 类型 | 说明 |
| :------------- | :---------------------------------------------- |
| boolean | 如果此图像为黑白灰颜色,则返回true;否则返回false。 |
**示例:**
```js
let bJudge = colorPicker.isBlackOrWhiteOrGrayColor(0xFFFFFFFF);
console.log('is black or white or gray color[bool](white) =' + bJudge);
```
## Filter
图像效果类,用于将指定的效果添加到输入图像中。在调用Filter的方法前,需要先通过[createEffect](#effectkitcreateeffect)创建一个Filter实例。
......
# @ohos.file.fileUri (文件URI)
该模块提供通过PATH获取文件统一资源标志符(Uniform Resource Identifier,URI),后续可通过使用[@ohos.file.fs](js-apis-file-fs.md)进行相关open、read、write等操作,实现文件分享。
> **说明:**
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```js
import fileUri from "@ohos.file.fileUri";
```
使用该功能模块前,需要先获取其应用沙箱路径,开发示例如下:
```js
import UIAbility from '@ohos.app.ability.UIAbility';
export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage) {
let context = this.context;
let pathDir = context.filesDir;
}
}
```
## fileUri.getUriFromPath
getUriFromPath(path: string): string
以同步方法获取文件URI。
**系统能力**:SystemCapability.FileManagement.AppFileService
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------- |
| path | string | 是 | 文件的沙箱路径 |
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ---------- |
| string | 返回文件URI |
**错误码:**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md#错误码适配指导)
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 401 | The input parameter is invalid |
**示例:**
```js
let filePath = pathDir + "test.txt";
let uri = fileUri.getUriFromPath(filePath);
```
# @ohos.fileShare (文件分享)
该模块提供文件分享能力,提供系统应用将公共目录文件统一资源标志符(Uniform Resource Identifier,URI)以读写权限授权给其他应用的接口,授权后应用可通过[@ohos.file.fs](js-apis-file-fs.md)的相关接口进行相关open、read、write等操作,实现文件分享。
> **说明:**
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```js
import fileShare from '@ohos.fileShare';
```
## fileShare.grantUriPermission
grantUriPermission(uri: string, bundleName: string, mode: number, callback: AsyncCallback&lt;void&gt;): void
对公共目录文件URI进行授权操作,使用callback异步回调。
**需要权限**:ohos.permission.WRITE_MEDIA
**系统接口**:此接口为系统接口
**系统能力**:SystemCapability.FileManagement.AppFileService
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------- |
| uri | string | 是 | 公共目录文件URI |
| bundleName | string | 是 | 分享目标的包名 |
| mode | number | 是 | 授权的权限,参考[wantConstant.Flags](js-apis-app-ability-wantConstant.md#wantconstantflags)<br/>wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION:读授权<br/>wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION:写授权|
| callback | AsyncCallback&lt;void&gt; | 是 | 异步授权之后的回调 |
**错误码:**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md#错误码适配指导)
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 201 | Permission verification failed |
| 202 | The caller is not a system application |
| 401 | The input parameter is invalid |
| 143000001 | IPC error |
**示例:**
```js
import wantConstant from '@ohos.app.ability.wantConstant';
let uri = 'datashare:///media/image/8';
let bundleName = 'com.demo.test';
try {
fileShare.grantUriPermission(uri, bundleName, wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION | wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION, (err) => {
if (err) {
console.error("grantUriPermission failed with error: " + err);
return;
}
console.info("grantUriPermission success!");
});
} catch (error) {
console.error("grantUriPermission failed with error:" + error);
}
```
## fileShare.grantUriPermission
grantUriPermission(uri: string, bundleName: string, mode: number): Promise&lt;void&gt;
将公共目录文件URI进行授权操作,使用Promise异步回调。
**需要权限**:ohos.permission.WRITE_MEDIA
**系统接口**:此接口为系统接口
**系统能力**:SystemCapability.FileManagement.AppFileService
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------- |
| uri | string | 是 | 公共目录文件URI |
| bundleName | string | 是 | 分享目标的包名 |
| mode | number | 是 | 授权的权限,参考[wantConstant.Flags](js-apis-app-ability-wantConstant.md#wantconstantflags)<br/>wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION:读授权<br/>wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION:写授权|
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ---------- |
| Promise&lt;void&gt; | Promise对象,无返回值 |
**错误码:**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md#错误码适配指导)
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 201 | Permission verification failed |
| 202 | The caller is not a system application |
| 401 | The input parameter is invalid |
| 143000001 | IPC error |
**示例:**
```js
import wantConstant from '@ohos.app.ability.wantConstant';
let uri = 'datashare:///media/image/8';
let bundleName = 'com.demo.test';
try {
fileShare.grantUriPermission(uri, bundleName, wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION |
wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION).then(function () {
console.info("grantUriPermission success!");
}).catch(function (error) {
console.error("grantUriPermission failed with error:" + error);
});
} catch (error) {
console.error("grantUriPermission failed with error:" + error);
}
```
\ No newline at end of file
# @ohos.net.mdns (MDNS管理)
MDNS即多播DNS(Multicast DNS),提供局域网内的本地服务添加、移除、发现、解析等能力。
> **说明:**
> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```js
import mdns from '@ohos.net.mdns'
```
## mdns.addLocalService
addLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: AsyncCallback\<LocalServiceInfo>): void
添加一个mDNS服务,使用callback方式作为异步方法。
**系统能力**:SystemCapability.Communication.NetManager.MDNS
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
|-------------|----------------------------------|-----------|-------------------------------------------------|
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 |
| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是 | 回调函数。成功添加error为undefined,data为添加到本地的mdns服务信息。 |
**错误码:**
| 错误码ID | 错误信息 |
|---------|---|
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2204003 | Callback duplicated. |
| 2204008 | Service instance duplicated. |
| 2204010 | Send packet failed. |
>**错误码说明:**
> 以上错误码的详细介绍参见[MDNS错误码](../errorcodes/errorcode-net-mdns.md)。
**示例:**
```js
let localServiceInfo = {
serviceType: "_print._tcp",
serviceName: "servicename",
port: 5555,
host: {
address: "10.14.**.***",
},
serviceAttribute: [{
key: "111",
value: [1]
}]
}
mdns.addLocalService(context, localServiceInfo, function (error, data) {
console.log(JSON.stringify(error))
console.log(JSON.stringify(data))
});
```
## mdns.addLocalService
addLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\<LocalServiceInfo>
添加一个mDNS服务,使用Promise方式作为异步方法。
**系统能力**:SystemCapability.Communication.NetManager.MDNS
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
|-------------|----------------------------------|-----------|-------------------------------------------------|
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 |
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
| Promise\<[LocalServiceInfo](#localserviceinfo)> | 以Promise形式返回添加的mdns服务信息。 |
**错误码:**
| 错误码ID | 错误信息 |
|---------|---|
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2204003 | Callback duplicated. |
| 2204008 | Service instance duplicated. |
| 2204010 | Send packet failed. |
>**错误码说明:**
> 以上错误码的详细介绍参见[MDNS错误码](../errorcodes/errorcode-net-mdns.md)。
**示例:**
```js
let localServiceInfo = {
serviceType: "_print._tcp",
serviceName: "servicename",
port: 5555,
host: {
address: "10.14.**.***",
},
serviceAttribute: [{
key: "111",
value: [1]
}]
}
mdns.addLocalService(context, localServiceInfo).then(function (data) {
console.log(JSON.stringify(data))
});
```
## mdns.removeLocalService
removeLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: AsyncCallback\<LocalServiceInfo>): void
移除一个mDNS服务,使用callback方式作为异步方法。
**系统能力**: SystemCapability.Communication.NetManager.MDNS
**参数**
| 参数名 | 类型 | 必填 | 说明 |
|-------------|----------------------------------|-----------|-------------------------------------------------|
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 |
| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是 | 回调函数。成功移除error为undefined,data为移除本地的mdns服务信息。 |
**错误码:**
| 错误码ID | 错误信息 |
|---------|---|
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2204002 | Callback not found. |
| 2204008 | Service instance duplicated. |
| 2204010 | Send packet failed. |
>**错误码说明:**
> 以上错误码的详细介绍参见[MDNS错误码](../errorcodes/errorcode-net-mdns.md)。
**示例:**
```js
let localServiceInfo = {
serviceType: "_print._tcp",
serviceName: "servicename",
port: 5555,
host: {
address: "10.14.**.***",
},
serviceAttribute: [{
key: "111",
value: [1]
}]
}
mdns.removeLocalService(context, localServiceInfo, function (error, data) {
console.log(JSON.stringify(error))
console.log(JSON.stringify(data))
});
```
## mdns.removeLocalService
removeLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\<LocalServiceInfo>
移除一个mDNS服务. 使用Promise方式作为异步方法。
**系统能力**: SystemCapability.Communication.NetManager.MDNS
**参数**
| 参数名 | 类型 | 必填 | 说明 |
|-------------|----------------------------------|-----------|-------------------------------------------------|
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 |
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
| Promise\<[LocalServiceInfo](#localserviceinfo)> | 以Promise形式返回移除的mdns服务信息。 |
**错误码:**
| 错误码ID | 错误信息 |
|---------|---|
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2204002 | Callback not found. |
| 2204008 | Service instance duplicated. |
| 2204010 | Send packet failed. |
>**错误码说明:**
> 以上错误码的详细介绍参见[MDNS错误码](../errorcodes/errorcode-net-mdns.md)。
**示例:**
```js
let localServiceInfo = {
serviceType: "_print._tcp",
serviceName: "servicename",
port: 5555,
host: {
address: "10.14.**.***",
},
serviceAttribute: [{
key: "111",
value: [1]
}]
}
mdns.removeLocalService(context, localServiceInfo).then(function (data) {
console.log(JSON.stringify(data))
});
```
## mdns.createDiscoveryService
createDiscoveryService(context: Context, serviceType: string): DiscoveryService
返回一个DiscoveryService对象,该对象用于发现指定服务类型的mDNS服务。
**系统能力**:SystemCapability.Communication.NetManager.MDNS
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
|-------------|---------|-----------| ------------------------------------------------------------ |
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceType | string | 是 | 需要发现的mDNS服务类型。|
**返回值:**
| Type | Description |
| ----------------------------- |---------------------------------|
| DiscoveryService | 基于指定serviceType和Context的发现服务对象。 |
**Example**
```js
let serviceType = "_print._tcp";
let discoveryService = mdns.createDiscoveryService(context, serviceType);
```
## mdns.resolveLocalService
resolveLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: AsyncCallback\<LocalServiceInfo>): void
解析一个mDNS服务,使用callback方式作为异步方法。
**系统能力**: SystemCapability.Communication.NetManager.MDNS
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
|-------------|----------------------------------|-----------|-------------------------------------------------------------|
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 |
| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是 | 回调函数。成功移除error为undefined,data为解析的mdns服务信息。 |
**错误码:**
| 错误码ID | 错误信息 |
|---------|----------------------------------------------|
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2204003 | Callback duplicated. |
| 2204006 | Request timeout. |
| 2204010 | Send packet failed. |
>**错误码说明:**
> 以上错误码的详细介绍参见[MDNS错误码](../errorcodes/errorcode-net-mdns.md)。
**示例:**
```js
let localServiceInfo = {
serviceType: "_print._tcp",
serviceName: "servicename",
port: 5555,
host: {
address: "10.14.**.***",
},
serviceAttribute: [{
key: "111",
value: [1]
}]
}
mdns.resolveLocalService(context, localServiceInfo, function (error, data) {
console.log(JSON.stringify(error))
console.log(JSON.stringify(data))
});
```
## mdns.resolveLocalService
resolveLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\<LocalServiceInfo>
解析一个mDNS服务,使用Promise方式作为异步方法。
**系统能力**: SystemCapability.Communication.NetManager.MDNS
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------------|-----------|-----------------------------------------------------|
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 |
**返回值:**
| 类型 | 说明 |
|----------------------------| ------------------------------------- |
| Promise\<[LocalServiceInfo](#localserviceinfo)> | 以Promise形式返回解析的mDNS服务信息。|
**错误码:**
| 错误码ID | 错误信息 |
|---------|----------------------------------------------|
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2204003 | Callback duplicated. |
| 2204006 | Request timeout. |
| 2204010 | Send packet failed. |
>**错误码说明:**
> 以上错误码的详细介绍参见[MDNS错误码](../errorcodes/errorcode-net-mdns.md)。
**示例:**
```js
let localServiceInfo = {
serviceType: "_print._tcp",
serviceName: "servicename",
port: 5555,
host: {
address: "10.14.**.***",
},
serviceAttribute: [{
key: "111",
value: [1]
}]
}
mdns.resolveLocalService(context, localServiceInfo).then(function (data){
console.log(JSON.stringify(data));
})
```
## DiscoveryService
指定服务类型的发现服务对象。
### startSearchingMDNS
startSearchingMDNS(): void
开始搜索局域网内的mDNS服务。
**系统能力**:SystemCapability.Communication.NetManager.MDNS
**示例:**
```js
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();
```
### stopSearchingMDNS
stopSearchingMDNS(): void
停止搜索局域网内的mDNS服务。
**系统能力**:SystemCapability.Communication.NetManager.MDNS
**示例:**
```js
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.stopSearchingMDNS();
```
### on('discoveryStart')
on(type: 'discoveryStart', callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MDNS_ERR}>): void
订阅开启监听mDNS服务的通知。
**系统能力**:SystemCapability.Communication.NetManager.MDNS
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------------|-----------|-----------------------------------------------------|
| type | string | 是 |订阅事件,固定为'discoveryStart'。<br>discoveryStart:开始搜索局域网内的mDNS服务事件。 |
| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MDNS_ERR](#mdns_err)}> | 是 | mDNS服务的信息和事件错误信息。 |
**示例:**
```js
// 参考mdns.createDiscoveryService
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();
discoveryService.on('discoveryStart', (data) => {
console.log(JSON.stringify(data));
});
discoveryService.stopSearchingMDNS();
```
### on('discoveryStop')
on(type: 'discoveryStop', callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MDNS_ERR}>): void
订阅停止监听mDNS服务的通知。
**系统能力**:SystemCapability.Communication.NetManager.MDNS
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------------|-----------|-----------------------------------------------------|
| type | string | 是 |订阅事件,固定为'discoveryStop'。<br>discoveryStop:停止搜索局域网内的mDNS服务事件。 |
| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MDNS_ERR](#mdns_err)}> | 是 | mDNS服务的信息和事件错误信息。 |
**示例:**
```js
// 参考mdns.createDiscoveryService
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();
discoveryService.on('discoveryStop', (data) => {
console.log(JSON.stringify(data));
});
discoveryService.stopSearchingMDNS();
```
### on('serviceFound')
on(type: 'serviceFound', callback: Callback<[LocalServiceInfo](#localserviceinfo)>): void
订阅发现mDNS服务的通知。
**系统能力**:SystemCapability.Communication.NetManager.MDNS
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------------|-----------|-----------------------------------------------------|
| type | string | 是 |订阅事件,固定为'serviceFound'。<br>serviceFound:发现mDNS服务事件。 |
| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 是 | mDNS服务的信息。 |
**示例:**
```js
// 参考mdns.createDiscoveryService
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();
discoveryService.on('serviceFound', (data) => {
console.log(JSON.stringify(data));
});
discoveryService.stopSearchingMDNS();
```
### on('serviceLost')
on(type: 'serviceLost', callback: Callback<[LocalServiceInfo](#localserviceinfo)>): void
订阅移除mDNS服务的通知。
**系统能力**:SystemCapability.Communication.NetManager.MDNS
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------------|-----------|-----------------------------------------------------|
| type | string | 是 |订阅事件,固定为'serviceLost'。<br>serviceLost:移除mDNS服务事件。 |
| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 是 | mDNS服务的信息。 |
**示例:**
```js
// 参考mdns.createDiscoveryService
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();
discoveryService.on('serviceLost', (data) => {
console.log(JSON.stringify(data));
});
discoveryService.stopSearchingMDNS();
```
## LocalServiceInfo
mDNS服务信息
**系统能力**:SystemCapability.Communication.NetManager.MDNS
| 名称 | 类型 | 必填 | 说明 |
| --------------------- | ---------------------------------- | --- | ------------------------ |
| serviceType | string | 是 | mDNS服务的类型。格式_\<name>.<_tcp/_udp>,name长度小于63字符并且不能包含字符'.'。 |
| serviceName | string | 是 | mDNS服务的名字。 |
| port | number | 否 | mDNS服务的端口号。 |
| host | [NetAddress](js-apis-net-connection.md#netaddress) | 否 | mDNS服务设备的IP地址。采用设备的IP,添加服务和移除服务时候不生效。 |
| serviceAttribute | serviceAttribute\<[ServiceAttribute](#serviceattribute)> | 否 | mDNS服务属性信息。 |
## ServiceAttribute
mDNS服务属性信息
**系统能力**:SystemCapability.Communication.NetManager.MDNS
| 名称 | 类型 | 必填 | 说明 |
| --------------------- | ---------------------------------- | --- | ------------------------ |
| key | string | 是 | mDNS服务属性键值,键值长度应该小于9个字符。 |
| value | Array\<number> | 是 | mDNS服务属性值。 |
## MDNS_ERR
mDNS错误信息。
**系统能力**:SystemCapability.Communication.NetManager.MDNS
| 名称 | 值 | 说明 |
| --------------- | ---- | ----------- |
| INTERNAL_ERROR | 0 | 内部错误导致操作失败。 |
| ALREADY_ACTIVE | 1 | 服务已经存在导致操作失败。 |
| MAX_LIMIT | 2 | 请求超过最大限制导致操作失败。(暂不支持) |
\ No newline at end of file
......@@ -32,7 +32,16 @@ DatePicker(options?: {start?: Date, end?: Date, selected?: Date})
| 名称 | 参数类型 | 描述 |
| ------| -------------- | -------- |
| lunar | boolean | 日期是否显示农历。<br/>-&nbsp;true:展示农历。<br/>-&nbsp;false:不展示农历。<br/>默认值:false |
| disappearTextStyle<sup>10+</sup> | [PickerTextStyle](#pickertextstyle10类型说明) | 设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。 |
| textStyle<sup>10+</sup> | [PickerTextStyle](#pickertextstyle10类型说明) | 设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。 |
| selectedTextStyle<sup>10+</sup> | [PickerTextStyle](#pickertextstyle10类型说明) | 设置选中项的文本颜色、字号、字体粗细。 |
## PickerTextStyle<sup>10+</sup>类型说明
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ------ | ------------------------------------------ | ---- | -------------------------------------------- |
| color | [ResourceColor](ts-types.md#resourcecolor) | 否 | 文本颜色。 |
| font | [Font](ts-types.md#font) | 否 | 文本样式,picker只支持字号、字体粗细的设置。 |
## 事件
......
......@@ -14,7 +14,7 @@
## 接口
TextPicker(options?: {range: string[]|Resource, selected?: number, value?: string})
TextPicker(options?: {range: string[]|Resource|TextPickerRangeContent[], selected?: number, value?: string})
根据range指定的选择范围创建文本选择器。
......@@ -22,15 +22,25 @@ TextPicker(options?: {range: string[]|Resource, selected?: number, value?: strin
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| range | string[]&nbsp;\|&nbsp;[Resource](ts-types.md#resource类型) | 是 | 选择器的数据选择列表。 |
| range | string[]&nbsp;\|&nbsp;[Resource](ts-types.md#resource类型)\|[TextPickerRangeContent](#textpickerrangecontent10类型说明)[]<sup>10+</sup> | 是 | 选择器的数据选择列表。不可设置为空数组,若设置为空数组,则不显示;若动态变化为空数组,则保持当前正常值显示。 |
| selected | number | 否 | 设置默认选中项在数组中的索引值。<br/>默认值:0 |
| value | string | 否 | 设置默认选中项的值,优先级低于selected。<br/>默认值:第一个元素值 |
| value | string | 否 | 设置默认选中项的值,优先级低于selected。<br/>默认值:第一个元素值<br/>**说明**:只有显示文本列表时该值有效。显示图片或图片加文本的列表时,该值无效。 |
## TextPickerRangeContent<sup>10+</sup>类型说明
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ------ | -------------------------------------------------------- | ---- | ---------- |
| icon | string&nbsp;\|&nbsp;[Resource](ts-types.md#resource) | 是 | 图片资源。 |
| text | string&nbsp;\|&nbsp;[Resource](ts-types.md#resource) | 否 | 文本信息。 |
## 属性
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| defaultPickerItemHeight | number \| string | 设置Picker各选择项的高度。 |
| disappearTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。 |
| textStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。 |
| selectedTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 设置选中项的文本颜色、字号、字体粗细。 |
## 事件
......@@ -38,7 +48,7 @@ TextPicker(options?: {range: string[]|Resource, selected?: number, value?: strin
| 名称 | 描述 |
| -------- | -------- |
| onChange(callback:&nbsp;(value:&nbsp;string,&nbsp;index:&nbsp;number)&nbsp;=&gt;&nbsp;void) | 滑动选中TextPicker文本内容后,触发该回调。<br/>-&nbsp;value:&nbsp;当前选中项的文本。<br/>-&nbsp;index:&nbsp;当前选中项的索引值。 |
| onChange(callback:&nbsp;(value:&nbsp;string,&nbsp;index:&nbsp;number)&nbsp;=&gt;&nbsp;void) | 滑动选中TextPicker文本内容后,触发该回调。<br/>-&nbsp;value:&nbsp;当前选中项的文本。<br/>**说明**:当显示文本或图片加文本列表时,value值为选中项中的文本值,当显示图片列表时,value值为空。<br/>-&nbsp;index:&nbsp;当前选中项的索引值。 |
## 示例
......
......@@ -30,6 +30,9 @@ TimePicker(options?: {selected?: Date})
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| useMilitaryTime | boolean | 展示时间是否为24小时制,不支持动态修改。<br/>默认值:false |
| disappearTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。 |
| textStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。 |
| selectedTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 设置选中项的文本颜色、字号、字体粗细。 |
## 事件
......
......@@ -21,6 +21,11 @@ show(options?: DatePickerDialogOptions)
| end | Date | 否 | Date('2100-12-31') | 设置选择器的结束日期。 |
| selected | Date | 否 | 当前系统日期 | 设置当前选中的日期。 |
| lunar | boolean | 否 | false | 日期是否显示为农历。 |
| showTime<sup>10+</sup> | boolean | 否 | false | 是否展示时间项。 |
| useMilitaryTime<sup>10+</sup> | boolean | 否 | false | 展示时间是否为24小时制。 |
| disappearTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | - | 设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。 |
| textStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | - | 设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。 |
| selectedTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | - | 设置选中项的文本颜色、字号、字体粗细。 |
| onAccept | (value: [DatePickerResult](ts-basic-components-datepicker.md#DatePickerResult对象说明)) => void | 否 | - | 点击弹窗中的“确定”按钮时触发该回调。 |
| onCancel | () => void | 否 | - | 点击弹窗中的“取消”按钮时触发该回调。 |
| onChange | (value: [DatePickerResult](ts-basic-components-datepicker.md#DatePickerResult对象说明)) => void | 否 | - | 滑动弹窗中的滑动选择器使当前选中项改变时触发该回调。 |
......
......@@ -17,10 +17,13 @@ show(options?: TextPickerDialogOptions)
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| range | string[]&nbsp;\|&nbsp;[Resource](ts-types.md#resource) | 是 | 设置文本选择器的选择范围。 |
| range | string[]&nbsp;\|&nbsp;[Resource](ts-types.md#resource)\|[TextPickerRangeContent](ts-basic-components-textpicker.md#textpickerrangecontent10类型说明)[]<sup>10+</sup> | 是 | 设置文本选择器的选择范围。不可设置为空数组,若设置为空数组,则不弹出弹窗。 |
| selected | number | 否 | 设置选中项的索引值。<br>默认值:0 |
| value | string | 否 | 设置选中项的文本内容。当设置了selected参数时,该参数不生效。如果设置的value值不在range范围内,则默认取range第一个元素。|
| defaultPickerItemHeight | number \| string | 否 | 设置选择器中选项的高度。 |
| disappearTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | 设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。 |
| textStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | 设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。 |
| selectedTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | 设置选中项的文本颜色、字号、字体粗细。 |
| onAccept | (value: [TextPickerResult](#textpickerresult对象说明)) => void | 否 | 点击弹窗中的“确定”按钮时触发该回调。 |
| onCancel | () => void | 否 | 点击弹窗中的“取消”按钮时触发该回调。 |
| onChange | (value: [TextPickerResult](#textpickerresult对象说明)) => void | 否 | 滑动弹窗中的选择器使当前选中项改变时触发该回调。 |
......@@ -29,7 +32,7 @@ show(options?: TextPickerDialogOptions)
| 名称 | 类型 | 描述 |
| -------- | -------- | -------- |
| value | string | 选中项的文本内容。 |
| value | string | 选中项的文本内容。<br/>**说明**:当显示文本或图片加文本列表时,value值为选中项中的文本值,<br/>当显示图片列表时,value值为空。 |
| index | number | 选中项在选择范围数组中的索引值。 |
## 示例
......
......@@ -19,6 +19,9 @@ show(options?: TimePickerDialogOptions)
| -------- | -------- | -------- | -------- |
| selected | Date | 否 | 设置当前选中的时间。<br/>默认值:当前系统时间 |
| useMilitaryTime | boolean | 否 | 展示时间是否为24小时制,默认为12小时制。<br/>默认值:false |
| disappearTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | 设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。 |
| textStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | 设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。 |
| selectedTextStyle<sup>10+</sup> | [PickerTextStyle](ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | 设置选中项的文本颜色、字号、字体粗细。 |
| onAccept | (value: [TimePickerResult](ts-basic-components-timepicker.md#TimePickerResult对象说明)) => void | 否 | 点击弹窗中的“确定”按钮时触发该回调。 |
| onCancel | () => void | 否 | 点击弹窗中的“取消”按钮时触发该回调。 |
| onChange | (value: [TimePickerResult](ts-basic-components-timepicker.md#TimePickerResult对象说明)) => void | 否 | 滑动弹窗中的选择器使当前选中时间改变时触发该回调。 |
......
......@@ -14,7 +14,7 @@
| -------- | -------- | -------- |
| align | [Alignment](ts-appendix-enums.md#alignment) | 设置元素内容在元素绘制区域内的对齐方式。<br/>默认值:Alignment.Center<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| direction | [Direction](ts-appendix-enums.md#direction) | 设置元素水平方向的布局。<br/>默认值:Direction.Auto<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| position | [Position](ts-types.md#position8) | 绝对定位,设置元素左上角相对于父容器左上角偏移位置。在布局容器中,设置该属性不影响父容器布局,仅在绘制时进行位置调整。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| position | [Position](ts-types.md#position8) | 绝对定位,设置元素左上角相对于父容器左上角偏移位置。在布局容器中,设置该属性不影响父容器布局,仅在绘制时进行位置调整。<br/>适用于置顶显示、悬浮按钮等组件在父容器中位置固定的场景。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| markAnchor | [Position](ts-types.md#position8) | 设置元素在位置定位时的锚点,以元素左上角作为基准点进行偏移。通常配合position和offset属性使用,单独使用时,效果类似offset<br/>默认值:<br/>{<br/>x: 0,<br/>y: 0<br/>}<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| offset | [Position](ts-types.md#position8) | 相对定位,设置元素相对于自身的偏移量。设置该属性,不影响父容器布局,仅在绘制时进行位置调整。<br/>默认值:<br/>{<br/>x: 0,<br/>y: 0<br/>}<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| alignRules<sup>9+</sup> | {<br/>left?: { anchor: string, align: [HorizontalAlign](ts-appendix-enums.md#horizontalalign) };<br/>right?: { anchor: string, align: [HorizontalAlign](ts-appendix-enums.md#horizontalalign) };<br/>middle?: { anchor: string, align: [HorizontalAlign](ts-appendix-enums.md#horizontalalign) };<br/>top?: { anchor: string, align: [VerticalAlign](ts-appendix-enums.md#verticalalign) };<br/>bottom?: { anchor: string, align: [VerticalAlign](ts-appendix-enums.md#verticalalign) };<br/>center?: { anchor: string, align: [VerticalAlign](ts-appendix-enums.md#verticalalign) }<br/>} | 指定相对容器的对齐规则,仅当父容器为[RelativeContainer](ts-container-relativecontainer.md)时生效。<br/>-&nbsp;left:设置左对齐参数。<br/>-&nbsp;right:设置右对齐参数。<br/>-&nbsp;middle:设置中间对齐的参数。<br/>-&nbsp;top:设置顶部对齐的参数。<br/>-&nbsp;bottom:设置底部对齐的参数。<br/>-&nbsp;center:设置中心对齐的参数。<br/>该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>-&nbsp;anchor:设置作为锚点的组件的id值。<br>-&nbsp;align:设置相对于锚点组件的对齐方式。 |
......
# MDNS错误码
> **说明:**
>
> 以下仅介绍本模块特有错误码,通用错误码请参考[通用错误码说明文档](errorcode-universal.md)。
## 2100002 连接服务失败
**错误信息**
Operation failed. Cannot connect to service.
**错误描述**
操作失败,连接系统服务发生异常。
**可能原因**
服务发生异常。
**处理步骤**
检查系统服务运行状态是否正常。
## 2100003 系统内部错误
**错误信息**
System internal error.
**错误描述**
系统内部错误。
**可能原因**
1.内存异常。
2.空指针。
**处理步骤**
1.检查内存空间是否充足,清理内存后重试。
2.系统异常,请稍后重试或重启设备。
## 2204003 重复注册
**错误信息**
Callback duplicated.
**错误描述**
callback 已经存在。
**可能原因**
重复注册相同名称和类型的mDNS服务。
**处理步骤**
检查mDNS服务是否存在。
## 2204008 删除服务失败
**错误信息**
Service instance duplicated.
**错误描述**
想要移除的服务不存在。
**可能原因**
之前已经把服务删除,二次删除相同服务。
**处理步骤**
检查mDNS服务是否存在。
## 2204010 发送消息失败
**错误信息**
Send packet failed.
**错误描述**
发送信息失败。
**可能原因**
局域网内不存在该mDNS服务。
**处理步骤**
检查局域网内目标mDNS服务是否存在。
## 2204006 解析服务超时
**错误信息**
Request timeout.
**错误描述**
解析服务超时。
**可能原因**
局域网内不存在该类型的mDNS服务。
**处理步骤**
检查局域网内目标类型的mDNS服务是否存在。
\ No newline at end of file
......@@ -97,7 +97,6 @@
- [HiSysEvent订阅指导](subsys-dfx-hisysevent-listening.md)
- [HiSysEvent查询指导](subsys-dfx-hisysevent-query.md)
- [HiSysEvent工具使用指导](subsys-dfx-hisysevent-tool.md)
- [HiDumper开发指导](subsys-dfx-hidumper.md)
- [HiChecker开发指导](subsys-dfx-hichecker.md)
- [Faultlogger开发指导](subsys-dfx-faultlogger.md)
- [Hiview开发指导](subsys-dfx-hiview.md)
......@@ -105,6 +104,7 @@
- [bytrace使用指导](subsys-toolchain-bytrace-guide.md)
- [hdc使用指导](subsys-toolchain-hdc-guide.md)
- [hiperf使用指导](subsys-toolchain-hiperf.md)
- [HiDumper使用指导](subsys-dfx-hidumper.md)
- 电源管理
- 显示管理
- [系统亮度范围定制开发指导](subsys-power-brightness-customization.md)
# HiDumper开发指导
# HiDumper概述
## 概述
### 功能简介
## 功能简介
HiDumper是OpenHarmony为开发、测试人员、IDE工具提供的系统信息获取工具,帮助开发者分析、定位问题。本章节内容适用于标准系统。
### 源码目录说明
## 源码目录说明
```
......@@ -34,10 +31,10 @@ HiDumper是OpenHarmony为开发、测试人员、IDE工具提供的系统信息
```
## 使用指导
# HiDumper使用指导
### 命令参数说明
## 命令参数说明
**表1** HiDumper命令参数说明
......@@ -63,7 +60,7 @@ HiDumper是OpenHarmony为开发、测试人员、IDE工具提供的系统信息
| --zip | 将导出信息压缩到固定文件夹下。 |
### 使用实例
## 使用实例
HiDumper可以为开发者导出系统当前基本信息,通过这些基本信息可以定位分析问题。给子服务和元能力传递复杂参数时,参数需要加双引号。
......
......@@ -230,4 +230,10 @@ module.json配置文件中的ability的[name](../../../application-dev/quick-sta
删除配置文件module.json[distroFilter](../../../application-dev/quick-start/module-configuration-file.md)标签,IDE中不再支持配置该标签,使用该标签会导致IDE编译报错
**适配指导**<br>
删除module.json中[distroFilter](../../../application-dev/quick-start/module-configuration-file.md)标签,使用distributionFilter替代
\ No newline at end of file
删除module.json中[distroFilter](../../../application-dev/quick-start/module-configuration-file.md)标签,使用distributionFilter替代
## cl.bundlemanager.20 module.json配置文件中launchTypede标签standard模式修改为multiton
删除module.json中[launchType](../../../application-dev/quick-start/module-configuration-file.md)标签的standard模式修改为multiton
**适配指导**<br>
删除module.json中[launchType](../../../application-dev/quick-start/module-configuration-file.md)标签的standard模式,使用multiton替代
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册