Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 481ff40b 编写于 作者: H HelloCrease
浏览文件
操作

fixed error 

Signed-off-by: NHelloCrease <lian15@huawei.com>
上级 378802d4
显示空白变更内容
内联 并排
Showing with 1690 addition and 1683 deletion
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
浏览文件 @ 481ff40b
...@@ -16,7 +16,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -16,7 +16,7 @@ SystemCapability.BundleManager.BundleFramework
## 权限列表 ## 权限列表
| 权限 | 权限等级 | 描述 | | 权限 | 权限等级 | 描述 |
|-------| --------- | ---- | | ---------------------------------------- | ------------ | --------- |
| ohos.permission.GET_BUNDLE_INFO | normal | 仅限查询本应用信息 | | ohos.permission.GET_BUNDLE_INFO | normal | 仅限查询本应用信息 |
| ohos.permission.GET_BUNDLE_INFO_PRIVILEGED | system_basic | 可查询所有应用信息 | | ohos.permission.GET_BUNDLE_INFO_PRIVILEGED | system_basic | 可查询所有应用信息 |
| ohos.permission.INSTALL_BUNDLE | system_core | 可安装、卸载应用 | | ohos.permission.INSTALL_BUNDLE | system_core | 可安装、卸载应用 |
...@@ -38,7 +38,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -38,7 +38,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | ------------------------------------------------------------ | | ----------- | ------ | ---- | --------------------------------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
...@@ -46,7 +46,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -46,7 +46,7 @@ SystemCapability.BundleManager.BundleFramework
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------- | -------- | | ------------------------- | ------------------ |
| Promise\<ApplicationInfo> | Promise形式返回应用程序信息。 | | Promise\<ApplicationInfo> | Promise形式返回应用程序信息。 |
**示例：** **示例：**
...@@ -82,7 +82,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -82,7 +82,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------------------------------- | ---- | ------------------------------------------------------------ | | ----------- | ------------------------------- | ---- | --------------------------------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | | userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
...@@ -121,7 +121,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -121,7 +121,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------------------------------- | ---- | ------------------------------------------------------------ | | ----------- | ------------------------------- | ---- | --------------------------------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| callback | AsyncCallback\<ApplicationInfo> | 是 | 程序启动作为入参的回调函数，返回应用程序信息。 | | callback | AsyncCallback\<ApplicationInfo> | 是 | 程序启动作为入参的回调函数，返回应用程序信息。 |
...@@ -158,14 +158,14 @@ SystemCapability.BundleManager.BundleFramework ...@@ -158,14 +158,14 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ---------- | ---- | ----------------------------------------------------------- | | ---------- | ---------- | ---- | --------------------------------------- |
| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | | bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------- | ----------------------------------- | | --------------------------- | -------------------------- |
| Promise<Array\<BundleInfo>> | Promise形式返回所有可用的BundleInfo | | Promise<Array\<BundleInfo>> | Promise形式返回所有可用的BundleInfo |
**示例：** **示例：**
...@@ -200,8 +200,8 @@ SystemCapability.BundleManager.BundleFramework ...@@ -200,8 +200,8 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------------------ | | ---------- | --------------------------------- | ---- | --------------------------------------- |
| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。| | bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| callback | AsyncCallback<Array\<BundleInfo>> | 是 | 程序启动作为入参的回调函数，返回所有可用的BundleInfo。 | | callback | AsyncCallback<Array\<BundleInfo>> | 是 | 程序启动作为入参的回调函数，返回所有可用的BundleInfo。 |
**示例：** **示例：**
...@@ -235,8 +235,8 @@ SystemCapability.BundleManager.BundleFramework ...@@ -235,8 +235,8 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------------------ | | ---------- | --------------------------------- | ---- | --------------------------------------- |
| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。| | bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | | userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
| callback | AsyncCallback<Array\<BundleInfo>> | 是 | 程序启动作为入参的回调函数，返回所有可用的BundleInfo。 | | callback | AsyncCallback<Array\<BundleInfo>> | 是 | 程序启动作为入参的回调函数，返回所有可用的BundleInfo。 |
...@@ -273,7 +273,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -273,7 +273,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | ------------------------------------------------------------ | | ----------- | ------------- | ---- | --------------------------------------- |
| bundleName | string | 是 | 包名 | | bundleName | string | 是 | 包名 |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| options | BundleOptions | 否 | 包含userid。 | | options | BundleOptions | 否 | 包含userid。 |
...@@ -281,7 +281,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -281,7 +281,7 @@ SystemCapability.BundleManager.BundleFramework
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------- | ------------------------------------------ | | -------------------- | ---------------------------- |
| Promise\<BundleInfo> | 返回值为Promise对象，Promise中包含包信息。 | | Promise\<BundleInfo> | 返回值为Promise对象，Promise中包含包信息。 |
**示例：** **示例：**
...@@ -319,7 +319,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -319,7 +319,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | -------------------------- | ---- | ------------------------------------------------------------ | | ----------- | -------------------------- | ---- | --------------------------------------- |
| bundleName | string | 是 | 包名 | | bundleName | string | 是 | 包名 |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| callback | AsyncCallback\<BundleInfo> | 是 | 程序启动作为入参的回调函数，返回包信息。 | | callback | AsyncCallback\<BundleInfo> | 是 | 程序启动作为入参的回调函数，返回包信息。 |
...@@ -356,7 +356,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -356,7 +356,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | -------------------------- | ---- | ------------------------------------------------------------ | | ----------- | -------------------------- | ---- | --------------------------------------- |
| bundleName | string | 是 | 包名 | | bundleName | string | 是 | 包名 |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| options | BundleOptions | 是 | 包含userid。 | | options | BundleOptions | 是 | 包含userid。 |
...@@ -397,14 +397,14 @@ SystemCapability.BundleManager.BundleFramework ...@@ -397,14 +397,14 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | ------------------------------------------------------ | | ----------- | ------ | ---- | --------------------------------------- |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | ------------------------------------------------ | | -------------------------------- | ------------------------------- |
| Promise<Array\<ApplicationInfo>> | 返回值为Promise对象，Promise中包含应用信息列表。 | | Promise<Array\<ApplicationInfo>> | 返回值为Promise对象，Promise中包含应用信息列表。 |
**示例：** **示例：**
...@@ -439,8 +439,8 @@ SystemCapability.BundleManager.BundleFramework ...@@ -439,8 +439,8 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | -------------------------------------- | ---- | ------------------------------------------------------ | | ----------- | -------------------------------------- | ---- | --------------------------------------- |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。| | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
| callback | AsyncCallback<Array\<ApplicationInfo>> | 是 | 程序启动作为入参的回调函数，返回应用信息列表。 | | callback | AsyncCallback<Array\<ApplicationInfo>> | 是 | 程序启动作为入参的回调函数，返回应用信息列表。 |
...@@ -476,8 +476,8 @@ SystemCapability.BundleManager.BundleFramework ...@@ -476,8 +476,8 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | -------------------------------------- | ---- | ------------------------------------------------------ | | ----------- | -------------------------------------- | ---- | --------------------------------------- |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。| | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| callback | AsyncCallback<Array\<ApplicationInfo>> | 是 | 程序启动作为入参的回调函数，返回应用信息列表。 | | callback | AsyncCallback<Array\<ApplicationInfo>> | 是 | 程序启动作为入参的回调函数，返回应用信息列表。 |
**示例：** **示例：**
...@@ -510,14 +510,14 @@ SystemCapability.BundleManager.BundleFramework ...@@ -510,14 +510,14 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | -------------------------------------------------------- | | ----------- | ------ | ---- | ---------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| abilityName | string | 是 | 表示待查询的Ability名称。 | | abilityName | string | 是 | 表示待查询的Ability名称。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------- | ---------------------------- | | --------------------- | --------------------- |
| Promise\<AbilityInfo> | Promise形式返回Ability信息。 | | Promise\<AbilityInfo> | Promise形式返回Ability信息。 |
**示例：** **示例：**
...@@ -551,10 +551,10 @@ SystemCapability.BundleManager.BundleFramework ...@@ -551,10 +551,10 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------------------------- | | ----------- | --------------------------- | ---- | -------------------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| abilityName | string | 是 | 表示待查询的Ability名称。 | | abilityName | string | 是 | 表示待查询的Ability名称。 |
| callback | AsyncCallback\<AbilityInfo> | 是 | 程序启动作为入参的回调函数，返回Ability信息。| | callback | AsyncCallback\<AbilityInfo> | 是 | 程序启动作为入参的回调函数，返回Ability信息。 |
**示例：** **示例：**
...@@ -587,14 +587,14 @@ SystemCapability.BundleManager.BundleFramework ...@@ -587,14 +587,14 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | -------------------------------------------------------- | | ----------- | ------ | ---- | ---------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| abilityName | string | 是 | 表示待查询的Ability名称。 | | abilityName | string | 是 | 表示待查询的Ability名称。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------- | ---------------------------- | | ---------------- | ------------------ |
| Promise\<string> | Promise形式返回应用名称信息。 | | Promise\<string> | Promise形式返回应用名称信息。 |
**示例：** **示例：**
...@@ -627,10 +627,10 @@ SystemCapability.BundleManager.BundleFramework ...@@ -627,10 +627,10 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------------------------- | | ----------- | ---------------------- | ---- | ---------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| abilityName | string | 是 | 表示待查询的Ability名称。 | | abilityName | string | 是 | 表示待查询的Ability名称。 |
| callback | AsyncCallback\<string> | 是 | 返回应用名称信息。| | callback | AsyncCallback\<string> | 是 | 返回应用名称信息。 |
**示例：** **示例：**
...@@ -663,13 +663,13 @@ SystemCapability.BundleManager.BundleFramework ...@@ -663,13 +663,13 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | ------------ | | ---- | ----------- | ---- | ------------ |
| info | AbilityInfo | 是 | Ability的配置信息 | | info | AbilityInfo | 是 | Ability的配置信息 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------- | ------------------------| | ----------------- | ------------------------- |
| Promise\<boolean> | Promise形式返回boolean代表是否启用。 | | Promise\<boolean> | Promise形式返回boolean代表是否启用。 |
**示例：** **示例：**
...@@ -704,7 +704,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -704,7 +704,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------------------------- | | -------- | ----------------------- | ---- | --------------- |
| info | AbilityInfo | 是 | Ability的配置信息 | | info | AbilityInfo | 是 | Ability的配置信息 |
| callback | AsyncCallback\<boolean> | 是 | 返回boolean代表是否启用 | | callback | AsyncCallback\<boolean> | 是 | 返回boolean代表是否启用 |
...@@ -741,13 +741,13 @@ SystemCapability.BundleManager.BundleFramework ...@@ -741,13 +741,13 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | -------------------------------------------------------- | | ---------- | ------ | ---- | ------------ |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------- | ------------------------| | ----------------- | ------------------------- |
| Promise\<boolean> | Promise形式返回boolean代表是否启用。 | | Promise\<boolean> | Promise形式返回boolean代表是否启用。 |
**示例：** **示例：**
...@@ -779,14 +779,14 @@ SystemCapability.BundleManager.BundleFramework ...@@ -779,14 +779,14 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------------------------- | | ---------- | ----------------------- | ---- | --------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| callback | AsyncCallback\<boolean> | 是 | 返回boolean代表是否启用 | | callback | AsyncCallback\<boolean> | 是 | 返回boolean代表是否启用 |
**示例：** **示例：**
```js ```js
let bundleName : "com.example.myapplication"; let bundleName = "com.example.myapplication";
bundle.isApplicationEnabled(bundleName, (err, data) => { bundle.isApplicationEnabled(bundleName, (err, data) => {
if (err) { if (err) {
console.error('Operation failed. Cause: ' + JSON.stringify(err)); console.error('Operation failed. Cause: ' + JSON.stringify(err));
...@@ -813,7 +813,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -813,7 +813,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | ------------------------------------------------------------ | | ----------- | ------ | ---- | ------------------------------------- |
| want | Want | 是 | 包含要查询的应用程序包名称的意图。 | | want | Want | 是 | 包含要查询的应用程序包名称的意图。 |
| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 | | bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 |
| userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 |
...@@ -821,7 +821,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -821,7 +821,7 @@ SystemCapability.BundleManager.BundleFramework
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------- | ---------------------------- | | ---------------------------- | --------------------- |
| Promise<Array\<AbilityInfo>> | Promise形式返回Ability信息。 | | Promise<Array\<AbilityInfo>> | Promise形式返回Ability信息。 |
**示例：** **示例：**
...@@ -856,7 +856,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -856,7 +856,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ---------------------------------- | ---- | ------------------------------------------------------------ | | ----------- | ---------------------------------- | ---- | ------------------------------------- |
| want | Want | 是 | 指示包含要查询的应用程序包名称的意图。 | | want | Want | 是 | 指示包含要查询的应用程序包名称的意图。 |
| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 | | bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 |
| userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 | | userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 |
...@@ -893,7 +893,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -893,7 +893,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ---------------------------------- | ---- | ------------------------------------------------------------ | | ----------- | ---------------------------------- | ---- | ------------------------------------- |
| want | Want | 是 | 指示包含要查询的应用程序包名称的意图。 | | want | Want | 是 | 指示包含要查询的应用程序包名称的意图。 |
| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 | | bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 |
| callback | AsyncCallback<Array\<AbilityInfo>> | 是 | 程序启动作为入参的回调函数，返回Ability信息。 | | callback | AsyncCallback<Array\<AbilityInfo>> | 是 | 程序启动作为入参的回调函数，返回Ability信息。 |
...@@ -932,7 +932,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -932,7 +932,7 @@ SystemCapability.BundleManager.BundleFramework
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------ | --------------------------------------------------- | | ------------------------- | ---------------------------------------- |
| Promise\<BundleInstaller> | 返回值为Promise对象，Promise中包含BundleInstaller。 | | Promise\<BundleInstaller> | 返回值为Promise对象，Promise中包含BundleInstaller。 |
**示例：** **示例：**
...@@ -975,7 +975,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -975,7 +975,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ------------------------------ | ---- | ------------------------------------------------- | | -------- | ------------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback\<BundleInstaller> | 是 | 程序启动作为入参的回调函数，返回BundleInstaller。 | | callback | AsyncCallback\<BundleInstaller> | 是 | 程序启动作为入参的回调函数，返回BundleInstaller。 |
**示例：** **示例：**
...@@ -1019,12 +1019,12 @@ SystemCapability.BundleManager.BundleFramework ...@@ -1019,12 +1019,12 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------ | ---- | -------- | | ---------- | ------ | ---- | ------------ |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------------------------------------------ | | -------------- | -------------------------------------- |
| Promise\<Want> | 返回值为Promise对象，Promise中包含拉起指定应用的Want对象。 | | Promise\<Want> | 返回值为Promise对象，Promise中包含拉起指定应用的Want对象。 |
**示例：** **示例：**
...@@ -1056,7 +1056,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -1056,7 +1056,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------ | ---- | -------- | | ---------- | -------------------- | ---- | ------------------------------ |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| callback | AsyncCallback\<Want> | 是 | 程序启动作为入参的回调函数，返回拉起指定应用的want对象。 | | callback | AsyncCallback\<Want> | 是 | 程序启动作为入参的回调函数，返回拉起指定应用的want对象。 |
...@@ -1087,12 +1087,12 @@ SystemCapability.BundleManager.BundleFramework ...@@ -1087,12 +1087,12 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------ | ---- | -------- | | ---- | ------ | ---- | -------- |
| uid | number | 是 | 要查询的uid。 | | uid | number | 是 | 要查询的uid。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------------------------------------------ | | ---------------- | --------------------------------- |
| Promise\<string> | 返回值为Promise对象，Promise中包含指定uid的包名。 | | Promise\<string> | 返回值为Promise对象，Promise中包含指定uid的包名。 |
**示例：** **示例：**
...@@ -1120,7 +1120,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -1120,7 +1120,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------ | ---- | -------- | | -------- | ---------------------- | ---- | ------------------------- |
| uid | number | 是 | 要查询的uid。 | | uid | number | 是 | 要查询的uid。 |
| callback | AsyncCallback\<string> | 是 | 程序启动作为入参的回调函数，返回指定uid的包名。 | | callback | AsyncCallback\<string> | 是 | 程序启动作为入参的回调函数，返回指定uid的包名。 |
...@@ -1155,13 +1155,13 @@ SystemCapability.BundleManager.BundleFramework ...@@ -1155,13 +1155,13 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------ | ---- | -------- | | ----------- | ------ | ---- | ---------------- |
| bundleName | string | 是 | 要查询的bundleName。 | | bundleName | string | 是 | 要查询的bundleName。 |
| abilityName | string | 是 | 要查询的abilityName。 | | abilityName | string | 是 | 要查询的abilityName。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------------------------------------------ | | ---------------------------------------- | ---------------------------------------- |
| Promise\<[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)> | 返回值为<[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)>。 | | Promise\<[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)> | 返回值为<[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)>。 |
**示例：** **示例：**
...@@ -1194,7 +1194,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -1194,7 +1194,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------ | ---- | -------- | | ----------- | ---------------------------------------- | ---- | ---------------------------------------- |
| bundleName | string | 是 | 要查询的bundleName。 | | bundleName | string | 是 | 要查询的bundleName。 |
| abilityName | string | 是 | 要查询的abilityName。 | | abilityName | string | 是 | 要查询的abilityName。 |
| callback | AsyncCallback\<[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)> | 是 | 程序启动作为入参的回调函数，返回指定<[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)>。 | | callback | AsyncCallback\<[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)> | 是 | 程序启动作为入参的回调函数，返回指定<[PixelMap](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-image.md)>。 |
...@@ -1231,7 +1231,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -1231,7 +1231,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | ------------------------------------------------------------ | | -------------- | ------ | ---- | ---------------------------------------- |
| want | Want | 是 | 包含要查询的应用程序包名称的意图。 | | want | Want | 是 | 包含要查询的应用程序包名称的意图。 |
| extensionFlags | number | 是 | 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：大于等于0。 | | extensionFlags | number | 是 | 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：大于等于0。 |
| userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 | | userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 |
...@@ -1239,7 +1239,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -1239,7 +1239,7 @@ SystemCapability.BundleManager.BundleFramework
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------- | ---------------------------- | | ------------------------------------- | ------------------------------ |
| Promise<Array\<ExtensionAbilityInfo>> | Promise形式返回ExtensionAbility信息。 | | Promise<Array\<ExtensionAbilityInfo>> | Promise形式返回ExtensionAbility信息。 |
**示例：** **示例：**
...@@ -1278,7 +1278,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -1278,7 +1278,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ---------------------------------- | ---- | ------------------------------------------------------------ | | -------------- | ---------------------------------------- | ---- | ---------------------------------------- |
| want | Want | 是 | 指示包含要查询的应用程序包名称的意图。 | | want | Want | 是 | 指示包含要查询的应用程序包名称的意图。 |
| extensionFlags | number | 是 | 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：枚举值，大于等于0。 | | extensionFlags | number | 是 | 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：枚举值，大于等于0。 |
| userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 | | userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0 |
...@@ -1319,7 +1319,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -1319,7 +1319,7 @@ SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ---------------------------------- | ---- | ------------------------------------------------------------ | | -------------- | ---------------------------------------- | ---- | ---------------------------------------- |
| want | Want | 是 | 指示包含要查询的应用程序包名称的意图。 | | want | Want | 是 | 指示包含要查询的应用程序包名称的意图。 |
| extensionFlags | number | 是 | 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：大于等于0。 | | extensionFlags | number | 是 | 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：大于等于0。 |
| callback | AsyncCallback<Array\<ExtensionAbilityInfo>> | 是 | 程序启动作为入参的回调函数，返回ExtensionAbility信息。 | | callback | AsyncCallback<Array\<ExtensionAbilityInfo>> | 是 | 程序启动作为入参的回调函数，返回ExtensionAbility信息。 |
...@@ -1346,7 +1346,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { ...@@ -1346,7 +1346,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | ------------------------------------------------------------ | | ----------- | ---- | ------ | ---- | ---------------------------------------- |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 | | deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 只读 | string | 是 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | | bundleName | 只读 | string | 是 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读 | string | 是 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | | abilityName | 只读 | string | 是 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
...@@ -1358,7 +1358,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { ...@@ -1358,7 +1358,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:** SystemCapability.BundleManager.BundleFramework **系统能力:** SystemCapability.BundleManager.BundleFramework
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ------ | ------ | ------ | | ---------------------------------------- | ---- | ------------------------- |
| SUCCESS | 0 | 安装成功 | | SUCCESS | 0 | 安装成功 |
| STATUS_INSTALL_FAILURE | 1 | 安装失败（不存在安装的应用） | | STATUS_INSTALL_FAILURE | 1 | 安装失败（不存在安装的应用） |
| STATUS_INSTALL_FAILURE_ABORTED | 2 | 安装中止 | | STATUS_INSTALL_FAILURE_ABORTED | 2 | 安装中止 |
...@@ -1387,7 +1387,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { ...@@ -1387,7 +1387,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ------ | ------ | ------ | | ---------------------------------------- | ---------- | ------------------- |
| GET_BUNDLE_DEFAULT | 0x00000000 | 获取默认的应用信息 | | GET_BUNDLE_DEFAULT | 0x00000000 | 获取默认的应用信息 |
| GET_BUNDLE_WITH_ABILITIES | 0x00000001 | 获取包括Ability信息的包信息 | | GET_BUNDLE_WITH_ABILITIES | 0x00000001 | 获取包括Ability信息的包信息 |
| GET_ABILITY_INFO_WITH_PERMISSION | 0x00000002 | 获取包括权限的Ability信息 | | GET_ABILITY_INFO_WITH_PERMISSION | 0x00000002 | 获取包括权限的Ability信息 |
...@@ -1409,7 +1409,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { ...@@ -1409,7 +1409,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:** SystemCapability.BundleManager.BundleFramework **系统能力:** SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | ------ | ------ | ---- | ---- | ---------------------------- |
| userId | number | 是 | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | | userId | number | 是 | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
## BundleInfo ## BundleInfo
...@@ -1419,7 +1419,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { ...@@ -1419,7 +1419,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | --------------------------------- | ---------------------------- | ---- | ---- | --------------------- |
| name | string | 是 | 否 | 应用包的名称 | | name | string | 是 | 否 | 应用包的名称 |
| type | string | 是 | 否 | 应用包类型 | | type | string | 是 | 否 | 应用包类型 |
| appId | string | 是 | 否 | 应用包里应用程序的id | | appId | string | 是 | 否 | 应用包里应用程序的id |
...@@ -1452,7 +1452,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { ...@@ -1452,7 +1452,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | -------------------------- | ---------------------------------- | ---- | ---- | --------------------- |
| name | string | 是 | 否 | 应用程序的名称 | | name | string | 是 | 否 | 应用程序的名称 |
| description | string | 是 | 否 | 应用程序的描述 | | description | string | 是 | 否 | 应用程序的描述 |
| descriptionId | number | 是 | 否 | 应用程序的描述id | | descriptionId | number | 是 | 否 | 应用程序的描述id |
...@@ -1484,7 +1484,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { ...@@ -1484,7 +1484,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | --------------- | ------ | ---- | ---- | ---- |
| moduleName | string | 是 | 否 | 模块名称 | | moduleName | string | 是 | 否 | 模块名称 |
| moduleSourceDir | string | 是 | 否 | 安装目录 | | moduleSourceDir | string | 是 | 否 | 安装目录 |
...@@ -1495,7 +1495,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { ...@@ -1495,7 +1495,7 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ------ | ---- | ---- | ---------------- | | ------------------ | ------ | ---- | ---- | -------- |
| name | string | 是 | 是 | 自定义元数据名称 | | name | string | 是 | 是 | 自定义元数据名称 |
| value | string | 是 | 是 | 自定义元数据值 | | value | string | 是 | 是 | 自定义元数据值 |
| extra<sup>8+</sup> | string | 是 | 是 | 自定义资源 | | extra<sup>8+</sup> | string | 是 | 是 | 自定义资源 |
...@@ -1508,7 +1508,7 @@ Hap模块信息 ...@@ -1508,7 +1508,7 @@ Hap模块信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | --------------------------------- | ---------------------------- | ---- | ---- | ------------------ |
| name | string | 是 | 否 | 模块名称 | | name | string | 是 | 否 | 模块名称 |
| description | string | 是 | 否 | 模块描述信息 | | description | string | 是 | 否 | 模块描述信息 |
| descriptionId | number | 是 | 否 | 描述信息ID | | descriptionId | number | 是 | 否 | 描述信息ID |
...@@ -1535,7 +1535,7 @@ Hap模块信息 ...@@ -1535,7 +1535,7 @@ Hap模块信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | --------- | --------- | ---- | ---- | ---------- |
| name | string | 是 | 是 | 需要使用的权限名称 | | name | string | 是 | 是 | 需要使用的权限名称 |
| reason | string | 是 | 是 | 描述申请权限的原因 | | reason | string | 是 | 是 | 描述申请权限的原因 |
| usedScene | UsedScene | 是 | 是 | 权限使用的场景和时机 | | usedScene | UsedScene | 是 | 是 | 权限使用的场景和时机 |
...@@ -1547,7 +1547,7 @@ Hap模块信息 ...@@ -1547,7 +1547,7 @@ Hap模块信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | --------- | -------------- | ---- | ---- | ---------------- |
| abilities | Array\<string> | 是 | 是 | 使用到该权限的Ability集合 | | abilities | Array\<string> | 是 | 是 | 使用到该权限的Ability集合 |
| when | string | 是 | 是 | 使用该权限的时机 | | when | string | 是 | 是 | 使用该权限的时机 |
...@@ -1559,7 +1559,7 @@ Ability信息 ...@@ -1559,7 +1559,7 @@ Ability信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | --------------------- | --------------------- | ---- | ---- | ------------------------ |
| bundleName | string | 是 | 否 | 应用包名 | | bundleName | string | 是 | 否 | 应用包名 |
| name | string | 是 | 否 | Ability名称 | | name | string | 是 | 否 | Ability名称 |
| label | string | 是 | 否 | Ability对用户显示的名称 | | label | string | 是 | 否 | Ability对用户显示的名称 |
...@@ -1596,7 +1596,7 @@ Ability类型 ...@@ -1596,7 +1596,7 @@ Ability类型
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ------- | ---- | --------------------------- | | ------- | ---- | ----------------- |
| UNKNOWN | 无 | 未知Ability类型 | | UNKNOWN | 无 | 未知Ability类型 |
| PAGE | 无 | Ability有一个UI界面 | | PAGE | 无 | Ability有一个UI界面 |
| SERVICE | 无 | Ability没有UI界面 | | SERVICE | 无 | Ability没有UI界面 |
...@@ -1609,7 +1609,7 @@ Ability类型 ...@@ -1609,7 +1609,7 @@ Ability类型
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ------------- | ---- | ------------------------ | | ------------- | ---- | ------------- |
| UNSPECIFIED | 无 | 屏幕方向--不指定 | | UNSPECIFIED | 无 | 屏幕方向--不指定 |
| LANDSCAPE | 无 | 屏幕方向--横屏 | | LANDSCAPE | 无 | 屏幕方向--横屏 |
| PORTRAIT | 无 | 屏幕方向--竖屏 | | PORTRAIT | 无 | 屏幕方向--竖屏 |
...@@ -1622,7 +1622,7 @@ Ability类型 ...@@ -1622,7 +1622,7 @@ Ability类型
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ----------- | ---- | ------------------- | | --------- | ---- | ------------- |
| SINGLETON | 0 | Ability只有一个示例 | | SINGLETON | 0 | Ability只有一个示例 |
| STANDARD | 1 | Ability有多个示例 | | STANDARD | 1 | Ability有多个示例 |
...@@ -1633,7 +1633,7 @@ Ability的子类型 ...@@ -1633,7 +1633,7 @@ Ability的子类型
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ----------- | ---- | ----------------------------- | | ----------- | ---- | -------------------- |
| UNSPECIFIED | 0 | 未定义Ability子类型 | | UNSPECIFIED | 0 | 未定义Ability子类型 |
| CA | 1 | Ability子类型是带有 UI 的服务 | | CA | 1 | Ability子类型是带有 UI 的服务 |
...@@ -1645,7 +1645,7 @@ ExtensionAbility的类型 ...@@ -1645,7 +1645,7 @@ ExtensionAbility的类型
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| -------------------- | ---- | ----------------------------- | | ------------------------------ | ---- | ------------------------- |
| FORM<sup>9+</sup> | 0 | ExtensionAbility的类型包括卡片 | | FORM<sup>9+</sup> | 0 | ExtensionAbility的类型包括卡片 |
| WORK_SCHEDULER<sup>9+</sup> | 1 | ExtensionAbility的类型包括行程安排 | | WORK_SCHEDULER<sup>9+</sup> | 1 | ExtensionAbility的类型包括行程安排 |
| INPUT_METHOD<sup>9+</sup> | 2 | ExtensionAbility的类型包括输入法 | | INPUT_METHOD<sup>9+</sup> | 2 | ExtensionAbility的类型包括输入法 |
...@@ -1664,7 +1664,7 @@ ExtensionAbility的类型 ...@@ -1664,7 +1664,7 @@ ExtensionAbility的类型
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ------ | ------ | ------ | | ---------------------------------------- | ---------- | ------------------------------ |
| GET_EXTENSION_INFO_DEFAULT<sup>9+</sup> | 0x00000000 | 获取默认的extensionAbilityInfo | | GET_EXTENSION_INFO_DEFAULT<sup>9+</sup> | 0x00000000 | 获取默认的extensionAbilityInfo |
| GET_EXTENSION_INFO_WITH_PERMISSION<sup>9+</sup> | 0x00000002 | 获取携带权限信息的extensionAbilityInfo | | GET_EXTENSION_INFO_WITH_PERMISSION<sup>9+</sup> | 0x00000002 | 获取携带权限信息的extensionAbilityInfo |
| GET_EXTENSION_INFO_WITH_APPLICATION<sup>9+</sup> | 0x00000004 | 获取携带应用信息的extensionAbilityInfo | | GET_EXTENSION_INFO_WITH_APPLICATION<sup>9+</sup> | 0x00000004 | 获取携带应用信息的extensionAbilityInfo |
...@@ -1678,7 +1678,7 @@ ExtensionAbility的类型 ...@@ -1678,7 +1678,7 @@ ExtensionAbility的类型
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ----------- | ---- | ------------------- | | ---------- | ---- | ---- |
| AUTO_MODE | -1 | 自动模式 | | AUTO_MODE | -1 | 自动模式 |
| DARK_MODE | 0 | 夜间模式 | | DARK_MODE | 0 | 夜间模式 |
| LIGHT_MODE | 1 | 灯光模式 | | LIGHT_MODE | 1 | 灯光模式 |
...@@ -1691,7 +1691,7 @@ ExtensionAbility的类型 ...@@ -1691,7 +1691,7 @@ ExtensionAbility的类型
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ----------- | ---- | ------------------- | | ------------------ | ---- | ---- |
| PERMISSION_DENIED | -1 | 拒绝许可 | | PERMISSION_DENIED | -1 | 拒绝许可 |
| PERMISSION_GRANTED | 0 | 批准 | | PERMISSION_GRANTED | 0 | 批准 |
...@@ -1703,7 +1703,7 @@ ExtensionAbility信息 ...@@ -1703,7 +1703,7 @@ ExtensionAbility信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | --------------------------------- | --------------------------- | ---- | ---- | --------------------------------- |
| bundleName<sup>9+</sup> | string | 是 | 否 | 应用包名 | | bundleName<sup>9+</sup> | string | 是 | 否 | 应用包名 |
| moduleName<sup>9+</sup> | string | 是 | 否 | ExtensionAbility所属的HAP包的名称 | | moduleName<sup>9+</sup> | string | 是 | 否 | ExtensionAbility所属的HAP包的名称 |
| name<sup>9+</sup> | string | 是 | 否 | ExtensionAbility名称 | | name<sup>9+</sup> | string | 是 | 否 | ExtensionAbility名称 |
...@@ -1727,7 +1727,7 @@ ExtensionAbility信息 ...@@ -1727,7 +1727,7 @@ ExtensionAbility信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ------ | ---- | ---- | ---------------- | | --------------------- | ------ | ---- | ---- | ----- |
| name<sup>9+</sup> | string | 是 | 是 | 元数据名称 | | name<sup>9+</sup> | string | 是 | 是 | 元数据名称 |
| value<sup>9+</sup> | string | 是 | 是 | 元数据值 | | value<sup>9+</sup> | string | 是 | 是 | 元数据值 |
| resource<sup>9+</sup> | string | 是 | 是 | 元数据资源 | | resource<sup>9+</sup> | string | 是 | 是 | 元数据资源 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
浏览文件 @ 481ff40b
...@@ -21,7 +21,7 @@ createAppAccountManager(): AppAccountManager ...@@ -21,7 +21,7 @@ createAppAccountManager(): AppAccountManager
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------- | ------------------------ | | ----------------- | ------------ |
| AppAccountManager | 获取应用帐号模块的实例。 | | AppAccountManager | 获取应用帐号模块的实例。 |
**示例：** **示例：**
...@@ -44,7 +44,7 @@ addAccount(name: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -44,7 +44,7 @@ addAccount(name: string, callback: AsyncCallback&lt;void&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------ | | -------- | ------------------------- | ---- | --------------------- |
| name | string | 是 | 要添加的应用帐户的名称。 | | name | string | 是 | 要添加的应用帐户的名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 将此应用的帐号名添加到帐号管理服务的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 将此应用的帐号名添加到帐号管理服务的回调。 |
...@@ -68,7 +68,7 @@ addAccount(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;) ...@@ -68,7 +68,7 @@ addAccount(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;)
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ------------------------------------------------------------ | | --------- | ------------------------- | ---- | ---------------------------------------- |
| name | string | 是 | 要添加的应用帐户的名称。 | | name | string | 是 | 要添加的应用帐户的名称。 |
| extraInfo | string | 是 | 要添加的应用帐户的额外信息(例如token等)，额外的信息不能是应用帐号的敏感信息。 | | extraInfo | string | 是 | 要添加的应用帐户的额外信息(例如token等)，额外的信息不能是应用帐号的敏感信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 将此应用程序的帐号名和额外信息添加到帐号管理服务中的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 将此应用程序的帐号名和额外信息添加到帐号管理服务中的回调。 |
...@@ -95,14 +95,14 @@ addAccount(name: string, extraInfo?: string): Promise&lt;void&gt; ...@@ -95,14 +95,14 @@ addAccount(name: string, extraInfo?: string): Promise&lt;void&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------------------------------------------------------------ | | --------- | ------ | ---- | -------------------------------- |
| name | string | 是 | 要添加的应用帐户的名称。 | | name | string | 是 | 要添加的应用帐户的名称。 |
| extraInfo | string | 是 | 要添加的应用帐户的额外信息，额外的信息不能是应用帐号的敏感信息。 | | extraInfo | string | 是 | 要添加的应用帐户的额外信息，额外的信息不能是应用帐号的敏感信息。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ----------------------------------- | | ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -127,7 +127,7 @@ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: a ...@@ -127,7 +127,7 @@ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: a
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------------ | | -------- | --------------------- | ---- | --------------- |
| owner | string | 是 | 要添加的应用帐户的所有者包名。 | | owner | string | 是 | 要添加的应用帐户的所有者包名。 |
| authType | string | 是 | 要添加的应用帐户的鉴权类型。 | | authType | string | 是 | 要添加的应用帐户的鉴权类型。 |
| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 | | options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 |
...@@ -168,7 +168,7 @@ deleteAccount(name: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -168,7 +168,7 @@ deleteAccount(name: string, callback: AsyncCallback&lt;void&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------- | | -------- | ------------------------- | ---- | ----------------- |
| name | string | 是 | 要删除的应用帐户的名称。 | | name | string | 是 | 要删除的应用帐户的名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 帐号管理服务中删除应用帐号的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 帐号管理服务中删除应用帐号的回调。 |
...@@ -192,13 +192,13 @@ deleteAccount(name: string): Promise&lt;void&gt; ...@@ -192,13 +192,13 @@ deleteAccount(name: string): Promise&lt;void&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------ | | ---- | ------ | ---- | ------------ |
| name | string | 是 | 要删除的应用帐户的名称。 | | name | string | 是 | 要删除的应用帐户的名称。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------------ | :---------------------------------- | | :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -223,7 +223,7 @@ disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;vo ...@@ -223,7 +223,7 @@ disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;vo
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ------------------------------------------------------------ | | ---------- | ------------------------- | ---- | ------------------------------- |
| name | string | 是 | 要禁用访问的第三方应用帐户的名称。 | | name | string | 是 | 要禁用访问的第三方应用帐户的名称。 |
| bundleName | string | 是 | 第三方应用的包名。 | | bundleName | string | 是 | 第三方应用的包名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 禁止指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 禁止指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 |
...@@ -248,14 +248,14 @@ disableAppAccess(name: string, bundleName: string): Promise&lt;void&gt; ...@@ -248,14 +248,14 @@ disableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---------------------------------- | | ---------- | ------ | ---- | ----------------- |
| name | string | 是 | 要禁用访问的第三方应用帐户的名称。 | | name | string | 是 | 要禁用访问的第三方应用帐户的名称。 |
| bundleName | string | 是 | 第三方应用的包名。 | | bundleName | string | 是 | 第三方应用的包名。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------------ | :---------------------------------- | | :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -280,7 +280,7 @@ enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;voi ...@@ -280,7 +280,7 @@ enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;voi
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ------------------------------------------------------------ | | ---------- | ------------------------- | ---- | ------------------------------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| bundleName | string | 是 | 第三方应用的包名。 | | bundleName | string | 是 | 第三方应用的包名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 允许指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 允许指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 |
...@@ -305,14 +305,14 @@ enableAppAccess(name: string, bundleName: string): Promise&lt;void&gt; ...@@ -305,14 +305,14 @@ enableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ------------------ | | ---------- | ------ | ---- | --------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| bundleName | string | 是 | 第三方应用的包名。 | | bundleName | string | 是 | 第三方应用的包名。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------------ | :---------------------------------- | | :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -338,7 +338,7 @@ checkAppAccountSyncEnable(name: string, callback: AsyncCallback&lt;boolean&gt;): ...@@ -338,7 +338,7 @@ checkAppAccountSyncEnable(name: string, callback: AsyncCallback&lt;boolean&gt;):
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | -------------------------------------------- | | -------- | ---------------------------- | ---- | ---------------------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 检查指定应用帐号是否允许应用数据同步的回调。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 检查指定应用帐号是否允许应用数据同步的回调。 |
...@@ -365,13 +365,13 @@ checkAppAccountSyncEnable(name: string): Promise&lt;boolean&gt; ...@@ -365,13 +365,13 @@ checkAppAccountSyncEnable(name: string): Promise&lt;boolean&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- | | ---- | ------ | ---- | ------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :--------------------- | :---------------------------------- | | :--------------------- | :-------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -396,7 +396,7 @@ setAccountCredential(name: string, credentialType: string, credential: string,ca ...@@ -396,7 +396,7 @@ setAccountCredential(name: string, credentialType: string, credential: string,ca
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------- | ---- | ---------------------------- | | -------------- | ------------------------- | ---- | -------------- |
| name | string | 是 | 应用程序帐户的名称。 | | name | string | 是 | 应用程序帐户的名称。 |
| credentialType | string | 是 | 要设置的凭据的类型。 | | credentialType | string | 是 | 要设置的凭据的类型。 |
| credential | string | 是 | 要设置的凭据。 | | credential | string | 是 | 要设置的凭据。 |
...@@ -422,7 +422,7 @@ setAccountCredential(name: string, credentialType: string, credential: string): ...@@ -422,7 +422,7 @@ setAccountCredential(name: string, credentialType: string, credential: string):
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | -------------------- | | -------------- | ------ | ---- | ---------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| credentialType | string | 是 | 要设置的凭据的类型。 | | credentialType | string | 是 | 要设置的凭据的类型。 |
| credential | string | 是 | 要设置的凭据。 | | credential | string | 是 | 要设置的凭据。 |
...@@ -430,7 +430,7 @@ setAccountCredential(name: string, credentialType: string, credential: string): ...@@ -430,7 +430,7 @@ setAccountCredential(name: string, credentialType: string, credential: string):
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------------ | :---------------------------------- | | :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -455,7 +455,7 @@ setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback&lt; ...@@ -455,7 +455,7 @@ setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback&lt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | -------------------------------- | | --------- | ------------------------- | ---- | ---------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| extraInfo | string | 是 | 要设置的额外信息。 | | extraInfo | string | 是 | 要设置的额外信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置此应用帐号的额外信息的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 设置此应用帐号的额外信息的回调。 |
...@@ -480,14 +480,14 @@ setAccountExtraInfo(name: string, extraInfo: string): Promise&lt;void&gt; ...@@ -480,14 +480,14 @@ setAccountExtraInfo(name: string, extraInfo: string): Promise&lt;void&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------------------ | | --------- | ------ | ---- | --------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| extraInfo | string | 是 | 要设置的额外信息。 | | extraInfo | string | 是 | 要设置的额外信息。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------------ | :---------------------------------- | | :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -514,7 +514,7 @@ setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback ...@@ -514,7 +514,7 @@ setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------------------------------------------- | | -------- | ------------------------- | ---- | ------------------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| isEnable | boolean | 是 | 是否允许应用数据同步。 | | isEnable | boolean | 是 | 是否允许应用数据同步。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置指定的应用帐号是否允许应用程序数据同步的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 设置指定的应用帐号是否允许应用程序数据同步的回调。 |
...@@ -541,14 +541,14 @@ setAppAccountSyncEnable(name: string, isEnable: boolean): Promise&lt;void&gt; ...@@ -541,14 +541,14 @@ setAppAccountSyncEnable(name: string, isEnable: boolean): Promise&lt;void&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------- | ---- | ---------------------- | | -------- | ------- | ---- | ----------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| isEnable | boolean | 是 | 是否允许应用数据同步。 | | isEnable | boolean | 是 | 是否允许应用数据同步。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------------ | :---------------------------------- | | :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -573,7 +573,7 @@ setAssociatedData(name: string, key: string, value: string, callback: AsyncCallb ...@@ -573,7 +573,7 @@ setAssociatedData(name: string, key: string, value: string, callback: AsyncCallb
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------- | | -------- | ------------------------- | ---- | ----------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | | key | string | 是 | 要设置的数据的键，密钥可以自定义。 |
| value | string | 是 | 要设置的数据的值。 | | value | string | 是 | 要设置的数据的值。 |
...@@ -598,7 +598,7 @@ setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt; ...@@ -598,7 +598,7 @@ setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------------------- | | ----- | ------ | ---- | ----------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | | key | string | 是 | 要设置的数据的键，密钥可以自定义。 |
| value | string | 是 | 要设置的数据的值。 | | value | string | 是 | 要设置的数据的值。 |
...@@ -606,7 +606,7 @@ setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt; ...@@ -606,7 +606,7 @@ setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------------ | :---------------------------------- | | :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -631,7 +631,7 @@ getAccountCredential(name: string, credentialType: string, callback: AsyncCallba ...@@ -631,7 +631,7 @@ getAccountCredential(name: string, credentialType: string, callback: AsyncCallba
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | --------------------------- | ---- | ---------------------------- | | -------------- | --------------------------- | ---- | -------------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| credentialType | string | 是 | 要获取的凭据的类型。 | | credentialType | string | 是 | 要获取的凭据的类型。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 获取此应用帐号的凭据的回调。 | | callback | AsyncCallback&lt;string&gt; | 是 | 获取此应用帐号的凭据的回调。 |
...@@ -657,14 +657,14 @@ getAccountCredential(name: string, credentialType: string): Promise&lt;string&gt ...@@ -657,14 +657,14 @@ getAccountCredential(name: string, credentialType: string): Promise&lt;string&gt
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | -------------------- | | -------------- | ------ | ---- | ---------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| credentialType | string | 是 | 要获取的凭据的类型。 | | credentialType | string | 是 | 要获取的凭据的类型。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------------- | :---------------------------------- | | :-------------------- | :-------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -689,7 +689,7 @@ getAccountExtraInfo(name: string, callback: AsyncCallback&lt;string&gt;): void ...@@ -689,7 +689,7 @@ getAccountExtraInfo(name: string, callback: AsyncCallback&lt;string&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------------------------- | | -------- | --------------------------- | ---- | ---------------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 获取此应用帐号的额外信息的回调。 | | callback | AsyncCallback&lt;string&gt; | 是 | 获取此应用帐号的额外信息的回调。 |
...@@ -714,13 +714,13 @@ getAccountExtraInfo(name: string): Promise&lt;string&gt; ...@@ -714,13 +714,13 @@ getAccountExtraInfo(name: string): Promise&lt;string&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- | | ---- | ------ | ---- | ------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------------- | :---------------------------------- | | :-------------------- | :-------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -745,7 +745,7 @@ getAssociatedData(name: string, key: string, callback: AsyncCallback&lt;string&g ...@@ -745,7 +745,7 @@ getAssociatedData(name: string, key: string, callback: AsyncCallback&lt;string&g
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ---------------------------------- | | -------- | --------------------------- | ---- | ----------------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要获取的数据的key。 | | key | string | 是 | 要获取的数据的key。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 获取与此应用帐号关联的数据的回调。 | | callback | AsyncCallback&lt;string&gt; | 是 | 获取与此应用帐号关联的数据的回调。 |
...@@ -771,14 +771,14 @@ getAssociatedData(name: string, key: string): Promise&lt;string&gt; ...@@ -771,14 +771,14 @@ getAssociatedData(name: string, key: string): Promise&lt;string&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------- | | ---- | ------ | ---- | ----------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要获取的数据的key。 | | key | string | 是 | 要获取的数据的key。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------------- | :---------------------------------- | | :-------------------- | :-------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -805,7 +805,7 @@ getAllAccessibleAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;& ...@@ -805,7 +805,7 @@ getAllAccessibleAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ---- | ---------------- | | -------- | ---------------------------------------- | ---- | -------- |
| callback | AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是 | 应用帐号信息列表 | | callback | AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是 | 应用帐号信息列表 |
**示例：** **示例：**
...@@ -831,7 +831,7 @@ getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt; ...@@ -831,7 +831,7 @@ getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
**参数：** **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------ | ----------------------------------- | | ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt;AppAccountInfo&gt;&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;Array&lt;AppAccountInfo&gt;&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -858,7 +858,7 @@ getAllAccounts(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo ...@@ -858,7 +858,7 @@ getAllAccounts(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ---- | ---------------- | | -------- | ---------------------------------------- | ---- | -------- |
| owner | string | 是 | 应用包名称 | | owner | string | 是 | 应用包名称 |
| callback | AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是 | 应用帐号信息列表 | | callback | AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是 | 应用帐号信息列表 |
...@@ -886,13 +886,13 @@ getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt; ...@@ -886,13 +886,13 @@ getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------- | | ----- | ------ | ---- | ----- |
| owner | string | 是 | 应用包名称 | | owner | string | 是 | 应用包名称 |
**参数：** **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------ | ----------------------------------- | | ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt;AppAccountInfo&gt;&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;Array&lt;AppAccountInfo&gt;&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -918,7 +918,7 @@ on(type: 'change', owners: Array&lt;string&gt;, callback: Callback&lt;Array&lt;A ...@@ -918,7 +918,7 @@ on(type: 'change', owners: Array&lt;string&gt;, callback: Callback&lt;Array&lt;A
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | 'change' | 是 | 关于帐户更改事件，当帐户所有者更新帐户时，订阅者将收到通知。 | | type | 'change' | 是 | 关于帐户更改事件，当帐户所有者更新帐户时，订阅者将收到通知。 |
| owners | Array&lt;string&gt; | 是 | 指示帐户的所有者。 | | owners | Array&lt;string&gt; | 是 | 指示帐户的所有者。 |
| callback | Callback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是 | 订阅指定帐号所有者的帐户变更事件的回调。 | | callback | Callback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是 | 订阅指定帐号所有者的帐户变更事件的回调。 |
...@@ -949,7 +949,7 @@ off(type: 'change', callback?: Callback<Array\<AppAccountInfo>>): void ...@@ -949,7 +949,7 @@ off(type: 'change', callback?: Callback<Array\<AppAccountInfo>>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | ---- | ------------------------ | | -------- | -------------------------------- | ---- | ------------ |
| type | 'change' | 是 | 关于帐户更改事件。 | | type | 'change' | 是 | 关于帐户更改事件。 |
| callback | Callback<Array\<AppAccountInfo>> | 否 | 取消订阅帐号事件的回调。 | | callback | Callback<Array\<AppAccountInfo>> | 否 | 取消订阅帐号事件的回调。 |
...@@ -982,7 +982,7 @@ authenticate(name: string, owner: string, authType: string, options: {[key: stri ...@@ -982,7 +982,7 @@ authenticate(name: string, owner: string, authType: string, options: {[key: stri
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------------ | | -------- | --------------------- | ---- | --------------- |
| name | string | 是 | 要鉴权的应用帐户的名称。 | | name | string | 是 | 要鉴权的应用帐户的名称。 |
| owner | string | 是 | 要鉴权的应用帐户的所有者包名。 | | owner | string | 是 | 要鉴权的应用帐户的所有者包名。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
...@@ -1024,7 +1024,7 @@ getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCall ...@@ -1024,7 +1024,7 @@ getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCall
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ---------------------- | | -------- | --------------------------- | ---- | ----------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
...@@ -1051,7 +1051,7 @@ getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string& ...@@ -1051,7 +1051,7 @@ getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string&
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------- | | -------- | ------ | ---- | ----------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
...@@ -1059,7 +1059,7 @@ getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string& ...@@ -1059,7 +1059,7 @@ getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string&
**参数：** **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------------------------------- | | --------------------- | --------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -1084,7 +1084,7 @@ setOAuthToken(name: string, authType: string, token: string, callback: AsyncCall ...@@ -1084,7 +1084,7 @@ setOAuthToken(name: string, authType: string, token: string, callback: AsyncCall
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------- | | -------- | ------------------------- | ---- | -------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| token | string | 是 | OAuth令牌。 | | token | string | 是 | OAuth令牌。 |
...@@ -1110,7 +1110,7 @@ setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt ...@@ -1110,7 +1110,7 @@ setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------- | | -------- | ------ | ---- | -------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| token | string | 是 | OAuth令牌。 | | token | string | 是 | OAuth令牌。 |
...@@ -1118,7 +1118,7 @@ setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt ...@@ -1118,7 +1118,7 @@ setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt
**参数：** **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ----------------------------------- | | ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -1143,7 +1143,7 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string, c ...@@ -1143,7 +1143,7 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string, c
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------- | | -------- | ------------------------- | ---- | ------------ |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
...@@ -1170,7 +1170,7 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string): ...@@ -1170,7 +1170,7 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string):
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------- | | -------- | ------ | ---- | ------------ |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
...@@ -1179,7 +1179,7 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string): ...@@ -1179,7 +1179,7 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string):
**参数：** **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ----------------------------------- | | ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -1204,7 +1204,7 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi ...@@ -1204,7 +1204,7 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ------------------------ | | ---------- | ------------------------- | ---- | ------------ |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 被设置可见性的应用包名。 | | bundleName | string | 是 | 被设置可见性的应用包名。 |
...@@ -1231,7 +1231,7 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi ...@@ -1231,7 +1231,7 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ------------------------ | | ---------- | ------- | ---- | ------------ |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 被设置可见性的应用包名。 | | bundleName | string | 是 | 被设置可见性的应用包名。 |
...@@ -1240,14 +1240,13 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi ...@@ -1240,14 +1240,13 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi
**参数：** **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ----------------------------------- | | ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true).then(() => { appAccountManager.setOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true).then(() => {
console.log('setOAuthTokenVisibility successfully'); console.log('setOAuthTokenVisibility successfully');
}).catch((err) => { }).catch((err) => {
...@@ -1266,7 +1265,7 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, ca ...@@ -1266,7 +1265,7 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, ca
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------- | ---- | -------------------------- | | ---------- | ---------------------------- | ---- | ------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 用于检查可见性的应用包名。 | | bundleName | string | 是 | 用于检查可见性的应用包名。 |
...@@ -1293,7 +1292,7 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P ...@@ -1293,7 +1292,7 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | -------------------------- | | ---------- | ------ | ---- | ------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 用于检查可见性的应用包名。 | | bundleName | string | 是 | 用于检查可见性的应用包名。 |
...@@ -1301,7 +1300,7 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P ...@@ -1301,7 +1300,7 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P
**参数：** **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | ----------------------------------- | | ---------------------- | --------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -1326,7 +1325,7 @@ getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array& ...@@ -1326,7 +1325,7 @@ getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array&
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ---- | ---------------------- | | -------- | ---------------------------------------- | ---- | ----------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
| callback | AsyncCallback&lt;Array&lt;OAuthTokenInfo&gt;&gt; | 是 | 查询结果的回调。 | | callback | AsyncCallback&lt;Array&lt;OAuthTokenInfo&gt;&gt; | 是 | 查询结果的回调。 |
...@@ -1352,14 +1351,14 @@ getAllOAuthTokens(name: string, owner: string): Promise&lt;Array&lt;OAuthTokenIn ...@@ -1352,14 +1351,14 @@ getAllOAuthTokens(name: string, owner: string): Promise&lt;Array&lt;OAuthTokenIn
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- | | ----- | ------ | ---- | ----------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
**参数：** **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------ | ----------------------------------- | | ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt;OAuthTokenInfo&gt;&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;Array&lt;OAuthTokenInfo&gt;&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -1384,7 +1383,7 @@ getOAuthList(name: string, authType: string, callback: AsyncCallback&lt;Array&lt ...@@ -1384,7 +1383,7 @@ getOAuthList(name: string, authType: string, callback: AsyncCallback&lt;Array&lt
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------- | | -------- | ---------------------------------------- | ---- | ----------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 查询结果的回调。 | | callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 查询结果的回调。 |
...@@ -1410,14 +1409,14 @@ getOAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt; ...@@ -1410,14 +1409,14 @@ getOAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- | | ----- | ------ | ---- | ----------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
**参数：** **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | ----------------------------------- | | ---------------------------------- | --------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;Array&lt;string&gt;&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -1442,7 +1441,7 @@ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;Authentic ...@@ -1442,7 +1441,7 @@ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;Authentic
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------------------ | ---- | ---------------- | | --------- | ---------------------------------------- | ---- | -------- |
| sessionId | string | 是 | 鉴权会话的标识。 | | sessionId | string | 是 | 鉴权会话的标识。 |
| callback | AsyncCallback&lt;AuthenticatorCallback&gt; | 是 | 查询结果的回调。 | | callback | AsyncCallback&lt;AuthenticatorCallback&gt; | 是 | 查询结果的回调。 |
...@@ -1477,13 +1476,13 @@ getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt ...@@ -1477,13 +1476,13 @@ getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------------- | | --------- | ------ | ---- | -------- |
| sessionId | string | 是 | 鉴权会话的标识。 | | sessionId | string | 是 | 鉴权会话的标识。 |
**参数：** **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------ | ----------------------------------- | | ------------------------------------ | --------------------- |
| Promise&lt;AuthenticatorCallback&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;AuthenticatorCallback&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -1517,7 +1516,7 @@ getAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo ...@@ -1517,7 +1516,7 @@ getAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ---------------------- | | -------- | -------------------------------------- | ---- | ----------- |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
| callback | AsyncCallback&lt;AuthenticatorInfo&gt; | 是 | 查询结果的回调。 | | callback | AsyncCallback&lt;AuthenticatorInfo&gt; | 是 | 查询结果的回调。 |
...@@ -1542,13 +1541,13 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt; ...@@ -1542,13 +1541,13 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- | | ----- | ------ | ---- | ----------- |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
**参数：** **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | ----------------------------------- | | -------------------------------- | --------------------- |
| Promise&lt;AuthenticatorInfo&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;AuthenticatorInfo&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -1569,7 +1568,7 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt; ...@@ -1569,7 +1568,7 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- | | ----- | ------ | ---- | ----------- |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
...@@ -1580,7 +1579,7 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt; ...@@ -1580,7 +1579,7 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------- | | -------- | ------ | ---- | -------- |
| authType | string | 是 | 令牌的鉴权类型。 | | authType | string | 是 | 令牌的鉴权类型。 |
| token | string | 是 | 令牌的取值。 | | token | string | 是 | 令牌的取值。 |
...@@ -1591,7 +1590,7 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt; ...@@ -1591,7 +1590,7 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | -------------------- | | ------- | ------ | ---- | ---------- |
| owner | string | 是 | 认证器的所有者包名。 | | owner | string | 是 | 认证器的所有者包名。 |
| iconId | string | 是 | 认证器的图标标识。 | | iconId | string | 是 | 认证器的图标标识。 |
| labelId | string | 是 | 认证器的标签标识。 | | labelId | string | 是 | 认证器的标签标识。 |
...@@ -1603,7 +1602,7 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt; ...@@ -1603,7 +1602,7 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| ----------------------------- | ---------------------- | ------------------------- | | ----------------------------- | ---------------------- | ------------- |
| ACTION_ADD_ACCOUNT_IMPLICITLY | "addAccountImplicitly" | 表示操作_隐式添加帐号。 | | ACTION_ADD_ACCOUNT_IMPLICITLY | "addAccountImplicitly" | 表示操作_隐式添加帐号。 |
| ACTION_AUTHENTICATE | "authenticate" | 表示操作_鉴权。 | | ACTION_AUTHENTICATE | "authenticate" | 表示操作_鉴权。 |
| KEY_NAME | "name" | 表示键名_应用帐户名称。 | | KEY_NAME | "name" | 表示键名_应用帐户名称。 |
...@@ -1623,7 +1622,7 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt; ...@@ -1623,7 +1622,7 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| ----------------------------------- | ------ | ------------------------ | | ----------------------------------- | ----- | ------------ |
| SUCCESS | 0 | 表示操作成功。 | | SUCCESS | 0 | 表示操作成功。 |
| ERROR_ACCOUNT_NOT_EXIST | 10001 | 表示应用帐户不存在。 | | ERROR_ACCOUNT_NOT_EXIST | 10001 | 表示应用帐户不存在。 |
| ERROR_APP_ACCOUNT_SERVICE_EXCEPTION | 10002 | 表示应用帐户服务异常。 | | ERROR_APP_ACCOUNT_SERVICE_EXCEPTION | 10002 | 表示应用帐户服务异常。 |
...@@ -1658,7 +1657,7 @@ onResult: (code: number, result: {[key: string]: any}) =&gt; void ...@@ -1658,7 +1657,7 @@ onResult: (code: number, result: {[key: string]: any}) =&gt; void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------- | ---- | ------------ | | ------ | -------------------- | ---- | ------ |
| code | number | 是 | 鉴权结果码。 | | code | number | 是 | 鉴权结果码。 |
| result | {[key: string]: any} | 是 | 鉴权结果。 | | result | {[key: string]: any} | 是 | 鉴权结果。 |
...@@ -1688,7 +1687,7 @@ onRequestRedirected: (request: Want) =&gt; void ...@@ -1688,7 +1687,7 @@ onRequestRedirected: (request: Want) =&gt; void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---- | ---- | -------------------- | | ------- | ---- | ---- | ---------- |
| request | Want | 是 | 用于跳转的请求信息。 | | request | Want | 是 | 用于跳转的请求信息。 |
**示例：** **示例：**
...@@ -1725,7 +1724,7 @@ addAccountImplicitly(authType: string, callerBundleName: string, options: {[key: ...@@ -1725,7 +1724,7 @@ addAccountImplicitly(authType: string, callerBundleName: string, options: {[key:
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------------- | --------------------- | ---- | ------------------------------ | | ---------------- | --------------------- | ---- | --------------- |
| authType | string | 是 | 应用帐户的鉴权类型。 | | authType | string | 是 | 应用帐户的鉴权类型。 |
| callerBundleName | string | 是 | 鉴权请求方的包名。 | | callerBundleName | string | 是 | 鉴权请求方的包名。 |
| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 | | options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 |
...@@ -1741,7 +1740,7 @@ authenticate(name: string, authType: string, callerBundleName: string, options: ...@@ -1741,7 +1740,7 @@ authenticate(name: string, authType: string, callerBundleName: string, options:
**参数：** **参数：**
| 接口名 | 类型 | 必填 | 说明 | | 接口名 | 类型 | 必填 | 说明 |
| ---------------- | --------------------- | ---- | ------------------------------ | | ---------------- | --------------------- | ---- | --------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 应用帐户的鉴权类型。 | | authType | string | 是 | 应用帐户的鉴权类型。 |
| callerBundleName | string | 是 | 鉴权请求方的包名。 | | callerBundleName | string | 是 | 鉴权请求方的包名。 |
......
zh-cn/application-dev/reference/apis/js-apis-bluetooth.md
浏览文件 @ 481ff40b
...@@ -24,8 +24,6 @@ ohos.permission.DISCOVER_BLUETOOTH ...@@ -24,8 +24,6 @@ ohos.permission.DISCOVER_BLUETOOTH
ohos.permission.LOCATION ohos.permission.LOCATION
## bluetooth.enableBluetooth<sup>8+</sup><a name="enableBluetooth"></a> ## bluetooth.enableBluetooth<sup>8+</sup><a name="enableBluetooth"></a>
enableBluetooth(): boolean enableBluetooth(): boolean
...@@ -39,7 +37,7 @@ enableBluetooth(): boolean ...@@ -39,7 +37,7 @@ enableBluetooth(): boolean
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | --------------------------------------- | | ------- | ------------------------ |
| boolean | 打开蓝牙，成功返回true，否则返回false。 | | boolean | 打开蓝牙，成功返回true，否则返回false。 |
**示例：** **示例：**
...@@ -62,7 +60,7 @@ disableBluetooth(): boolean ...@@ -62,7 +60,7 @@ disableBluetooth(): boolean
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | --------------------------------------- | | ------- | ------------------------ |
| boolean | 关闭蓝牙，成功返回true，否则返回false。 | | boolean | 关闭蓝牙，成功返回true，否则返回false。 |
**示例：** **示例：**
...@@ -85,7 +83,7 @@ getLocalName(): string ...@@ -85,7 +83,7 @@ getLocalName(): string
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------------ | | ------ | --------- |
| string | 蓝牙本地设备名称。 | | string | 蓝牙本地设备名称。 |
**示例：** **示例：**
...@@ -108,7 +106,7 @@ getState(): BluetoothState ...@@ -108,7 +106,7 @@ getState(): BluetoothState
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------- | ------------------ | | --------------------------------- | --------- |
| [BluetoothState](#bluetoothstate) | 表示蓝牙开关状态。 | | [BluetoothState](#bluetoothstate) | 表示蓝牙开关状态。 |
**示例：** **示例：**
...@@ -131,7 +129,7 @@ getBtConnectionState(): ProfileConnectionState ...@@ -131,7 +129,7 @@ getBtConnectionState(): ProfileConnectionState
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------- | ------------------------------- | | ---------------------------------------- | ------------------- |
| [ProfileConnectionState](#profileconnectionstate) | 表示蓝牙设备的Profile连接状态。 | | [ProfileConnectionState](#profileconnectionstate) | 表示蓝牙设备的Profile连接状态。 |
**示例：** **示例：**
...@@ -154,13 +152,13 @@ setLocalName(name: string): boolean ...@@ -154,13 +152,13 @@ setLocalName(name: string): boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | --------------------------------------- | | ---- | ------ | ---- | --------------------- |
| name | string | 是 | 要设置的蓝牙名称，最大长度为248字节数。 | | name | string | 是 | 要设置的蓝牙名称，最大长度为248字节数。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | --------------------------------------------------- | | ------- | ------------------------------ |
| boolean | 设置蓝牙本地设备名称，成功返回true，否则返回false。 | | boolean | 设置蓝牙本地设备名称，成功返回true，否则返回false。 |
**示例：** **示例：**
...@@ -183,13 +181,13 @@ pairDevice(deviceId: string): boolean ...@@ -183,13 +181,13 @@ pairDevice(deviceId: string): boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | --------------------------------------------------- | | -------- | ------ | ---- | ----------------------------------- |
| deviceId | string | 是 | 表示配对的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | deviceId | string | 是 | 表示配对的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ------------------------------------------- | | ------- | -------------------------- |
| boolean | 发起蓝牙配对，成功返回true，否则返回false。 | | boolean | 发起蓝牙配对，成功返回true，否则返回false。 |
**示例：** **示例：**
...@@ -213,13 +211,13 @@ getProfileConnState(profileId: ProfileId): ProfileConnectionState ...@@ -213,13 +211,13 @@ getProfileConnState(profileId: ProfileId): ProfileConnectionState
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | --------- | ---- | ------------------------------------------------ | | --------- | --------- | ---- | ------------------------------------- |
| ProfileId | profileId | 是 | 表示profile的枚举值，例如：PROFILE_A2DP_SOURCE。 | | ProfileId | profileId | 是 | 表示profile的枚举值，例如：PROFILE_A2DP_SOURCE。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------- | ------------------- | | ---------------------------------------- | ------------- |
| [ProfileConnectionState](#ProfileConnectionState) | profile的连接状态。 | | [ProfileConnectionState](#ProfileConnectionState) | profile的连接状态。 |
**示例：** **示例：**
...@@ -242,13 +240,13 @@ cancelPairedDevice(deviceId: string): boolean ...@@ -242,13 +240,13 @@ cancelPairedDevice(deviceId: string): boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------- | | -------- | ------ | ---- | ------------------------------------- |
| deviceId | string | 是 | 表示要删除的远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 | | deviceId | string | 是 | 表示要删除的远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ------------------------------------------- | | ------- | -------------------------- |
| boolean | 启动取消配对，成功返回true，否则返回false。 | | boolean | 启动取消配对，成功返回true，否则返回false。 |
**示例：** **示例：**
...@@ -271,13 +269,13 @@ getRemoteDeviceName(deviceId: string): string ...@@ -271,13 +269,13 @@ getRemoteDeviceName(deviceId: string): string
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ----------------------------------------------- | | -------- | ------ | ---- | --------------------------------- |
| deviceId | string | 是 | 表示远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 | | deviceId | string | 是 | 表示远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------------------------- | | ------ | ------------- |
| string | 以字符串格式返回设备名称。 | | string | 以字符串格式返回设备名称。 |
**示例：** **示例：**
...@@ -300,13 +298,13 @@ getRemoteDeviceClass(deviceId: string): DeviceClass ...@@ -300,13 +298,13 @@ getRemoteDeviceClass(deviceId: string): DeviceClass
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ----------------------------------------------- | | -------- | ------ | ---- | --------------------------------- |
| deviceId | string | 是 | 表示远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 | | deviceId | string | 是 | 表示远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------- | ---------------- | | --------------------------- | -------- |
| [DeviceClass](#deviceclass) | 远程设备的类别。 | | [DeviceClass](#deviceclass) | 远程设备的类别。 |
**示例：** **示例：**
...@@ -329,7 +327,7 @@ getPairedDevices(): Array&lt;string&gt; ...@@ -329,7 +327,7 @@ getPairedDevices(): Array&lt;string&gt;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------------- | | ------------------- | ------------- |
| Array&lt;string&gt; | 已配对蓝牙设备的地址列表。 | | Array&lt;string&gt; | 已配对蓝牙设备的地址列表。 |
**示例：** **示例：**
...@@ -352,14 +350,14 @@ setBluetoothScanMode(mode: ScanMode, duration: number): boolean ...@@ -352,14 +350,14 @@ setBluetoothScanMode(mode: ScanMode, duration: number): boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------------------------------------- | | -------- | --------------------- | ---- | ---------------------------- |
| mode | [ScanMode](#scanmode) | 是 | 蓝牙扫描模式。 | | mode | [ScanMode](#scanmode) | 是 | 蓝牙扫描模式。 |
| duration | number | 是 | 设备可被发现的持续时间，单位为秒；设置为0则持续可发现。 | | duration | number | 是 | 设备可被发现的持续时间，单位为秒；设置为0则持续可发现。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ------------------------------------------- | | ------- | -------------------------- |
| boolean | 设置蓝牙扫描，成功返回true，否则返回false。 | | boolean | 设置蓝牙扫描，成功返回true，否则返回false。 |
**示例：** **示例：**
...@@ -383,7 +381,7 @@ getBluetoothScanMode(): ScanMode ...@@ -383,7 +381,7 @@ getBluetoothScanMode(): ScanMode
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | -------------- | | --------------------- | ------- |
| [ScanMode](#scanmode) | 蓝牙扫描模式。 | | [ScanMode](#scanmode) | 蓝牙扫描模式。 |
**示例：** **示例：**
...@@ -406,7 +404,7 @@ startBluetoothDiscovery(): boolean ...@@ -406,7 +404,7 @@ startBluetoothDiscovery(): boolean
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ------------------------------------------- | | ------- | -------------------------- |
| boolean | 开启蓝牙扫描，成功返回true，否则返回false。 | | boolean | 开启蓝牙扫描，成功返回true，否则返回false。 |
**示例：** **示例：**
...@@ -434,7 +432,7 @@ stopBluetoothDiscovery(): boolean ...@@ -434,7 +432,7 @@ stopBluetoothDiscovery(): boolean
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ------------------------------------------- | | ------- | -------------------------- |
| boolean | 关闭蓝牙扫描，成功返回true，否则返回false。 | | boolean | 关闭蓝牙扫描，成功返回true，否则返回false。 |
**示例：** **示例：**
...@@ -457,14 +455,14 @@ setDevicePairingConfirmation(device: string, accept: boolean): boolean ...@@ -457,14 +455,14 @@ setDevicePairingConfirmation(device: string, accept: boolean): boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | --------------------------------------------- | | ------ | ------- | ---- | -------------------------------- |
| device | string | 是 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | device | string | 是 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| accept | boolean | 是 | 接受配对请求设置为true，否则设置为false。 | | accept | boolean | 是 | 接受配对请求设置为true，否则设置为false。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ----------------------------------------------- | | ------- | ---------------------------- |
| boolean | 设置设备配对确认，成功返回true，否则返回false。 | | boolean | 设置设备配对确认，成功返回true，否则返回false。 |
**示例：** **示例：**
...@@ -492,7 +490,7 @@ on(type: "bluetoothDeviceFind", callback: Callback&lt;Array&lt;string&gt;&gt;): ...@@ -492,7 +490,7 @@ on(type: "bluetoothDeviceFind", callback: Callback&lt;Array&lt;string&gt;&gt;):
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------------- | ---- | -------------------------------------- |
| type | string | 是 | 填写"bluetoothDeviceFind"字符串，表示蓝牙设备发现事件。 | | type | string | 是 | 填写"bluetoothDeviceFind"字符串，表示蓝牙设备发现事件。 |
| callback | Callback&lt;Array&lt;string&gt;&gt; | 是 | 表示回调函数的入参，发现的设备集合。回调函数由用户创建通过该接口注册。 | | callback | Callback&lt;Array&lt;string&gt;&gt; | 是 | 表示回调函数的入参，发现的设备集合。回调函数由用户创建通过该接口注册。 |
...@@ -523,7 +521,7 @@ off(type: "bluetoothDeviceFind", callback?: Callback&lt;Array&lt;string&gt;&gt;) ...@@ -523,7 +521,7 @@ off(type: "bluetoothDeviceFind", callback?: Callback&lt;Array&lt;string&gt;&gt;)
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"bluetoothDeviceFind"字符串，表示蓝牙设备发现事件。 | | type | string | 是 | 填写"bluetoothDeviceFind"字符串，表示蓝牙设备发现事件。 |
| callback | Callback&lt;Array&lt;string&gt;&gt; | 否 | 表示取消订阅蓝牙设备发现事件上报。不填该参数则取消订阅该type对应的所有回调。 | | callback | Callback&lt;Array&lt;string&gt;&gt; | 否 | 表示取消订阅蓝牙设备发现事件上报。不填该参数则取消订阅该type对应的所有回调。 |
...@@ -555,7 +553,7 @@ on(type: "pinRequired", callback: Callback&lt;PinRequiredParam&gt;): void ...@@ -555,7 +553,7 @@ on(type: "pinRequired", callback: Callback&lt;PinRequiredParam&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | -------------------------------- |
| type | string | 是 | 填写"pinRequired"字符串，表示配对请求事件。 | | type | string | 是 | 填写"pinRequired"字符串，表示配对请求事件。 |
| callback | Callback&lt;[PinRequiredParam](#pinrequiredparam)&gt; | 是 | 表示回调函数的入参，配对请求。回调函数由用户创建通过该接口注册。 | | callback | Callback&lt;[PinRequiredParam](#pinrequiredparam)&gt; | 是 | 表示回调函数的入参，配对请求。回调函数由用户创建通过该接口注册。 |
...@@ -586,7 +584,7 @@ off(type: "pinRequired", callback?: Callback&lt;PinRequiredParam&gt;): void ...@@ -586,7 +584,7 @@ off(type: "pinRequired", callback?: Callback&lt;PinRequiredParam&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"pinRequired"字符串，表示配对请求事件。 | | type | string | 是 | 填写"pinRequired"字符串，表示配对请求事件。 |
| callback | Callback&lt;[PinRequiredParam](#pinrequiredparam)&gt; | 否 | 表示取消订阅蓝牙配对请求事件上报，入参为配对请求参数。不填该参数则取消订阅该type对应的所有回调。 | | callback | Callback&lt;[PinRequiredParam](#pinrequiredparam)&gt; | 否 | 表示取消订阅蓝牙配对请求事件上报，入参为配对请求参数。不填该参数则取消订阅该type对应的所有回调。 |
...@@ -618,7 +616,7 @@ on(type: "bondStateChange", callback: Callback&lt;BondStateParam&gt;): void ...@@ -618,7 +616,7 @@ on(type: "bondStateChange", callback: Callback&lt;BondStateParam&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ------------------------------------ |
| type | string | 是 | 填写"bondStateChange"字符串，表示蓝牙配对状态改变事件。 | | type | string | 是 | 填写"bondStateChange"字符串，表示蓝牙配对状态改变事件。 |
| callback | Callback&lt;[BondStateParam](#bondstate)&gt; | 是 | 表示回调函数的入参，配对的状态。回调函数由用户创建通过该接口注册。 | | callback | Callback&lt;[BondStateParam](#bondstate)&gt; | 是 | 表示回调函数的入参，配对的状态。回调函数由用户创建通过该接口注册。 |
...@@ -649,7 +647,7 @@ off(type: "bondStateChange", callback?: Callback&lt;BondStateParam&gt;): void ...@@ -649,7 +647,7 @@ off(type: "bondStateChange", callback?: Callback&lt;BondStateParam&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"bondStateChange"字符串，表示蓝牙配对状态改变事件。 | | type | string | 是 | 填写"bondStateChange"字符串，表示蓝牙配对状态改变事件。 |
| callback | Callback&lt;[BondStateParam](#bondstate)&gt; | 否 | 表示取消订阅蓝牙配对状态改变事件上报。不填该参数则取消订阅该type对应的所有回调。 | | callback | Callback&lt;[BondStateParam](#bondstate)&gt; | 否 | 表示取消订阅蓝牙配对状态改变事件上报。不填该参数则取消订阅该type对应的所有回调。 |
...@@ -681,7 +679,7 @@ on(type: "stateChange", callback: Callback&lt;BluetoothState&gt;): void ...@@ -681,7 +679,7 @@ on(type: "stateChange", callback: Callback&lt;BluetoothState&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | -------------------------------- |
| type | string | 是 | 填写"stateChange"字符串，表示蓝牙状态改变事件。 | | type | string | 是 | 填写"stateChange"字符串，表示蓝牙状态改变事件。 |
| callback | Callback&lt;[BluetoothState](#bluetoothstate)&gt; | 是 | 表示回调函数的入参，蓝牙状态。回调函数由用户创建通过该接口注册。 | | callback | Callback&lt;[BluetoothState](#bluetoothstate)&gt; | 是 | 表示回调函数的入参，蓝牙状态。回调函数由用户创建通过该接口注册。 |
...@@ -712,7 +710,7 @@ off(type: "stateChange", callback?: Callback&lt;BluetoothState&gt;): void ...@@ -712,7 +710,7 @@ off(type: "stateChange", callback?: Callback&lt;BluetoothState&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"stateChange"字符串，表示蓝牙状态改变事件。 | | type | string | 是 | 填写"stateChange"字符串，表示蓝牙状态改变事件。 |
| callback | Callback&lt;[BluetoothState](#bluetoothstate)&gt; | 否 | 表示取消订阅蓝牙状态改变事件上报。不填该参数则取消订阅该type对应的所有回调。 | | callback | Callback&lt;[BluetoothState](#bluetoothstate)&gt; | 否 | 表示取消订阅蓝牙状态改变事件上报。不填该参数则取消订阅该type对应的所有回调。 |
...@@ -744,7 +742,7 @@ sppListen(name: string, option: SppOption, callback: AsyncCallback&lt;number&gt; ...@@ -744,7 +742,7 @@ sppListen(name: string, option: SppOption, callback: AsyncCallback&lt;number&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------------------------------- | | -------- | --------------------------- | ---- | ----------------------- |
| name | string | 是 | 服务的名称。 | | name | string | 是 | 服务的名称。 |
| option | [SppOption](#sppoption) | 是 | spp监听配置参数。 | | option | [SppOption](#sppoption) | 是 | spp监听配置参数。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示回调函数的入参，服务端Socket的id。 | | callback | AsyncCallback&lt;number&gt; | 是 | 表示回调函数的入参，服务端Socket的id。 |
...@@ -777,7 +775,7 @@ sppAccept(serverSocket: number, callback: AsyncCallback&lt;number&gt;): void ...@@ -777,7 +775,7 @@ sppAccept(serverSocket: number, callback: AsyncCallback&lt;number&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------- | ---- | -------------------------------------- | | ------------ | --------------------------- | ---- | ----------------------- |
| serverSocket | number | 是 | 服务端socket的id。 | | serverSocket | number | 是 | 服务端socket的id。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示回调函数的入参，客户端socket的id。 | | callback | AsyncCallback&lt;number&gt; | 是 | 表示回调函数的入参，客户端socket的id。 |
...@@ -810,7 +808,7 @@ sppConnect(device: string, option: SppOption, callback: AsyncCallback&lt;number& ...@@ -810,7 +808,7 @@ sppConnect(device: string, option: SppOption, callback: AsyncCallback&lt;number&
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ----------------------------------------- | | -------- | --------------------------- | ---- | ------------------------------ |
| device | string | 是 | 对端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | device | string | 是 | 对端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| option | [SppOption](#sppoption) | 是 | spp客户端连接配置参数。 | | option | [SppOption](#sppoption) | 是 | spp客户端连接配置参数。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示回调函数的入参，客户端socket的id。 | | callback | AsyncCallback&lt;number&gt; | 是 | 表示回调函数的入参，客户端socket的id。 |
...@@ -843,7 +841,7 @@ sppCloseServerSocket(socket: number): void ...@@ -843,7 +841,7 @@ sppCloseServerSocket(socket: number): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- | | ------ | ------ | ---- | --------------- |
| socket | number | 是 | 服务端监听socket的id。 | | socket | number | 是 | 服务端监听socket的id。 |
**示例：** **示例：**
...@@ -864,7 +862,7 @@ sppCloseClientSocket(socket: number): void ...@@ -864,7 +862,7 @@ sppCloseClientSocket(socket: number): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ | | ------ | ------ | ---- | ------------- |
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| socket | number | 是 | 客户端socket的id。 | | socket | number | 是 | 客户端socket的id。 |
...@@ -886,14 +884,14 @@ sppWrite(clientSocket: number, data: ArrayBuffer): boolean ...@@ -886,14 +884,14 @@ sppWrite(clientSocket: number, data: ArrayBuffer): boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------- | ---- | ------------------ | | ------------ | ----------- | ---- | ------------- |
| clientSocket | number | 是 | 客户端socket的id。 | | clientSocket | number | 是 | 客户端socket的id。 |
| data | ArrayBuffer | 是 | 写入的数据。 | | data | ArrayBuffer | 是 | 写入的数据。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ----------------------------------------- | | ------- | ------------------------- |
| boolean | 写数据操作，成功返回true，否则返回false。 | | boolean | 写数据操作，成功返回true，否则返回false。 |
**示例：** **示例：**
...@@ -922,7 +920,7 @@ on(type: "sppRead", clientSocket: number, callback: Callback&lt;ArrayBuffer&gt;) ...@@ -922,7 +920,7 @@ on(type: "sppRead", clientSocket: number, callback: Callback&lt;ArrayBuffer&gt;)
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------- | ---- | ---------------------------------------- | | ------------ | --------------------------- | ---- | -------------------------- |
| type | string | 是 | 填写"sppRead"字符串，表示spp读请求事件。 | | type | string | 是 | 填写"sppRead"字符串，表示spp读请求事件。 |
| clientSocket | number | 是 | 客户端socket的id。 | | clientSocket | number | 是 | 客户端socket的id。 |
| callback | Callback&lt;ArrayBuffer&gt; | 是 | 表示回调函数的入参，读取到的数据。 | | callback | Callback&lt;ArrayBuffer&gt; | 是 | 表示回调函数的入参，读取到的数据。 |
...@@ -953,7 +951,7 @@ off(type: "sppRead", clientSocket: number, callback?: Callback&lt;ArrayBuffer&gt ...@@ -953,7 +951,7 @@ off(type: "sppRead", clientSocket: number, callback?: Callback&lt;ArrayBuffer&gt
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------- | ---- | ------------------------------------------------------------ | | ------------ | --------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"sppRead"字符串，表示spp读请求事件。 | | type | string | 是 | 填写"sppRead"字符串，表示spp读请求事件。 |
| clientSocket | number | 是 | 客户端Socket的id。 | | clientSocket | number | 是 | 客户端Socket的id。 |
| callback | Callback&lt;ArrayBuffer&gt; | 否 | 表示取消订阅spp读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 | | callback | Callback&lt;ArrayBuffer&gt; | 否 | 表示取消订阅spp读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
...@@ -980,19 +978,19 @@ getProfile(profileId: ProfileId): A2dpSourceProfile | HandsFreeAudioGatewayProfi ...@@ -980,19 +978,19 @@ getProfile(profileId: ProfileId): A2dpSourceProfile | HandsFreeAudioGatewayProfi
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | --------- | ---- | ------------------------------------------------ | | --------- | --------- | ---- | ------------------------------------- |
| ProfileId | profileId | 是 | 表示profile的枚举值，例如：PROFILE_A2DP_SOURCE。 | | ProfileId | profileId | 是 | 表示profile的枚举值，例如：PROFILE_A2DP_SOURCE。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------------------- | ------------------------------------------------------------ | | ---------------------------------------- | ---------------------------------------- |
| A2dpSourceProfile 或者 HandsFreeAudioGatewayProfile | 对应的profile的对象实例，当前支持A2dpSourceProfile， HandsFreeAudioGatewayProfile。 | | A2dpSourceProfile 或者 HandsFreeAudioGatewayProfile | 对应的profile的对象实例，当前支持A2dpSourceProfile， HandsFreeAudioGatewayProfile。 |
**示例：** **示例：**
```js ```js
A2dpSourceProfile a2dpSrc = bluetooth.getProfile(PROFILE_A2DP_SOURCE); let a2dpSrc = bluetooth.getProfile(PROFILE_A2DP_SOURCE);
``` ```
...@@ -1009,7 +1007,7 @@ createGattServer(): GattServer ...@@ -1009,7 +1007,7 @@ createGattServer(): GattServer
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | ------------------------------------------------------------ | | ------------------------- | ------------------------------------ |
| [GattServer](#gattserver) | server端类，使用server端方法之前需要创建该类的实例进行操作。 | | [GattServer](#gattserver) | server端类，使用server端方法之前需要创建该类的实例进行操作。 |
**示例：** **示例：**
...@@ -1030,13 +1028,13 @@ createGattClientDevice(deviceId: string): GattClientDevice ...@@ -1030,13 +1028,13 @@ createGattClientDevice(deviceId: string): GattClientDevice
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ----------------------------------------------- | | -------- | ------ | ---- | ------------------------------------ |
| deviceId | string | 是 | 对端设备地址，&nbsp;例如："XX:XX:XX:XX:XX:XX"。 | | deviceId | string | 是 | 对端设备地址，&nbsp;例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------- | ------------------------------------------------------------ | | ------------------------------------- | ------------------------------------ |
| [GattClientDevice](#gattclientdevice) | client端类，使用client端方法之前需要创建该类的实例进行操作。 | | [GattClientDevice](#gattclientdevice) | client端类，使用client端方法之前需要创建该类的实例进行操作。 |
**示例：** **示例：**
...@@ -1059,7 +1057,7 @@ getConnectedBLEDevices(): Array&lt;string&gt; ...@@ -1059,7 +1057,7 @@ getConnectedBLEDevices(): Array&lt;string&gt;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ----------------------------------- | | ------------------- | ------------------- |
| Array&lt;string&gt; | 返回和当前设备连接BLE设备地址集合。 | | Array&lt;string&gt; | 返回和当前设备连接BLE设备地址集合。 |
**示例：** **示例：**
...@@ -1082,7 +1080,7 @@ startBLEScan(filters: Array&lt;ScanFilter&gt;, options?: ScanOptions): void ...@@ -1082,7 +1080,7 @@ startBLEScan(filters: Array&lt;ScanFilter&gt;, options?: ScanOptions): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------------------------------- | ---- | ------------------------------------------------------------ | | ------- | -------------------------------------- | ---- | ----------------------------------- |
| filters | Array&lt;[ScanFilter](#scanfilter)&gt; | 是 | 表示扫描结果过滤策略集合，如果不使用过滤的方式，该参数设置为null。 | | filters | Array&lt;[ScanFilter](#scanfilter)&gt; | 是 | 表示扫描结果过滤策略集合，如果不使用过滤的方式，该参数设置为null。 |
| options | [ScanOptions](#scanoptions) | 否 | 表示扫描的参数配置，可选参数。 | | options | [ScanOptions](#scanoptions) | 否 | 表示扫描的参数配置，可选参数。 |
...@@ -1146,7 +1144,7 @@ on(type: "BLEDeviceFind", callback: Callback&lt;Array&lt;ScanResult&gt;&gt;): vo ...@@ -1146,7 +1144,7 @@ on(type: "BLEDeviceFind", callback: Callback&lt;Array&lt;ScanResult&gt;&gt;): vo
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ----------------------------------- |
| type | string | 是 | 填写"BLEDeviceFind"字符串，表示BLE设备发现事件。 | | type | string | 是 | 填写"BLEDeviceFind"字符串，表示BLE设备发现事件。 |
| callback | Callback&lt;Array&lt;[ScanResult](#scanresult)&gt;&gt; | 是 | 表示回调函数的入参，发现的设备集合。回调函数由用户创建通过该接口注册。 | | callback | Callback&lt;Array&lt;[ScanResult](#scanresult)&gt;&gt; | 是 | 表示回调函数的入参，发现的设备集合。回调函数由用户创建通过该接口注册。 |
...@@ -1177,7 +1175,7 @@ off(type: "BLEDeviceFind", callback?: Callback&lt;Array&lt;ScanResult&gt;&gt;): ...@@ -1177,7 +1175,7 @@ off(type: "BLEDeviceFind", callback?: Callback&lt;Array&lt;ScanResult&gt;&gt;):
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"BLEDeviceFind"字符串，表示BLE设备发现事件。 | | type | string | 是 | 填写"BLEDeviceFind"字符串，表示BLE设备发现事件。 |
| callback | Callback&lt;Array&lt;[ScanResult](#scanresult)&gt;&gt; | 否 | 表示取消订阅BLE设备发现事件上报。不填该参数则取消订阅该type对应的所有回调。 | | callback | Callback&lt;Array&lt;[ScanResult](#scanresult)&gt;&gt; | 否 | 表示取消订阅BLE设备发现事件上报。不填该参数则取消订阅该type对应的所有回调。 |
...@@ -1218,7 +1216,7 @@ getConnectionDevices(): Array&lt;string&gt; ...@@ -1218,7 +1216,7 @@ getConnectionDevices(): Array&lt;string&gt;
**返回值：** **返回值：**
| | | | | |
| ------------------- | -------------------------- | | ------------------- | ------------- |
| 类型 | 说明 | | 类型 | 说明 |
| Array&lt;string&gt; | 返回已连接设备的地址列表。 | | Array&lt;string&gt; | 返回已连接设备的地址列表。 |
...@@ -1236,14 +1234,14 @@ getDeviceState(device: string): ProfileConnectionState ...@@ -1236,14 +1234,14 @@ getDeviceState(device: string): ProfileConnectionState
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- | | ------ | ------ | ---- | ------- |
| device | string | 是 | 远端设备地址。 | | device | string | 是 | 远端设备地址。 |
| |
**返回值：** **返回值：**
| | | | | |
| ------------------------------------------------- | ----------------------- | | ---------------------------------------- | --------------- |
| 类型 | 说明 | | 类型 | 说明 |
| [ProfileConnectionState](#profileconnectionState) | 返回profile的连接状态。 | | [ProfileConnectionState](#profileconnectionState) | 返回profile的连接状态。 |
...@@ -1266,22 +1264,22 @@ connect(device: string): boolean ...@@ -1266,22 +1264,22 @@ connect(device: string): boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- | | ------ | ------ | ---- | ------- |
| device | string | 是 | 远端设备地址。 | | device | string | 是 | 远端设备地址。 |
| |
**返回值：** **返回值：**
| | | | | |
| ------- | ----------------------------- | | ------- | ------------------- |
| 类型 | 说明 | | 类型 | 说明 |
| boolean | 成功返回true，失败返回false。 | | boolean | 成功返回true，失败返回false。 |
**示例：** **示例：**
```js ```js
A2dpSourceProfile a2dpSrc = bluetooth.getProfile(PROFILE_A2DP_SOURCE); let a2dpSrc = bluetooth.getProfile(PROFILE_A2DP_SOURCE)
boolean ret = a2dpSrc.connect('XX:XX:XX:XX:XX:XX'); let ret = a2dpSrc.connect('XX:XX:XX:XX:XX:XX');
``` ```
...@@ -1298,22 +1296,22 @@ disconnect(device: string): boolean ...@@ -1298,22 +1296,22 @@ disconnect(device: string): boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- | | ------ | ------ | ---- | ------- |
| device | string | 是 | 远端设备地址。 | | device | string | 是 | 远端设备地址。 |
| |
**返回值：** **返回值：**
| | | | | |
| ------- | ----------------------------- | | ------- | ------------------- |
| 类型 | 说明 | | 类型 | 说明 |
| boolean | 成功返回true，失败返回false。 | | boolean | 成功返回true，失败返回false。 |
**示例：** **示例：**
```js ```js
A2dpSourceProfile a2dpSrc = bluetooth.getProfile(PROFILE_A2DP_SOURCE); let a2dpSrc = bluetooth.getProfile(PROFILE_A2DP_SOURCE);
boolean ret = a2dpSrc.disconnect('XX:XX:XX:XX:XX:XX'); let boolean ret = a2dpSrc.disconnect('XX:XX:XX:XX:XX:XX');
``` ```
...@@ -1328,7 +1326,7 @@ on(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Stat ...@@ -1328,7 +1326,7 @@ on(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Stat
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | --------------------------------------------------------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 | | type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | 是 | 表示回调函数的入参。 | | callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | 是 | 表示回调函数的入参。 |
...@@ -1357,7 +1355,7 @@ off(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Sta ...@@ -1357,7 +1355,7 @@ off(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Sta
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | --------------------------------------------------------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 | | type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | 是 | 表示回调函数的入参。 | | callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | 是 | 表示回调函数的入参。 |
...@@ -1386,21 +1384,21 @@ getPlayingState(device: string): PlayingState ...@@ -1386,21 +1384,21 @@ getPlayingState(device: string): PlayingState
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- | | ------ | ------ | ---- | ------- |
| device | string | 是 | 远端设备地址。 | | device | string | 是 | 远端设备地址。 |
**返回值：** **返回值：**
| | | | | |
| ----------------------------- | -------------------- | | ----------------------------- | ---------- |
| 类型 | 说明 | | 类型 | 说明 |
| [PlayingState](#PlayingState) | 远端设备的播放状态。 | | [PlayingState](#PlayingState) | 远端设备的播放状态。 |
**示例：** **示例：**
```js ```js
A2dpSourceProfile a2dpSrc = bluetooth.getProfile(PROFILE_A2DP_SOURCE); let a2dpSrc = bluetooth.getProfile(PROFILE_A2DP_SOURCE);
PlayingState state = a2dpSrc.getPlayingState('XX:XX:XX:XX:XX:XX'); let state = a2dpSrc.getPlayingState('XX:XX:XX:XX:XX:XX');
``` ```
...@@ -1422,22 +1420,22 @@ connect(device: string): boolean ...@@ -1422,22 +1420,22 @@ connect(device: string): boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- | | ------ | ------ | ---- | ------- |
| device | string | 是 | 远端设备地址。 | | device | string | 是 | 远端设备地址。 |
| |
**返回值：** **返回值：**
| | | | | |
| ------- | ----------------------------- | | ------- | ------------------- |
| 类型 | 说明 | | 类型 | 说明 |
| boolean | 成功返回true，失败返回false。 | | boolean | 成功返回true，失败返回false。 |
**示例：** **示例：**
```js ```js
HandsFreeAudioGatewayProfile hfpAg = bluetooth.getProfile(PROFILE_HANDS_FREE_AUDIO_GATEWAY); let hfpAg = bluetooth.getProfile(PROFILE_HANDS_FREE_AUDIO_GATEWAY);
boolean ret = hfpAg.connect('XX:XX:XX:XX:XX:XX'); let ret = hfpAg.connect('XX:XX:XX:XX:XX:XX');
``` ```
...@@ -1454,21 +1452,21 @@ disconnect(device: string): boolean ...@@ -1454,21 +1452,21 @@ disconnect(device: string): boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- | | ------ | ------ | ---- | ------- |
| device | string | 是 | 远端设备地址。 | | device | string | 是 | 远端设备地址。 |
| |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ----------------------------- | | ------- | ------------------- |
| boolean | 成功返回true，失败返回false。 | | boolean | 成功返回true，失败返回false。 |
**示例：** **示例：**
```js ```js
HandsFreeAudioGatewayProfile hfpAg = bluetooth.getProfile(PROFILE_HANDS_FREE_AUDIO_GATEWAY); let hfpAg = bluetooth.getProfile(PROFILE_HANDS_FREE_AUDIO_GATEWAY);
boolean ret = hfpAg.disconnect('XX:XX:XX:XX:XX:XX'); let ret = hfpAg.disconnect('XX:XX:XX:XX:XX:XX');
``` ```
...@@ -1483,7 +1481,7 @@ on(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Stat ...@@ -1483,7 +1481,7 @@ on(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Stat
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | --------------------------------------------------------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 | | type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | 是 | 表示回调函数的入参。 | | callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | 是 | 表示回调函数的入参。 |
...@@ -1512,7 +1510,7 @@ off(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Sta ...@@ -1512,7 +1510,7 @@ off(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#Sta
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | --------------------------------------------------------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 | | type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | 是 | 表示回调函数的入参。 | | callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | 是 | 表示回调函数的入参。 |
...@@ -1548,7 +1546,7 @@ startAdvertising(setting: AdvertiseSetting, advData: AdvertiseData, advResponse? ...@@ -1548,7 +1546,7 @@ startAdvertising(setting: AdvertiseSetting, advData: AdvertiseData, advResponse?
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------------------------------------- | ---- | ------------------------- | | ----------- | ------------------------------------- | ---- | -------------- |
| setting | [AdvertiseSetting](#advertisesetting) | 是 | BLE广播的相关参数。 | | setting | [AdvertiseSetting](#advertisesetting) | 是 | BLE广播的相关参数。 |
| advData | [AdvertiseData](#advertisedata) | 是 | BLE广播包内容。 | | advData | [AdvertiseData](#advertisedata) | 是 | BLE广播包内容。 |
| advResponse | [AdvertiseData](#advertisedata) | 否 | BLE回复扫描请求回复响应。 | | advResponse | [AdvertiseData](#advertisedata) | 否 | BLE回复扫描请求回复响应。 |
...@@ -1637,13 +1635,13 @@ server端添加服务。 ...@@ -1637,13 +1635,13 @@ server端添加服务。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------- | ---- | -------------------------------------- | | ------- | --------------------------- | ---- | ------------------------ |
| service | [GattService](#gattservice) | 是 | 服务端的service数据。BLE广播的相关参数 | | service | [GattService](#gattservice) | 是 | 服务端的service数据。BLE广播的相关参数 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ------------------------------------------- | | ------- | -------------------------- |
| boolean | 添加服务操作，成功返回true，否则返回false。 | | boolean | 添加服务操作，成功返回true，否则返回false。 |
**示例：** **示例：**
...@@ -1696,13 +1694,13 @@ removeService(serviceUuid: string): boolean ...@@ -1696,13 +1694,13 @@ removeService(serviceUuid: string): boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ----------------------------------------------------------- | | ----------- | ------ | ---- | ---------------------------------------- |
| serviceUuid | string | 是 | service的UUID，例如“00001810-0000-1000-8000-00805F9B34FB”。 | | serviceUuid | string | 是 | service的UUID，例如“00001810-0000-1000-8000-00805F9B34FB”。 |
**返回值：** **返回值：**
| | | | | |
| ------- | ------------------------------------------- | | ------- | -------------------------- |
| 类型 | 说明 | | 类型 | 说明 |
| boolean | 删除服务操作，成功返回true，否则返回false。 | | boolean | 删除服务操作，成功返回true，否则返回false。 |
...@@ -1745,14 +1743,14 @@ server端特征值发生变化时，主动通知已连接的client设备。 ...@@ -1745,14 +1743,14 @@ server端特征值发生变化时，主动通知已连接的client设备。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------------- | --------------------------------------------- | ---- | ----------------------------------------------------- | | -------------------- | ---------------------------------------- | ---- | --------------------------------------- |
| deviceId | string | 是 | 接收通知的client端设备地址，例如“XX:XX:XX:XX:XX:XX”。 | | deviceId | string | 是 | 接收通知的client端设备地址，例如“XX:XX:XX:XX:XX:XX”。 |
| notifyCharacteristic | [NotifyCharacteristic](#notifycharacteristic) | 是 | 通知的特征值数据。 | | notifyCharacteristic | [NotifyCharacteristic](#notifycharacteristic) | 是 | 通知的特征值数据。 |
**返回值：** **返回值：**
| | | | | |
| ------- | --------------------------------------- | | ------- | ------------------------ |
| 类型 | 说明 | | 类型 | 说明 |
| boolean | 通知操作，成功返回true，否则返回false。 | | boolean | 通知操作，成功返回true，否则返回false。 |
...@@ -1779,13 +1777,13 @@ server端回复client端的读写请求。 ...@@ -1779,13 +1777,13 @@ server端回复client端的读写请求。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | --------------------------------- | ---- | ------------------------ | | -------------- | --------------------------------- | ---- | --------------- |
| serverResponse | [ServerResponse](#serverresponse) | 是 | server端回复的响应数据。 | | serverResponse | [ServerResponse](#serverresponse) | 是 | server端回复的响应数据。 |
**返回值：** **返回值：**
| | | | | |
| ------- | ------------------------------------------- | | ------- | -------------------------- |
| 类型 | 说明 | | 类型 | 说明 |
| boolean | 回复响应操作，成功返回true，否则返回false。 | | boolean | 回复响应操作，成功返回true，否则返回false。 |
...@@ -1827,7 +1825,7 @@ server端订阅特征值读请求事件。 ...@@ -1827,7 +1825,7 @@ server端订阅特征值读请求事件。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ------------------------------------- |
| type | string | 是 | 填写"characteristicRead"字符串，表示特征值读请求事件。 | | type | string | 是 | 填写"characteristicRead"字符串，表示特征值读请求事件。 |
| callback | Callback&lt;[CharacteristicReadReq](#characteristicreadreq)&gt; | 是 | 表示回调函数的入参，client端发送的读请求数据。 | | callback | Callback&lt;[CharacteristicReadReq](#characteristicreadreq)&gt; | 是 | 表示回调函数的入参，client端发送的读请求数据。 |
...@@ -1875,7 +1873,7 @@ server端取消订阅特征值读请求事件。 ...@@ -1875,7 +1873,7 @@ server端取消订阅特征值读请求事件。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"characteristicRead"字符串，表示特征值读请求事件。 | | type | string | 是 | 填写"characteristicRead"字符串，表示特征值读请求事件。 |
| callback | Callback&lt;[CharacteristicReadReq](#characteristicreadreq)&gt; | 否 | 表示取消订阅特征值读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 | | callback | Callback&lt;[CharacteristicReadReq](#characteristicreadreq)&gt; | 否 | 表示取消订阅特征值读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
...@@ -1904,7 +1902,7 @@ server端订阅特征值写请求事件。 ...@@ -1904,7 +1902,7 @@ server端订阅特征值写请求事件。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------- | | -------- | ---------------------------------------- | ---- | -------------------------------------- |
| type | string | 是 | 填写"characteristicWrite"字符串，表示特征值写请求事件。 | | type | string | 是 | 填写"characteristicWrite"字符串，表示特征值写请求事件。 |
| callback | Callback&lt;[DescriptorWriteReq](#descriptorwritereq)&gt; | 是 | 表示回调函数的入参，client端发送的写请求数据。 | | callback | Callback&lt;[DescriptorWriteReq](#descriptorwritereq)&gt; | 是 | 表示回调函数的入参，client端发送的写请求数据。 |
...@@ -1955,7 +1953,7 @@ server端取消订阅特征值写请求事件。 ...@@ -1955,7 +1953,7 @@ server端取消订阅特征值写请求事件。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"characteristicWrite"字符串，表示特征值写请求事件。 | | type | string | 是 | 填写"characteristicWrite"字符串，表示特征值写请求事件。 |
| callback | Callback&lt;[CharacteristicWriteReq](#characteristicwritereq)&gt; | 否 | 表示取消订阅特征值写请求事件上报。不填该参数则取消订阅该type对应的所有回调。 | | callback | Callback&lt;[CharacteristicWriteReq](#characteristicwritereq)&gt; | 否 | 表示取消订阅特征值写请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
...@@ -1984,7 +1982,7 @@ server端订阅描述符读请求事件。 ...@@ -1984,7 +1982,7 @@ server端订阅描述符读请求事件。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | -------------------------------------------------- | | -------- | ---------------------------------------- | ---- | --------------------------------- |
| type | string | 是 | 填写"descriptorRead"字符串，表示描述符读请求事件。 | | type | string | 是 | 填写"descriptorRead"字符串，表示描述符读请求事件。 |
| callback | Callback&lt;[DescriptorReadReq](#descriptorreadreq)&gt; | 是 | 表示回调函数的入参，client端发送的读请求数据。 | | callback | Callback&lt;[DescriptorReadReq](#descriptorreadreq)&gt; | 是 | 表示回调函数的入参，client端发送的读请求数据。 |
...@@ -2032,7 +2030,7 @@ server端取消订阅描述符读请求事件。 ...@@ -2032,7 +2030,7 @@ server端取消订阅描述符读请求事件。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"descriptorRead"字符串，表示描述符读请求事件。 | | type | string | 是 | 填写"descriptorRead"字符串，表示描述符读请求事件。 |
| callback | Callback&lt;[DescriptorReadReq](#descriptorreadreq)&gt; | 否 | 表示取消订阅描述符读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 | | callback | Callback&lt;[DescriptorReadReq](#descriptorreadreq)&gt; | 否 | 表示取消订阅描述符读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
...@@ -2061,7 +2059,7 @@ server端订阅描述符写请求事件。 ...@@ -2061,7 +2059,7 @@ server端订阅描述符写请求事件。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | --------------------------------------------------- | | -------- | ---------------------------------------- | ---- | ---------------------------------- |
| type | string | 是 | 填写"descriptorWrite"字符串，表示描述符写请求事件。 | | type | string | 是 | 填写"descriptorWrite"字符串，表示描述符写请求事件。 |
| callback | Callback&lt;[DescriptorWriteReq](#descriptorwritereq)&gt; | 是 | 表示回调函数的入参，client端发送的写请求数据。 | | callback | Callback&lt;[DescriptorWriteReq](#descriptorwritereq)&gt; | 是 | 表示回调函数的入参，client端发送的写请求数据。 |
...@@ -2112,7 +2110,7 @@ server端取消订阅描述符写请求事件。 ...@@ -2112,7 +2110,7 @@ server端取消订阅描述符写请求事件。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"descriptorWrite"字符串，表示描述符写请求事件。 | | type | string | 是 | 填写"descriptorWrite"字符串，表示描述符写请求事件。 |
| callback | Callback&lt;[DescriptorWriteReq](#descriptorwritereq)&gt; | 否 | 表示取消订阅描述符写请求事件上报。不填该参数则取消订阅该type对应的所有回调。 | | callback | Callback&lt;[DescriptorWriteReq](#descriptorwritereq)&gt; | 否 | 表示取消订阅描述符写请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
...@@ -2141,7 +2139,7 @@ server端订阅BLE连接状态变化事件。 ...@@ -2141,7 +2139,7 @@ server端订阅BLE连接状态变化事件。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | --------------------------------------------------------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"connectStateChange"字符串，表示BLE连接状态变化事件。 | | type | string | 是 | 填写"connectStateChange"字符串，表示BLE连接状态变化事件。 |
| callback | Callback&lt;[BLEConnectChangedState](#bleconnectchangedstate)&gt; | 是 | 表示回调函数的入参，连接状态。 | | callback | Callback&lt;[BLEConnectChangedState](#bleconnectchangedstate)&gt; | 是 | 表示回调函数的入参，连接状态。 |
...@@ -2175,7 +2173,7 @@ server端取消订阅BLE连接状态变化事件。 ...@@ -2175,7 +2173,7 @@ server端取消订阅BLE连接状态变化事件。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"connectStateChange"字符串，表示BLE连接状态变化事件。 | | type | string | 是 | 填写"connectStateChange"字符串，表示BLE连接状态变化事件。 |
| callback | Callback&lt;[BLEConnectChangedState](#bleconnectchangedstate)&gt; | 否 | 表示取消订阅BLE连接状态变化事件。不填该参数则取消订阅该type对应的所有回调。 | | callback | Callback&lt;[BLEConnectChangedState](#bleconnectchangedstate)&gt; | 否 | 表示取消订阅BLE连接状态变化事件。不填该参数则取消订阅该type对应的所有回调。 |
...@@ -2209,7 +2207,7 @@ client端发起连接远端蓝牙低功耗设备。 ...@@ -2209,7 +2207,7 @@ client端发起连接远端蓝牙低功耗设备。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ----------------------------------------- | | ------- | ------------------------- |
| boolean | 连接操作成功返回true，操作失败返回false。 | | boolean | 连接操作成功返回true，操作失败返回false。 |
**示例：** **示例：**
...@@ -2233,7 +2231,7 @@ client端断开与远端蓝牙低功耗设备的连接。 ...@@ -2233,7 +2231,7 @@ client端断开与远端蓝牙低功耗设备的连接。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ----------------------------------------------- | | ------- | ---------------------------- |
| boolean | 断开连接操作，成功返回true，操作失败返回false。 | | boolean | 断开连接操作，成功返回true，操作失败返回false。 |
**示例：** **示例：**
...@@ -2257,7 +2255,7 @@ close(): boolean ...@@ -2257,7 +2255,7 @@ close(): boolean
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ------------------------------------------- | | ------- | -------------------------- |
| boolean | 关闭操作，成功返回true，操作失败返回false。 | | boolean | 关闭操作，成功返回true，操作失败返回false。 |
**示例：** **示例：**
...@@ -2283,7 +2281,7 @@ client端获取蓝牙低功耗设备的所有服务，即服务发现 。 ...@@ -2283,7 +2281,7 @@ client端获取蓝牙低功耗设备的所有服务，即服务发现 。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------ | | -------- | ---------------------------------------- | ---- | ------------------------ |
| callback | AsyncCallback&lt;Array&lt;[GattService](#gattservice)&gt;&gt; | 是 | client进行服务发现，通过注册回调函数获取。 | | callback | AsyncCallback&lt;Array&lt;[GattService](#gattservice)&gt;&gt; | 是 | client进行服务发现，通过注册回调函数获取。 |
**返回值：** **返回值：**
...@@ -2327,7 +2325,7 @@ client端获取蓝牙低功耗设备的所有服务，即服务发现。 ...@@ -2327,7 +2325,7 @@ client端获取蓝牙低功耗设备的所有服务，即服务发现。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------------- | ----------------------------------------- | | ---------------------------------------- | --------------------------- |
| Promise&lt;Array&lt;[GattService](#gattservice)&gt;&gt; | client进行服务发现，通过promise形式获取。 | | Promise&lt;Array&lt;[GattService](#gattservice)&gt;&gt; | client进行服务发现，通过promise形式获取。 |
**示例：** **示例：**
...@@ -2358,7 +2356,7 @@ client端读取蓝牙低功耗设备特定服务的特征值。 ...@@ -2358,7 +2356,7 @@ client端读取蓝牙低功耗设备特定服务的特征值。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------------------------------------------ | ---- | ---------------------------------------- | | -------------- | ---------------------------------------- | ---- | ----------------------- |
| characteristic | [BLECharacteristic](#blecharacteristic) | 是 | 待读取的特征值。 | | characteristic | [BLECharacteristic](#blecharacteristic) | 是 | 待读取的特征值。 |
| callback | AsyncCallback&lt;[BLECharacteristic](#blecharacteristic)&gt; | 是 | client读取特征值，通过注册回调函数获取。 | | callback | AsyncCallback&lt;[BLECharacteristic](#blecharacteristic)&gt; | 是 | client读取特征值，通过注册回调函数获取。 |
...@@ -2412,13 +2410,13 @@ client端读取蓝牙低功耗设备特定服务的特征值。 ...@@ -2412,13 +2410,13 @@ client端读取蓝牙低功耗设备特定服务的特征值。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | --------------------------------------- | ---- | ---------------- | | -------------- | --------------------------------------- | ---- | -------- |
| characteristic | [BLECharacteristic](#blecharacteristic) | 是 | 待读取的特征值。 | | characteristic | [BLECharacteristic](#blecharacteristic) | 是 | 待读取的特征值。 |
**返回值：** **返回值：**
| | | | | |
| ------------------------------------------------------ | --------------------------------------- | | ---------------------------------------- | -------------------------- |
| 类型 | 说明 | | 类型 | 说明 |
| Promise&lt;[BLECharacteristic](#blecharacteristic)&gt; | client读取特征值，通过promise形式获取。 | | Promise&lt;[BLECharacteristic](#blecharacteristic)&gt; | client读取特征值，通过promise形式获取。 |
...@@ -2459,7 +2457,7 @@ client端读取蓝牙低功耗设备特定的特征包含的描述符。 ...@@ -2459,7 +2457,7 @@ client端读取蓝牙低功耗设备特定的特征包含的描述符。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ---------------------------------------- | | ---------- | ---------------------------------------- | ---- | ----------------------- |
| descriptor | [BLEDescriptor](#bledescriptor) | 是 | 待读取的描述符。 | | descriptor | [BLEDescriptor](#bledescriptor) | 是 | 待读取的描述符。 |
| callback | AsyncCallback&lt;[BLECharacteristic](#blecharacteristic)&gt; | 是 | client读取描述符，通过注册回调函数获取。 | | callback | AsyncCallback&lt;[BLECharacteristic](#blecharacteristic)&gt; | 是 | client读取描述符，通过注册回调函数获取。 |
...@@ -2503,13 +2501,13 @@ client端读取蓝牙低功耗设备特定的特征包含的描述符。 ...@@ -2503,13 +2501,13 @@ client端读取蓝牙低功耗设备特定的特征包含的描述符。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------- | ---- | ---------------- | | ---------- | ------------------------------- | ---- | -------- |
| descriptor | [BLEDescriptor](#bledescriptor) | 是 | 待读取的描述符。 | | descriptor | [BLEDescriptor](#bledescriptor) | 是 | 待读取的描述符。 |
**返回值：** **返回值：**
| | | | | |
| ---------------------------------------------- | --------------------------------------- | | ---------------------------------------- | -------------------------- |
| 类型 | 说明 | | 类型 | 说明 |
| Promise&lt;[BLEDescriptor](#bledescriptor)&gt; | client读取描述符，通过promise形式获取。 | | Promise&lt;[BLEDescriptor](#bledescriptor)&gt; | client读取描述符，通过promise形式获取。 |
...@@ -2540,13 +2538,13 @@ client端向低功耗蓝牙设备写入特定的特征值。 ...@@ -2540,13 +2538,13 @@ client端向低功耗蓝牙设备写入特定的特征值。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | --------------------------------------- | ---- | -------------------------------------- | | -------------- | --------------------------------------- | ---- | ------------------- |
| characteristic | [BLECharacteristic](#blecharacteristic) | 是 | 蓝牙设备特征对应的二进制值及其它参数。 | | characteristic | [BLECharacteristic](#blecharacteristic) | 是 | 蓝牙设备特征对应的二进制值及其它参数。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | --------------------------------------------- | | ------- | --------------------------- |
| boolean | 写特征值操作成功返回true，操作失败返回false。 | | boolean | 写特征值操作成功返回true，操作失败返回false。 |
**示例：** **示例：**
...@@ -2590,13 +2588,13 @@ client端向低功耗蓝牙设备特定的描述符写入二进制数据。 ...@@ -2590,13 +2588,13 @@ client端向低功耗蓝牙设备特定的描述符写入二进制数据。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------- | ---- | ------------------------------------ | | ---------- | ------------------------------- | ---- | ------------------ |
| descriptor | [BLEDescriptor](#bledescriptor) | 是 | 蓝牙设备描述符的二进制值及其它参数。 | | descriptor | [BLEDescriptor](#bledescriptor) | 是 | 蓝牙设备描述符的二进制值及其它参数。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | --------------------------------------------- | | ------- | --------------------------- |
| boolean | 写描述符操作成功返回true，操作失败返回false。 | | boolean | 写描述符操作成功返回true，操作失败返回false。 |
**示例：** **示例：**
...@@ -2631,13 +2629,13 @@ client协商远端蓝牙低功耗设备的最大传输单元（Maximum Transmiss ...@@ -2631,13 +2629,13 @@ client协商远端蓝牙低功耗设备的最大传输单元（Maximum Transmiss
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------- | | ---- | ------ | ---- | -------------- |
| mtu | number | 是 | 设置范围为22~512字节。 | | mtu | number | 是 | 设置范围为22~512字节。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | -------------------------------------------- | | ------- | ---------------------------- |
| boolean | MTU协商操作成功返回true，操作失败返回false。 | | boolean | MTU协商操作成功返回true，操作失败返回false。 |
**示例：** **示例：**
...@@ -2661,14 +2659,14 @@ setNotifyCharacteristicChanged(characteristic: BLECharacteristic, enable: boolea ...@@ -2661,14 +2659,14 @@ setNotifyCharacteristicChanged(characteristic: BLECharacteristic, enable: boolea
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | --------------------------------------- | ---- | ------------------------------------------- | | -------------- | --------------------------------------- | ---- | ----------------------------- |
| characteristic | [BLECharacteristic](#blecharacteristic) | 是 | 蓝牙低功耗特征。 | | characteristic | [BLECharacteristic](#blecharacteristic) | 是 | 蓝牙低功耗特征。 |
| enable | boolean | 是 | 启用接收notify设置为true，否则设置为false。 | | enable | boolean | 是 | 启用接收notify设置为true，否则设置为false。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ----------------------------------------- | | ------- | ------------------------- |
| boolean | 设置操作成功返回true，操作失败返回false。 | | boolean | 设置操作成功返回true，操作失败返回false。 |
**示例：** **示例：**
...@@ -2692,7 +2690,7 @@ on(type: "BLECharacteristicChange", callback: Callback&lt;BLECharacteristic&gt;) ...@@ -2692,7 +2690,7 @@ on(type: "BLECharacteristicChange", callback: Callback&lt;BLECharacteristic&gt;)
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | --------------------------------------------------------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"BLECharacteristicChange"字符串，表示特征值变化事件。 | | type | string | 是 | 填写"BLECharacteristicChange"字符串，表示特征值变化事件。 |
| callback | Callback&lt;[BLECharacteristic](#blecharacteristic)&gt; | 是 | 表示蓝牙低功耗设备的特征值变化事件的回调函数。 | | callback | Callback&lt;[BLECharacteristic](#blecharacteristic)&gt; | 是 | 表示蓝牙低功耗设备的特征值变化事件的回调函数。 |
...@@ -2726,7 +2724,7 @@ off(type: "BLECharacteristicChange", callback?: Callback&lt;BLECharacteristic&gt ...@@ -2726,7 +2724,7 @@ off(type: "BLECharacteristicChange", callback?: Callback&lt;BLECharacteristic&gt
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"BLECharacteristicChange"字符串，表示特征值变化事件。 | | type | string | 是 | 填写"BLECharacteristicChange"字符串，表示特征值变化事件。 |
| callback | Callback&lt;[BLECharacteristic](#blecharacteristic)&gt; | 否 | 表示取消订阅蓝牙低功耗设备的特征值变化事件。不填该参数则取消订阅该type对应的所有回调。 | | callback | Callback&lt;[BLECharacteristic](#blecharacteristic)&gt; | 否 | 表示取消订阅蓝牙低功耗设备的特征值变化事件。不填该参数则取消订阅该type对应的所有回调。 |
...@@ -2755,7 +2753,7 @@ client端订阅蓝牙低功耗设备的连接状态变化事件。 ...@@ -2755,7 +2753,7 @@ client端订阅蓝牙低功耗设备的连接状态变化事件。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"BLEConnectionStateChange"字符串，表示连接状态变化事件。 | | type | string | 是 | 填写"BLEConnectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback&lt;[BLEConnectChangedState](#bleconnectchangedstate)&gt; | 是 | 表示连接状态，已连接或断开。 | | callback | Callback&lt;[BLEConnectChangedState](#bleconnectchangedstate)&gt; | 是 | 表示连接状态，已连接或断开。 |
...@@ -2788,7 +2786,7 @@ off(type: "BLEConnectionStateChange", callback?: Callback&lt;BLEConnectChangedSt ...@@ -2788,7 +2786,7 @@ off(type: "BLEConnectionStateChange", callback?: Callback&lt;BLEConnectChangedSt
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 填写"BLEConnectionStateChange"字符串，表示连接状态变化事件。 | | type | string | 是 | 填写"BLEConnectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback&lt;[BLEConnectChangedState](#bleconnectchangedstate)&gt; | 否 | 表示取消订阅蓝牙低功耗设备的连接状态变化事件。不填该参数则取消订阅该type对应的所有回调。 | | callback | Callback&lt;[BLEConnectChangedState](#bleconnectchangedstate)&gt; | 否 | 表示取消订阅蓝牙低功耗设备的连接状态变化事件。不填该参数则取消订阅该type对应的所有回调。 |
...@@ -2817,7 +2815,7 @@ client获取远端蓝牙低功耗设备名。 ...@@ -2817,7 +2815,7 @@ client获取远端蓝牙低功耗设备名。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------------------------------------------- | | -------- | --------------------------- | ---- | ------------------------------- |
| callback | AsyncCallback&lt;string&gt; | 是 | client获取对端server设备名，通过注册回调函数获取。 | | callback | AsyncCallback&lt;string&gt; | 是 | client获取对端server设备名，通过注册回调函数获取。 |
**返回值：** **返回值：**
...@@ -2849,7 +2847,7 @@ client获取远端蓝牙低功耗设备名。 ...@@ -2849,7 +2847,7 @@ client获取远端蓝牙低功耗设备名。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------------------------------- | | --------------------- | ---------------------------------- |
| Promise&lt;string&gt; | client获取对端server设备名，通过promise形式获取。 | | Promise&lt;string&gt; | client获取对端server设备名，通过promise形式获取。 |
**示例：** **示例：**
...@@ -2877,7 +2875,7 @@ client获取远端蓝牙低功耗设备的信号强度 (Received Signal Strength ...@@ -2877,7 +2875,7 @@ client获取远端蓝牙低功耗设备的信号强度 (Received Signal Strength
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------------------------------------------- | | -------- | --------------------------- | ---- | ------------------------------ |
| callback | AsyncCallback&lt;number&gt; | 是 | 返回信号强度，单位&nbsp;dBm，通过注册回调函数获取。 | | callback | AsyncCallback&lt;number&gt; | 是 | 返回信号强度，单位&nbsp;dBm，通过注册回调函数获取。 |
**返回值：** **返回值：**
...@@ -2910,7 +2908,7 @@ client获取远端蓝牙低功耗设备的信号强度 (Received Signal Strength ...@@ -2910,7 +2908,7 @@ client获取远端蓝牙低功耗设备的信号强度 (Received Signal Strength
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | -------------------------------------------------- | | --------------------- | --------------------------------- |
| Promise&lt;number&gt; | 返回信号强度，单位&nbsp;dBm，通过promise形式获取。 | | Promise&lt;number&gt; | 返回信号强度，单位&nbsp;dBm，通过promise形式获取。 |
**示例：** **示例：**
...@@ -2930,7 +2928,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -2930,7 +2928,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ------------------------------------------ | ------ | ----------------------- | | ---------------------------------------- | ---- | --------------- |
| SCAN_MODE_NONE | 0 | 没有扫描模式。 | | SCAN_MODE_NONE | 0 | 没有扫描模式。 |
| SCAN_MODE_CONNECTABLE | 1 | 可连接扫描模式。 | | SCAN_MODE_CONNECTABLE | 1 | 可连接扫描模式。 |
| SCAN_MODE_GENERAL_DISCOVERABLE | 2 | general发现模式。 | | SCAN_MODE_GENERAL_DISCOVERABLE | 2 | general发现模式。 |
...@@ -2945,7 +2943,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -2945,7 +2943,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ------------------ | ------ | ------------ | | ------------------ | ---- | ------ |
| BOND_STATE_INVALID | 0 | 无效的配对。 | | BOND_STATE_INVALID | 0 | 无效的配对。 |
| BOND_STATE_BONDING | 1 | 正在配对。 | | BOND_STATE_BONDING | 1 | 正在配对。 |
| BOND_STATE_BONDED | 2 | 已配对。 | | BOND_STATE_BONDED | 2 | 已配对。 |
...@@ -2958,7 +2956,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -2958,7 +2956,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------ | ------------------- | ---- | ---- | ---------------- | | ------ | ------------------- | ---- | ---- | ----------- |
| uuid | string | 是 | 是 | spp单据的uuid。 | | uuid | string | 是 | 是 | spp单据的uuid。 |
| secure | boolean | 是 | 是 | 是否是安全通道。 | | secure | boolean | 是 | 是 | 是否是安全通道。 |
| type | [SppType](#spptype) | 是 | 是 | Spp链路类型。 | | type | [SppType](#spptype) | 是 | 是 | Spp链路类型。 |
...@@ -2971,7 +2969,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -2971,7 +2969,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ---------- | ------ | -------------------- | | ---------- | ---- | ------------- |
| SPP_RFCOMM | 0 | 表示rfcomm链路类型。 | | SPP_RFCOMM | 0 | 表示rfcomm链路类型。 |
...@@ -2982,7 +2980,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -2982,7 +2980,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------------- | ---------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | | --------------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- |
| serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 | | serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| isPrimary | boolean | 是 | 是 | 如果是主服务设置为true，否则设置为false。 | | isPrimary | boolean | 是 | 是 | 如果是主服务设置为true，否则设置为false。 |
| characteristics | Array&lt;[BLECharacteristic](#blecharacteristic)&gt; | 是 | 是 | 当前服务包含的特征列表。 | | characteristics | Array&lt;[BLECharacteristic](#blecharacteristic)&gt; | 是 | 是 | 当前服务包含的特征列表。 |
...@@ -2996,7 +2994,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -2996,7 +2994,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------------- | -------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | | ------------------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- |
| serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 | | serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string | 是 | 是 | 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 | | characteristicUuid | string | 是 | 是 | 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| characteristicValue | ArrayBuffer | 是 | 是 | 特征对应的二进制值。 | | characteristicValue | ArrayBuffer | 是 | 是 | 特征对应的二进制值。 |
...@@ -3010,7 +3008,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3010,7 +3008,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------------ | ----------- | ---- | ---- | ------------------------------------------------------------ | | ------------------ | ----------- | ---- | ---- | ---------------------------------------- |
| serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 | | serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string | 是 | 是 | 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 | | characteristicUuid | string | 是 | 是 | 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| descriptorUuid | string | 是 | 是 | 描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。 | | descriptorUuid | string | 是 | 是 | 描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。 |
...@@ -3024,7 +3022,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3024,7 +3022,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------------- | ----------- | ---- | ---- | ------------------------------------------------------------ | | ------------------- | ----------- | ---- | ---- | ---------------------------------------- |
| serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 | | serviceUuid | string | 是 | 是 | 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string | 是 | 是 | 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 | | characteristicUuid | string | 是 | 是 | 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| characteristicValue | ArrayBuffer | 是 | 是 | 特征对应的二进制值。 | | characteristicValue | ArrayBuffer | 是 | 是 | 特征对应的二进制值。 |
...@@ -3038,7 +3036,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3038,7 +3036,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------------ | -------- | ---- | ---- | ------------------------------------------------------------ | | ------------------ | ------ | ---- | ---- | ---------------------------------------- |
| deviceId | string | 是 | 否 | 表示发送特征值读请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | deviceId | string | 是 | 否 | 表示发送特征值读请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number | 是 | 否 | 表示读请求的传输ID，server端回复响应时需填写相同的传输ID。 | | transId | number | 是 | 否 | 表示读请求的传输ID，server端回复响应时需填写相同的传输ID。 |
| offset | number | 是 | 否 | 表示读特征值数据的起始位置。例如：k表示从第k个字节开始读，server端回复响应时需填写相同的offset。 | | offset | number | 是 | 否 | 表示读特征值数据的起始位置。例如：k表示从第k个字节开始读，server端回复响应时需填写相同的offset。 |
...@@ -3053,7 +3051,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3053,7 +3051,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------------ | -------- | ---- | ---- | ------------------------------------------------------------ | | ------------------ | ------ | ---- | ---- | ---------------------------------------- |
| deviceId | string | 是 | 否 | 表示发送特征值写请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | deviceId | string | 是 | 否 | 表示发送特征值写请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number | 是 | 否 | 表示写请求的传输ID，server端回复响应时需填写相同的传输ID。 | | transId | number | 是 | 否 | 表示写请求的传输ID，server端回复响应时需填写相同的传输ID。 |
| offset | number | 是 | 否 | 表示写特征值数据的起始位置。例如：k表示从第k个字节开始写，server端回复响应时需填写相同的offset。 | | offset | number | 是 | 否 | 表示写特征值数据的起始位置。例如：k表示从第k个字节开始写，server端回复响应时需填写相同的offset。 |
...@@ -3069,7 +3067,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3069,7 +3067,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------------ | -------- | ---- | ---- | ------------------------------------------------------------ | | ------------------ | ------ | ---- | ---- | ---------------------------------------- |
| deviceId | string | 是 | 否 | 表示发送描述符读请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | deviceId | string | 是 | 否 | 表示发送描述符读请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number | 是 | 否 | 表示读请求的传输ID，server端回复响应时需填写相同的传输ID。 | | transId | number | 是 | 否 | 表示读请求的传输ID，server端回复响应时需填写相同的传输ID。 |
| offset | number | 是 | 否 | 表示读描述符数据的起始位置。例如：k表示从第k个字节开始读，server端回复响应时需填写相同的offset。 | | offset | number | 是 | 否 | 表示读描述符数据的起始位置。例如：k表示从第k个字节开始读，server端回复响应时需填写相同的offset。 |
...@@ -3085,7 +3083,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3085,7 +3083,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------------ | ----------- | ---- | ---- | ------------------------------------------------------------ | | ------------------ | ----------- | ---- | ---- | ---------------------------------------- |
| deviceId | string | 是 | 否 | 表示发送描述符写请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | deviceId | string | 是 | 否 | 表示发送描述符写请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number | 是 | 否 | 表示写请求的传输ID，server端回复响应时需填写相同的传输ID。 | | transId | number | 是 | 否 | 表示写请求的传输ID，server端回复响应时需填写相同的传输ID。 |
| offset | number | 是 | 否 | 表示写描述符数据的起始位置。例如：k表示从第k个字节开始写，server端回复响应时需填写相同的offset。 | | offset | number | 是 | 否 | 表示写描述符数据的起始位置。例如：k表示从第k个字节开始写，server端回复响应时需填写相同的offset。 |
...@@ -3104,7 +3102,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3104,7 +3102,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ----------- | ---- | ---- | ------------------------------------------------------------ | | -------- | ----------- | ---- | ---- | -------------------------------------- |
| deviceId | string | 是 | 否 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | deviceId | string | 是 | 否 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number | 是 | 否 | 表示请求的传输ID，与订阅的读/写请求事件携带的ID保持一致。 | | transId | number | 是 | 否 | 表示请求的传输ID，与订阅的读/写请求事件携带的ID保持一致。 |
| status | number | 是 | 否 | 表示响应的状态，设置为0即可，表示正常。 | | status | number | 是 | 否 | 表示响应的状态，设置为0即可，表示正常。 |
...@@ -3119,7 +3117,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3119,7 +3117,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ------------------------------------------------- | ---- | ---- | --------------------------------------------- | | -------- | ---------------------------------------- | ---- | ---- | -------------------------------- |
| deviceId | string | 是 | 否 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | deviceId | string | 是 | 否 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| state | [ProfileConnectionState](#profileconnectionState) | 是 | 是 | 表示BLE连接状态的枚举。 | | state | [ProfileConnectionState](#profileconnectionState) | 是 | 是 | 表示BLE连接状态的枚举。 |
...@@ -3131,7 +3129,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3131,7 +3129,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ------------------- | ------ | --------------------- | | ------------------- | ---- | -------------- |
| STATE_DISCONNECTED | 0 | 表示profile已断连。 | | STATE_DISCONNECTED | 0 | 表示profile已断连。 |
| STATE_CONNECTING | 1 | 表示profile正在连接。 | | STATE_CONNECTING | 1 | 表示profile正在连接。 |
| STATE_CONNECTED | 2 | 表示profile已连接。 | | STATE_CONNECTED | 2 | 表示profile已连接。 |
...@@ -3145,7 +3143,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3145,7 +3143,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ----------- | -------- | ---- | ---- | ------------------------------------------------------------ | | ----------- | ------ | ---- | ---- | ---------------------------------------- |
| deviceId | string | 是 | 是 | 表示过滤的BLE设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | deviceId | string | 是 | 是 | 表示过滤的BLE设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| name | string | 是 | 是 | 表示过滤的BLE设备名。 | | name | string | 是 | 是 | 表示过滤的BLE设备名。 |
| serviceUuid | string | 是 | 是 | 表示过滤包含该UUID服务的设备，例如：00001888-0000-1000-8000-00805f9b34fb。 | | serviceUuid | string | 是 | 是 | 表示过滤包含该UUID服务的设备，例如：00001888-0000-1000-8000-00805f9b34fb。 |
...@@ -3158,7 +3156,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3158,7 +3156,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------- | ----------------------- | ---- | ---- | ------------------------------------------------------- | | --------- | ----------------------- | ---- | ---- | -------------------------------------- |
| interval | number | 是 | 是 | 表示扫描结果上报延迟时间，默认值为0。 | | interval | number | 是 | 是 | 表示扫描结果上报延迟时间，默认值为0。 |
| dutyMode | [ScanDuty](#scanduty) | 是 | 是 | 表示扫描模式，默认值为SCAN_MODE_LOW_POWER。 | | dutyMode | [ScanDuty](#scanduty) | 是 | 是 | 表示扫描模式，默认值为SCAN_MODE_LOW_POWER。 |
| matchMode | [MatchMode](#matchmode) | 是 | 是 | 表示硬件的过滤匹配模式，默认值为MATCH_MODE_AGGRESSIVE。 | | matchMode | [MatchMode](#matchmode) | 是 | 是 | 表示硬件的过滤匹配模式，默认值为MATCH_MODE_AGGRESSIVE。 |
...@@ -3171,7 +3169,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3171,7 +3169,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| --------------------- | ------ | ------------------------ | | --------------------- | ---- | ------------ |
| SCAN_MODE_LOW_POWER | 0 | 表示低功耗模式，默认值。 | | SCAN_MODE_LOW_POWER | 0 | 表示低功耗模式，默认值。 |
| SCAN_MODE_BALANCED | 1 | 表示均衡模式。 | | SCAN_MODE_BALANCED | 1 | 表示均衡模式。 |
| SCAN_MODE_LOW_LATENCY | 2 | 表示低延迟模式。 | | SCAN_MODE_LOW_LATENCY | 2 | 表示低延迟模式。 |
...@@ -3184,7 +3182,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3184,7 +3182,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| --------------------- | ------ | ------------------------------------------------------------ | | --------------------- | ---- | ---------------------------------------- |
| MATCH_MODE_AGGRESSIVE | 1 | 表示硬件上报扫描结果门限较低，比如扫描到的功率较低或者一段时间扫描到的次数较少也触发上报，默认值。 | | MATCH_MODE_AGGRESSIVE | 1 | 表示硬件上报扫描结果门限较低，比如扫描到的功率较低或者一段时间扫描到的次数较少也触发上报，默认值。 |
| MATCH_MODE_STICKY | 2 | 表示硬件上报扫描结果门限较高，更高的功率门限以及扫描到多次才会上报。 | | MATCH_MODE_STICKY | 2 | 表示硬件上报扫描结果门限较高，更高的功率门限以及扫描到多次才会上报。 |
...@@ -3196,7 +3194,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3196,7 +3194,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ----------- | ---- | ---- | ------------------------------------------------- | | -------- | ----------- | ---- | ---- | ---------------------------------- |
| deviceId | string | 是 | 否 | 表示扫描到的设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | deviceId | string | 是 | 否 | 表示扫描到的设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| rssi | number | 是 | 否 | 表示扫描到的设备的rssi值。 | | rssi | number | 是 | 否 | 表示扫描到的设备的rssi值。 |
| data | ArrayBuffer | 是 | 否 | 表示扫描到的设备发送的广播包。 | | data | ArrayBuffer | 是 | 否 | 表示扫描到的设备发送的广播包。 |
...@@ -3209,7 +3207,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3209,7 +3207,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| --------------------- | ------ | ----------------------------- | | --------------------- | ---- | ------------------ |
| STATE_OFF | 0 | 表示蓝牙已关闭。 | | STATE_OFF | 0 | 表示蓝牙已关闭。 |
| STATE_TURNING_ON | 1 | 表示蓝牙正在打开。 | | STATE_TURNING_ON | 1 | 表示蓝牙正在打开。 |
| STATE_ON | 2 | 表示蓝牙已打开。 | | STATE_ON | 2 | 表示蓝牙已打开。 |
...@@ -3226,7 +3224,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3226,7 +3224,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ----------- | -------- | ---- | ---- | ------------------------------------------------------------ | | ----------- | ------- | ---- | ---- | ---------------------------------------- |
| interval | number | 是 | 是 | 表示广播间隔，最小值设置32个slot表示20ms，最大值设置16777215个slot，默认值设置为1600个slot表示1s。 | | interval | number | 是 | 是 | 表示广播间隔，最小值设置32个slot表示20ms，最大值设置16777215个slot，默认值设置为1600个slot表示1s。 |
| txPower | number | 是 | 是 | 表示发送功率，最小值设置-127，最大值设置1，默认值设置-7，单位dbm。 | | txPower | number | 是 | 是 | 表示发送功率，最小值设置-127，最大值设置1，默认值设置-7，单位dbm。 |
| connectable | boolean | 是 | 是 | 表示是否是可连接广播，默认值设置为true。 | | connectable | boolean | 是 | 是 | 表示是否是可连接广播，默认值设置为true。 |
...@@ -3239,7 +3237,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3239,7 +3237,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------------- | ------------------------------------------------ | ---- | ---- | -------------------------------------- | | --------------- | ---------------------------------------- | ---- | ---- | --------------------------- |
| serviceUuids | Array&lt;string&gt; | 是 | 是 | 表示要广播的服务&nbsp;UUID&nbsp;列表。 | | serviceUuids | Array&lt;string&gt; | 是 | 是 | 表示要广播的服务&nbsp;UUID&nbsp;列表。 |
| manufactureData | Array&lt;[ManufactureData](#manufacturedata)&gt; | 是 | 是 | 表示要广播的广播的制造商信息列表。 | | manufactureData | Array&lt;[ManufactureData](#manufacturedata)&gt; | 是 | 是 | 表示要广播的广播的制造商信息列表。 |
| serviceData | Array&lt;[ServiceData](#servicedata)&gt; | 是 | 是 | 表示要广播的服务数据列表。 | | serviceData | Array&lt;[ServiceData](#servicedata)&gt; | 是 | 是 | 表示要广播的服务数据列表。 |
...@@ -3252,7 +3250,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3252,7 +3250,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ---------------- | ------------------- | ---- | ---- | ------------------------------- | | ---------------- | ------------------- | ---- | ---- | ------------------ |
| manufactureId | Array&lt;string&gt; | 是 | 是 | 表示制造商的ID，由蓝牙SIG分配。 | | manufactureId | Array&lt;string&gt; | 是 | 是 | 表示制造商的ID，由蓝牙SIG分配。 |
| manufactureValue | ArrayBuffer | 是 | 是 | 表示制造商发送的制造商数据。 | | manufactureValue | ArrayBuffer | 是 | 是 | 表示制造商发送的制造商数据。 |
...@@ -3264,7 +3262,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3264,7 +3262,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------ | ----------- | ---- | ---- | ---------------- | | ------------ | ----------- | ---- | ---- | ---------- |
| serviceUuid | string | 是 | 是 | 表示服务的UUID。 | | serviceUuid | string | 是 | 是 | 表示服务的UUID。 |
| serviceValue | ArrayBuffer | 是 | 是 | 表示服务数据。 | | serviceValue | ArrayBuffer | 是 | 是 | 表示服务数据。 |
...@@ -3276,7 +3274,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3276,7 +3274,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | ---- | ---- | -------------------- | | -------- | ------ | ---- | ---- | ----------- |
| deviceId | string | 是 | 否 | 表示要配对的设备ID。 | | deviceId | string | 是 | 否 | 表示要配对的设备ID。 |
| pinCode | string | 是 | 否 | 表示要配对的密钥。 | | pinCode | string | 是 | 否 | 表示要配对的密钥。 |
...@@ -3288,7 +3286,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3288,7 +3286,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ------------------------------------------------- | ---- | ---- | ------------------------------- | | -------- | ---------------------------------------- | ---- | ---- | ------------------- |
| deviceId | string | 是 | 否 | 表示蓝牙设备地址。 | | deviceId | string | 是 | 否 | 表示蓝牙设备地址。 |
| state | [ProfileConnectionState](#ProfileConnectionState) | 是 | 否 | 表示蓝牙设备的profile连接状态。 | | state | [ProfileConnectionState](#ProfileConnectionState) | 是 | 否 | 表示蓝牙设备的profile连接状态。 |
...@@ -3300,7 +3298,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3300,7 +3298,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------------- | ----------------------------------- | ---- | ---- | -------------------------------- | | --------------- | ----------------------------------- | ---- | ---- | ---------------- |
| majorClass | [MajorClass](#majorclass) | 是 | 否 | 表示蓝牙设备主要类别的枚举。 | | majorClass | [MajorClass](#majorclass) | 是 | 否 | 表示蓝牙设备主要类别的枚举。 |
| majorMinorClass | [MajorMinorClass](#majorminorclass) | 是 | 否 | 表示主要次要蓝牙设备类别的枚举。 | | majorMinorClass | [MajorMinorClass](#majorminorclass) | 是 | 否 | 表示主要次要蓝牙设备类别的枚举。 |
| classOfDevice | number | 是 | 否 | 表示设备类别。 | | classOfDevice | number | 是 | 否 | 表示设备类别。 |
...@@ -3314,7 +3312,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3314,7 +3312,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ------------------- | ------ | -------------------- | | ------------------- | ------ | ---------- |
| MAJOR_MISC | 0x0000 | 表示杂项设备。 | | MAJOR_MISC | 0x0000 | 表示杂项设备。 |
| MAJOR_COMPUTER | 0x0100 | 表示计算机设备。 | | MAJOR_COMPUTER | 0x0100 | 表示计算机设备。 |
| MAJOR_PHONE | 0x0200 | 表示手机设备。 | | MAJOR_PHONE | 0x0200 | 表示手机设备。 |
...@@ -3335,7 +3333,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3335,7 +3333,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ----------------------------------------- | ------ | ------------------------------ | | ---------------------------------------- | ------ | --------------- |
| COMPUTER_UNCATEGORIZED | 0x0100 | 表示未分类计算机设备。 | | COMPUTER_UNCATEGORIZED | 0x0100 | 表示未分类计算机设备。 |
| COMPUTER_DESKTOP | 0x0104 | 表示台式计算机设备。 | | COMPUTER_DESKTOP | 0x0104 | 表示台式计算机设备。 |
| COMPUTER_SERVER | 0x0108 | 表示服务器设备。 | | COMPUTER_SERVER | 0x0108 | 表示服务器设备。 |
...@@ -3431,7 +3429,7 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3431,7 +3429,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ----------------- | ------ | -------------- | | ----------------- | ------ | ------- |
| STATE_NOT_PLAYING | 0x0000 | 表示未播放。 | | STATE_NOT_PLAYING | 0x0000 | 表示未播放。 |
| STATE_PLAYING | 0x0001 | 表示正在播放。 | | STATE_PLAYING | 0x0001 | 表示正在播放。 |
...@@ -3443,6 +3441,6 @@ let rssi = gattClient.getRssiValue().then((data) => { ...@@ -3443,6 +3441,6 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。 **系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------------------------------- | ------ | ------------------ | | -------------------------------- | ------ | --------------- |
| PROFILE_A2DP_SOURCE | 0x0001 | 表示A2DP profile。 | | PROFILE_A2DP_SOURCE | 0x0001 | 表示A2DP profile。 |
| PROFILE_HANDS_FREE_AUDIO_GATEWAY | 0x0004 | 表示HFP profile。 | | PROFILE_HANDS_FREE_AUDIO_GATEWAY | 0x0004 | 表示HFP profile。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md
浏览文件 @ 481ff40b
...@@ -24,7 +24,7 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>) ...@@ -24,7 +24,7 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>)
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| --------- | --------------------- | ---- | ------------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 | | parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<number> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<number> | 是 | 被指定的回调方法。 |
...@@ -63,7 +63,7 @@ startAbility(parameter: StartAbilityParameter): Promise\<number> ...@@ -63,7 +63,7 @@ startAbility(parameter: StartAbilityParameter): Promise\<number>
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| --------- | ----------------------------------------------- | ---- | --------------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 | | parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 |
**示例：** **示例：**
...@@ -101,13 +101,13 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper ...@@ -101,13 +101,13 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | ------------------------ | | ---- | ------ | ---- | ------------ |
| uri | string | 是 | 指示要打开的文件的路径。 | | uri | string | 是 | 指示要打开的文件的路径。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------- | -------------------------------------------- | | ----------------- | ------------------------------- |
| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 | | DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 |
**示例：** **示例：**
...@@ -130,7 +130,7 @@ startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\ ...@@ -130,7 +130,7 @@ startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| --------- | ----------------------------------------------- | ---- | --------------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 | | parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<[AbilityResult](#abilityresult)> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<[AbilityResult](#abilityresult)> | 是 | 被指定的回调方法。 |
...@@ -167,13 +167,13 @@ startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult> ...@@ -167,13 +167,13 @@ startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| --------- | ----------------------------------------------- | ---- | ------------------- | | --------- | ---------------------------------------- | ---- | ------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability | | parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------- | -------------- | | ---------------------------------------- | ------- |
| Promise\<[AbilityResult](#abilityresult)> | 返回执行结果。 | | Promise\<[AbilityResult](#abilityresult)> | 返回执行结果。 |
**示例：** **示例：**
...@@ -223,7 +223,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void> ...@@ -223,7 +223,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| --------- | ------------- | ---- | ------------------- | | --------- | ------------------------------- | ---- | -------------- |
| parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability。 | | parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<void> | 是 | 被指定的回调方法。 |
...@@ -271,13 +271,13 @@ terminateSelfWithResult(parameter: AbilityResult): Promise\<void> ...@@ -271,13 +271,13 @@ terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| --------- | ------------------------------- | ---- | ------------------- | | --------- | ------------------------------- | ---- | ------------- |
| parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability | | parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ----------------------- | | -------------- | --------------- |
| Promise\<void> | 以Promise形式返回结果。 | | Promise\<void> | 以Promise形式返回结果。 |
**示例：** **示例：**
...@@ -328,7 +328,7 @@ hasWindowFocus(callback: AsyncCallback\<boolean>): void ...@@ -328,7 +328,7 @@ hasWindowFocus(callback: AsyncCallback\<boolean>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 被指定的回调方法。<br>如果此Ability当前具有视窗焦点，则返回true；否则返回false。 | | callback | AsyncCallback\<boolean> | 是 | 被指定的回调方法。<br>如果此Ability当前具有视窗焦点，则返回true；否则返回false。 |
**示例：** **示例：**
...@@ -351,7 +351,7 @@ hasWindowFocus(): Promise\<boolean> ...@@ -351,7 +351,7 @@ hasWindowFocus(): Promise\<boolean>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------- | ---------------------------------------------------------- | | ----------------- | ------------------------------------- |
| Promise\<boolean> | 如果此Ability当前具有视窗焦点，则返回true；否则返回false。 | | Promise\<boolean> | 如果此Ability当前具有视窗焦点，则返回true；否则返回false。 |
**示例：** **示例：**
...@@ -376,7 +376,7 @@ getWant(callback: AsyncCallback\<Want>): void ...@@ -376,7 +376,7 @@ getWant(callback: AsyncCallback\<Want>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ----------------------------- | ---- | ------------------ | | -------- | ----------------------------- | ---- | --------- |
| callback | AsyncCallback\<[Want](#want)> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<[Want](#want)> | 是 | 被指定的回调方法。 |
**示例：** **示例：**
...@@ -399,7 +399,7 @@ getWant(): Promise\<Want> ...@@ -399,7 +399,7 @@ getWant(): Promise\<Want>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------- | ------------------------- | | ----------------------- | ---------------- |
| Promise\<[Want](#want)> | 以Promise的形式返回结果。 | | Promise\<[Want](#want)> | 以Promise的形式返回结果。 |
**示例：** **示例：**
...@@ -422,7 +422,7 @@ getContext(): Context ...@@ -422,7 +422,7 @@ getContext(): Context
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | -------------------- | | ------- | ---------- |
| Context | 返回应用程序上下文。 | | Context | 返回应用程序上下文。 |
**示例：** **示例：**
...@@ -446,7 +446,7 @@ terminateSelf(callback: AsyncCallback\<void>): void ...@@ -446,7 +446,7 @@ terminateSelf(callback: AsyncCallback\<void>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | ---------------- | | -------- | -------------------- | ---- | -------- |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 | | callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
**示例：** **示例：**
...@@ -469,7 +469,7 @@ terminateSelf(): Promise\<void> ...@@ -469,7 +469,7 @@ terminateSelf(): Promise\<void>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ------------------------- | | -------------- | ---------------- |
| Promise\<void> | 以Promise的形式返回结果。 | | Promise\<void> | 以Promise的形式返回结果。 |
**示例：** **示例：**
...@@ -491,7 +491,7 @@ connectAbility(request: Want, options:ConnectOptions): number ...@@ -491,7 +491,7 @@ connectAbility(request: Want, options:ConnectOptions): number
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------- | -------------- | ---- | ---------------------------- | | ------- | -------------- | ---- | --------------------- |
| request | [Want](#want) | 是 | 表示被连接的ServiceAbility。 | | request | [Want](#want) | 是 | 表示被连接的ServiceAbility。 |
| options | ConnectOptions | 是 | 被指定的回调方法。 | | options | ConnectOptions | 是 | 被指定的回调方法。 |
...@@ -500,7 +500,7 @@ connectAbility(request: Want, options:ConnectOptions): number ...@@ -500,7 +500,7 @@ connectAbility(request: Want, options:ConnectOptions): number
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------ | -------- | -------- | ---- | ---------------------------------- | | ----------- | ---- | ------ | ---- | ---------------------------------------- |
| deviceId | 只读 | string | 否 | 表示被连接的ServiceAbility的设备id，缺省表示连接本地的ServiceAbility。 | | deviceId | 只读 | string | 否 | 表示被连接的ServiceAbility的设备id，缺省表示连接本地的ServiceAbility。 |
| bundleName | 只读 | string | 是 | 表示被连接的ServiceAbility的包名。 | | bundleName | 只读 | string | 是 | 表示被连接的ServiceAbility的包名。 |
| abilityName | 只读 | string | 是 | 表示被连接的ServiceAbility的类名。 | | abilityName | 只读 | string | 是 | 表示被连接的ServiceAbility的类名。 |
...@@ -510,7 +510,7 @@ connectAbility(request: Want, options:ConnectOptions): number ...@@ -510,7 +510,7 @@ connectAbility(request: Want, options:ConnectOptions): number
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------ | -------- | -------- | ---- | ---------------------------------- | | ------------ | ---- | -------- | ---- | ------------------------- |
| onConnect | 只读 | function | 是 | 连接成功时的回调函数。 | | onConnect | 只读 | function | 是 | 连接成功时的回调函数。 |
| onDisconnect | 只读 | function | 是 | 连接失败时的回调函数。 | | onDisconnect | 只读 | function | 是 | 连接失败时的回调函数。 |
| onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数。 | | onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数。 |
...@@ -518,7 +518,7 @@ connectAbility(request: Want, options:ConnectOptions): number ...@@ -518,7 +518,7 @@ connectAbility(request: Want, options:ConnectOptions): number
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------------------ | | ------ | -------------------- |
| number | 连接的ServiceAbilityID。 | | number | 连接的ServiceAbilityID。 |
**示例：** **示例：**
...@@ -560,7 +560,7 @@ disconnectAbility(connection: number, callback:AsyncCallback\<void>): void ...@@ -560,7 +560,7 @@ disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------------- | ---- | ------------------------------ | | ---------- | -------------------- | ---- | ----------------------- |
| connection | number | 是 | 指定断开连接的ServiceAbilityID | | connection | number | 是 | 指定断开连接的ServiceAbilityID |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 | | callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
...@@ -607,13 +607,13 @@ disconnectAbility(connection: number): Promise\<void> ...@@ -607,13 +607,13 @@ disconnectAbility(connection: number): Promise\<void>
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------ | ---- | ------------------------------ | | ---------- | ------ | ---- | ----------------------- |
| connection | number | 是 | 指定断开连接的ServiceAbilityID | | connection | number | 是 | 指定断开连接的ServiceAbilityID |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | ----------------------- | | -------------- | --------------- |
| Promise\<void> | 以Promise形式返回结果。 | | Promise\<void> | 以Promise形式返回结果。 |
**示例：** **示例：**
...@@ -659,15 +659,13 @@ getWindow(callback: AsyncCallback\<window.Window>): void ...@@ -659,15 +659,13 @@ getWindow(callback: AsyncCallback\<window.Window>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------- | ---- | ------------- |
| callback | AsyncCallback\<window.Window> | 是 | 返回与当前能力对应的窗口。 | | callback | AsyncCallback\<window.Window> | 是 | 返回与当前能力对应的窗口。 |
**示例：** **示例：**
```javascript ```javascript
GetWindow(){ featureAbility.getWindow()
featureAbility.getWindow()
}
``` ```
## featureAbility.getWindow<sup>7+</sup> ## featureAbility.getWindow<sup>7+</sup>
...@@ -681,17 +679,15 @@ getWindow(): Promise\<window.Window>; ...@@ -681,17 +679,15 @@ getWindow(): Promise\<window.Window>;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------- | ---------------------------------------------------------- | | ----------------------- | ------------- |
| Promise\<window.Window> | 返回与当前能力对应的窗口。 | | Promise\<window.Window> | 返回与当前能力对应的窗口。 |
**示例：** **示例：**
```javascript ```javascript
GetWindowPromise(){ featureAbility.getWindow().then((data) => {
featureAbility.getWindow().then((data) => {
console.info("=============getWindowPromise========== " + JSON.stringify(data)); console.info("=============getWindowPromise========== " + JSON.stringify(data));
}); });
}
``` ```
## ConnectOptions.onConnect<sup>7+</sup> ## ConnectOptions.onConnect<sup>7+</sup>
...@@ -705,7 +701,7 @@ onConnect(elementName: ElementName, remote: rpc.IRemoteObject): void; ...@@ -705,7 +701,7 @@ onConnect(elementName: ElementName, remote: rpc.IRemoteObject): void;
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ | | ----------- | ----------------- | ---- | -------- |
| elementName | ElementName | 是 | 元素名。 | | elementName | ElementName | 是 | 元素名。 |
| remote | rpc.IRemoteObject | 是 | rpc远程对象。 | | remote | rpc.IRemoteObject | 是 | rpc远程对象。 |
...@@ -748,7 +744,7 @@ onDisconnect(elementName: ElementName): void; ...@@ -748,7 +744,7 @@ onDisconnect(elementName: ElementName): void;
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ | | ----------- | ----------- | ---- | ---- |
| elementName | ElementName | 是 | 元素名。 | | elementName | ElementName | 是 | 元素名。 |
**示例：** **示例：**
...@@ -790,7 +786,7 @@ ConnectAbility调用失败时的回调函数。 ...@@ -790,7 +786,7 @@ ConnectAbility调用失败时的回调函数。
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ | | ---- | ------ | ---- | --------- |
| code | number | 是 | number类型。 | | code | number | 是 | number类型。 |
**示例：** **示例：**
...@@ -836,7 +832,7 @@ featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED ...@@ -836,7 +832,7 @@ featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED
``` ```
| 名称 | 参数 | 描述 | | 名称 | 参数 | 描述 |
| --------------------------- | ---- | ---------- | | ---------------------------------------- | ---- | ---------------------------------------- |
| WINDOW_MODE_UNDEFINED<sup>7+</sup> | 0 | 未定义。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel | | WINDOW_MODE_UNDEFINED<sup>7+</sup> | 0 | 未定义。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_FULLSCREEN<sup>7+</sup> | 1 | 全屏。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel | | WINDOW_MODE_FULLSCREEN<sup>7+</sup> | 1 | 全屏。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_SPLIT_PRIMARY<sup>7+</sup> | 100 | 分屏主屏。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel | | WINDOW_MODE_SPLIT_PRIMARY<sup>7+</sup> | 100 | 分屏主屏。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
...@@ -857,7 +853,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY ...@@ -857,7 +853,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
``` ```
| 名称 | 参数 | 描述 | | 名称 | 参数 | 描述 |
| --------------- | --------------- | -------------------------- | | ---------------------------- | --------------- | ---------------------------------------- |
| BOUNDS_KEY<sup>7+</sup> | "abilityBounds" | 窗口显示大小属性的名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel | | BOUNDS_KEY<sup>7+</sup> | "abilityBounds" | 窗口显示大小属性的名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_KEY<sup>7+</sup> | "windowMode" | 窗口显示模式属性的名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel | | WINDOW_MODE_KEY<sup>7+</sup> | "windowMode" | 窗口显示模式属性的名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| DISPLAY_ID_KEY<sup>7+</sup> | "displayId" | 窗口显示设备ID属性的名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel | | DISPLAY_ID_KEY<sup>7+</sup> | "displayId" | 窗口显示设备ID属性的名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
...@@ -867,7 +863,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY ...@@ -867,7 +863,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
获取错误代码。 获取错误代码。
| 变量 | 值 | 说明 | | 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ | | ------------------------------ | ---- | ---------------------------------------- |
| NO_ERROR<sup>7+</sup> | 0 | 没有错误。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel | | NO_ERROR<sup>7+</sup> | 0 | 没有错误。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| INVALID_PARAMETER<sup>7+</sup> | -1 | 无效的参数。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel | | INVALID_PARAMETER<sup>7+</sup> | -1 | 无效的参数。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| ABILITY_NOT_FOUND<sup>7+</sup> | -2 | 找不到能力。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel | | ABILITY_NOT_FOUND<sup>7+</sup> | -2 | 找不到能力。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
...@@ -879,7 +875,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY ...@@ -879,7 +875,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
指示数据的操作类型。 指示数据的操作类型。
| 变量 | 值 | 说明 | | 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ | | ------------------------ | ---- | ---------------------------------------- |
| TYPE_INSERT<sup>7+</sup> | 1 | 插入类型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel | | TYPE_INSERT<sup>7+</sup> | 1 | 插入类型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| TYPE_UPDATE<sup>7+</sup> | 2 | 修改类型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel | | TYPE_UPDATE<sup>7+</sup> | 2 | 修改类型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| TYPE_DELETE<sup>7+</sup> | 3 | 删除类型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel | | TYPE_DELETE<sup>7+</sup> | 3 | 删除类型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
...@@ -892,7 +888,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY ...@@ -892,7 +888,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------- | ---- | ------------------------------------------------------------ | | ----------------------- | ---- | ------------- | ---- | ------------------------------------- |
| resultCode<sup>7+</sup> | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持）。 | | resultCode<sup>7+</sup> | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持）。 |
| want<sup>7+</sup> | 只读 | [Want](#want) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 | | want<sup>7+</sup> | 只读 | [Want](#want) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
...@@ -901,7 +897,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY ...@@ -901,7 +897,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
**系统能力**：以下各项对应的系统能力均为SystemCapability.AbilityRuntime.FAModel **系统能力**：以下各项对应的系统能力均为SystemCapability.AbilityRuntime.FAModel
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | | ------------------- | ---- | -------------------- | ---- | -------------------------------------- |
| want | 只读 | [Want](#want) | 是 | 表示需要包含有关目标启动能力的信息。 | | want | 只读 | [Want](#want) | 是 | 表示需要包含有关目标启动能力的信息。 |
| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 | | abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 |
...@@ -911,7 +907,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY ...@@ -911,7 +907,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | | -------------------------------- | ---- | -------------------- | ---- | ---------------------------------------- |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 | | deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | | bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | | abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
...@@ -929,7 +925,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY ...@@ -929,7 +925,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 参数 | 描述 | | 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ | | ------------------------------------ | ---------- | ---------------------------------------- |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 | | FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 | | FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力。 | | FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力。 |
......
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
浏览文件 @ 481ff40b
...@@ -27,23 +27,25 @@ getDeviceIds(callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void ...@@ -27,23 +27,25 @@ getDeviceIds(callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void
**参数：** **参数：**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ----- |
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 回调函数。 |
**示例：** **示例：**
``` ```
data: { export default {
data: {
deviceIds: Array, deviceIds: Array,
}, },
callback: function(ids) { callback: function(ids) {
this.deviceIds = ids; this.deviceIds = ids;
}, },
testGetDeviceIds: function () { testGetDeviceIds: function () {
console.info("InputDeviceJsTest---start---testGetDeviceIds"); console.info("InputDeviceJsTest---start---testGetDeviceIds");
inputDevice.getDeviceIds(this.callback); inputDevice.getDeviceIds(this.callback);
console.info("InputDeviceJsTest---end---testGetDeviceIds"); console.info("InputDeviceJsTest---end---testGetDeviceIds");
}
} }
``` ```
...@@ -58,13 +60,14 @@ function getDeviceIds(): Promise<Array<number>> ...@@ -58,13 +60,14 @@ function getDeviceIds(): Promise<Array<number>>
**返回值：** **返回值：**
| 参数 | 说明 | | 参数 | 说明 |
| -------- | -------- | | ---------------------- | ------------------ |
| Promise<Array<number>> | Promise实例，用于异步获取结果 | | Promise<Array<number>> | Promise实例，用于异步获取结果 |
**示例：** **示例：**
``` ```
testGetDeviceIds: function () { export default {
testGetDeviceIds: function () {
console.info("InputDeviceJsTest---start---testGetDeviceIds"); console.info("InputDeviceJsTest---start---testGetDeviceIds");
let promise = inputDevice.getDeviceIds(); let promise = inputDevice.getDeviceIds();
promise.then((data)=> { promise.then((data)=> {
...@@ -72,6 +75,7 @@ testGetDeviceIds: function () { ...@@ -72,6 +75,7 @@ testGetDeviceIds: function () {
}).catch((err)=>{ }).catch((err)=>{
console.error('Failed GetDeviceIds. Cause: ' + JSON.stringify(err)); console.error('Failed GetDeviceIds. Cause: ' + JSON.stringify(err));
}); });
}
} }
``` ```
...@@ -90,27 +94,29 @@ getDevice(deviceId: number, callback: AsyncCallback&lt;InputDeviceData&gt;): voi ...@@ -90,27 +94,29 @@ getDevice(deviceId: number, callback: AsyncCallback&lt;InputDeviceData&gt;): voi
**参数：** **参数：**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | --------------------------- |
| deviceId | number | 是 | 需要获取信息的设备id。 | | deviceId | number | 是 | 需要获取信息的设备id。 |
| callback | AsyncCallback&lt;[InputDeviceData](#inputdevicedata)&gt; | 是 | 回调函数，异步返回InputDeviceData对象。 | | callback | AsyncCallback&lt;[InputDeviceData](#inputdevicedata)&gt; | 是 | 回调函数，异步返回InputDeviceData对象。 |
**示例：** **示例：**
``` ```
InputDeviceData { export default {
InputDeviceData {
deviceId : 0, deviceId : 0,
name : "NA", name : "NA",
sources : Array, sources : Array,
axisRanges : Array, axisRanges : Array,
}, },
callback: function(deviceData) { callback: function(deviceData) {
this.InputDeviceData = deviceData; this.InputDeviceData = deviceData;
}, },
testGetDevice: function () { testGetDevice: function () {
// 示例获取设备id为1的设备信息。 // 示例获取设备id为1的设备信息。
console.info("InputDeviceJsTest---start---testGetDevice"); console.info("InputDeviceJsTest---start---testGetDevice");
inputDevice.getDevice(1, this.callback); inputDevice.getDevice(1, this.callback);
console.info("InputDeviceJsTest---end---testGetDevice"); console.info("InputDeviceJsTest---end---testGetDevice");
}
} }
``` ```
...@@ -125,19 +131,20 @@ function getDevice(deviceId: number): Promise<InputDeviceData> ...@@ -125,19 +131,20 @@ function getDevice(deviceId: number): Promise<InputDeviceData>
**返回值：** **返回值：**
| 参数 | 说明 | | 参数 | 说明 |
| -------- | -------- | | ------------------------ | ------------------ |
| Promise<InputDeviceData> | Promise实例，用于异步获取结果 | | Promise<InputDeviceData> | Promise实例，用于异步获取结果 |
**示例：** **示例：**
``` ```
InputDeviceData { export default {
InputDeviceData {
deviceId : 0, deviceId : 0,
name : "NA", name : "NA",
sources : Array, sources : Array,
axisRanges : Array, axisRanges : Array,
}, },
testGetDevice: function () { testGetDevice: function () {
// 示例获取设备id为1的设备信息。 // 示例获取设备id为1的设备信息。
console.info("InputDeviceJsTest---start---testGetDevice"); console.info("InputDeviceJsTest---start---testGetDevice");
let promise = inputDevice.getDevice(1); let promise = inputDevice.getDevice(1);
...@@ -146,6 +153,7 @@ testGetDevice: function () { ...@@ -146,6 +153,7 @@ testGetDevice: function () {
}).catch((err)=>{ }).catch((err)=>{
console.error('Failed GetDeviceId. Cause: ' + JSON.stringify(err)); console.error('Failed GetDeviceId. Cause: ' + JSON.stringify(err));
}); });
}
} }
``` ```
...@@ -158,7 +166,7 @@ testGetDevice: function () { ...@@ -158,7 +166,7 @@ testGetDevice: function () {
**系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice **系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 | | 名称 | 参数类型 | 说明 |
| -------- | -------- | -------- | | ------- | -------------------------------------- | ---------------------------------------- |
| id | number | 输入设备的唯一标识，同一个物理设备反复插拔，其设备id会发生变化。 | | id | number | 输入设备的唯一标识，同一个物理设备反复插拔，其设备id会发生变化。 |
| name | string | 输入设备的名字。 | | name | string | 输入设备的名字。 |
| sources | Array&lt;[SourceType](#sourcetype)&gt; | 输入设备支持的源类型。比如有的键盘上附带触摸板，则此设备有keyboard和touchpad两种输入源。 | | sources | Array&lt;[SourceType](#sourcetype)&gt; | 输入设备支持的源类型。比如有的键盘上附带触摸板，则此设备有keyboard和touchpad两种输入源。 |
...@@ -174,7 +182,7 @@ testGetDevice: function () { ...@@ -174,7 +182,7 @@ testGetDevice: function () {
**系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice **系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 | | 名称 | 参数类型 | 说明 |
| ------ | ------------------------- | ---------------- | | ------ | ------------------------- | -------- |
| source | [SourceType](#sourcetype) | 轴的输入源类型。 | | source | [SourceType](#sourcetype) | 轴的输入源类型。 |
| axis | [AxisType](axistype) | 轴的类型 | | axis | [AxisType](axistype) | 轴的类型 |
| max | number | 轴上报的最大值 | | max | number | 轴上报的最大值 |
...@@ -189,7 +197,7 @@ testGetDevice: function () { ...@@ -189,7 +197,7 @@ testGetDevice: function () {
**系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice **系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 | | 名称 | 参数类型 | 说明 |
| -------- | -------- | -------- | | ----------- | ------ | ----------- |
| keyboard | string | 表示输入设备是键盘。 | | keyboard | string | 表示输入设备是键盘。 |
| touchscreen | string | 表示输入设备是触摸屏。 | | touchscreen | string | 表示输入设备是触摸屏。 |
| mouse | string | 表示输入设备是鼠标。 | | mouse | string | 表示输入设备是鼠标。 |
......
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
浏览文件 @ 481ff40b
...@@ -31,15 +31,16 @@ on(type: "touch", receiver: TouchEventReceiver): void ...@@ -31,15 +31,16 @@ on(type: "touch", receiver: TouchEventReceiver): void
**系统能力：**SystemCapability.MultimodalInput.Input.InputMonitor **系统能力：**SystemCapability.MultimodalInput.Input.InputMonitor
**参数：** **参数：**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | -------------------- |
| type | string | 是 | 监听输入事件类型，只支持“touch”。 | | type | string | 是 | 监听输入事件类型，只支持“touch”。 |
| receiver | [TouchEventReceiver](#toucheventreceiver) | 是 | 触摸输入事件回调函数。 | | receiver | [TouchEventReceiver](#toucheventreceiver) | 是 | 触摸输入事件回调函数。 |
**示例：** **示例：**
``` ```
callback: function (value) { export default {
callback: function (value) {
if (checkEvent(value)) { if (checkEvent(value)) {
//事件满足业务要求，事件被消费 //事件满足业务要求，事件被消费
return true; return true;
...@@ -47,14 +48,15 @@ callback: function (value) { ...@@ -47,14 +48,15 @@ callback: function (value) {
//事件不满足业务要求，事件未被消费 //事件不满足业务要求，事件未被消费
return false; return false;
} }
}, },
testOn: function () { testOn: function () {
console.info("InputMonitorJsTest---start---testOn"); console.info("InputMonitorJsTest---start---testOn");
inputMonitor.on( inputMonitor.on(
"touch", "touch",
this.callback this.callback
); );
console.info("InputMonitorJsTest---end---testOn"); console.info("InputMonitorJsTest---end---testOn");
}
} }
``` ```
...@@ -70,15 +72,16 @@ off(type: "touch", receiver: TouchEventReceiver): void ...@@ -70,15 +72,16 @@ off(type: "touch", receiver: TouchEventReceiver): void
**系统能力：**SystemCapability.MultimodalInput.Input.InputMonitor **系统能力：**SystemCapability.MultimodalInput.Input.InputMonitor
**参数：** **参数：**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | -------------------- |
| type | string | 是 | 监听输入事件类型，只支持“touch”。 | | type | string | 是 | 监听输入事件类型，只支持“touch”。 |
| receiver | [TouchEventReceiver](#toucheventreceiver) | 否 | 触摸输入事件回调函数。 | | receiver | [TouchEventReceiver](#toucheventreceiver) | 否 | 触摸输入事件回调函数。 |
**示例：** **示例：**
``` ```
callback: function (value) { export default {
callback: function (value) {
if (checkEvent(value)) { if (checkEvent(value)) {
//事件满足业务要求，事件被消费 //事件满足业务要求，事件被消费
return true; return true;
...@@ -86,15 +89,16 @@ callback: function (value) { ...@@ -86,15 +89,16 @@ callback: function (value) {
//事件不满足业务要求，事件未被消费 //事件不满足业务要求，事件未被消费
return false; return false;
} }
}, },
testOff: function () { testOff: function () {
console.info("InputMonitorJsTest---start---testOff"); console.info("InputMonitorJsTest---start---testOff");
inputMonitor.off( inputMonitor.off(
"touch", "touch",
this.callback this.callback
); );
console.info("InputMonitorJsTest---end---testOff"); console.info("InputMonitorJsTest---end---testOff");
} }
}
``` ```
...@@ -111,18 +115,19 @@ testOff: function () { ...@@ -111,18 +115,19 @@ testOff: function () {
**参数：** **参数：**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---------- | ---------------------------------------- | ---- | ---------------------------------------- |
| touchEvent | [TouchEvent](../arkui-js/js-components-common-events.md) | 是 | 触摸输入事件回调函数，返回true表示输触事件被监听器消费，false表示输触事件未被监听器消费。 | | touchEvent | [TouchEvent](../arkui-js/js-components-common-events.md) | 是 | 触摸输入事件回调函数，返回true表示输触事件被监听器消费，false表示输触事件未被监听器消费。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | -------------------------------------- |
| Boolean | 返回true表示输触事件被监听器消费，false表示输触事件未被监听器消费。 | | Boolean | 返回true表示输触事件被监听器消费，false表示输触事件未被监听器消费。 |
**示例：** **示例：**
``` ```
callback: function (value) { //此处为(touchEvent:TouchEvent): Boolean 方法的实现 export default {
callback: function (value) { //此处为(touchEvent:TouchEvent): Boolean 方法的实现
if (checkEvent(value)) { if (checkEvent(value)) {
//事件满足业务要求，事件被消费 //事件满足业务要求，事件被消费
return true; return true;
...@@ -130,13 +135,14 @@ callback: function (value) { //此处为(touchEvent:TouchEvent): Boolean 方法 ...@@ -130,13 +135,14 @@ callback: function (value) { //此处为(touchEvent:TouchEvent): Boolean 方法
//事件不满足业务要求，事件未被消费 //事件不满足业务要求，事件未被消费
return false; return false;
} }
}, },
testOff: function () { testOff: function () {
console.info("InputMonitorJsTest---start---testOff"); console.info("InputMonitorJsTest---start---testOff");
inputMonitor.off( inputMonitor.off(
"touch", "touch",
this.callback this.callback
); );
console.info("InputMonitorJsTest---end---testOff"); console.info("InputMonitorJsTest---end---testOff");
}
} }
``` ```
zh-cn/application-dev/reference/apis/js-apis-sensor.md
浏览文件 @ 481ff40b
...@@ -1301,7 +1301,7 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback); ...@@ -1301,7 +1301,7 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback);
## sensor.off(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED) ## sensor.off(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED)
off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback&lt;GyroscopeResponse&gt;): void off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback&lt;GyroscopeUncalibratedResponse&gt;): void
取消订阅传感器数据。 取消订阅传感器数据。
...@@ -1909,7 +1909,7 @@ getGeomagneticDip(inclinationMatrix: Array&lt;number&gt;): Promise&lt;number&gt; ...@@ -1909,7 +1909,7 @@ getGeomagneticDip(inclinationMatrix: Array&lt;number&gt;): Promise&lt;number&gt;
## sensor. getAngleModify ## sensor. getAngleModify
getAngleModify(currentRotationMatrix: Array&lt;number&gt;, preRotationMatrix: Array&lt;number&gt;，callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void getAngleModify(currentRotationMatrix: Array&lt;number&gt;, preRotationMatrix: Array&lt;number&gt;, callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void
获取两个旋转矩阵之间的角度变化。 获取两个旋转矩阵之间的角度变化。
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或