Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
481ff40b
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
481ff40b
编写于
3月 23, 2022
作者:
H
HelloCrease
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
fixed error
Signed-off-by:
N
HelloCrease
<
lian15@huawei.com
>
上级
378802d4
变更
7
隐藏空白更改
内联
并排
Showing
7 changed file
with
1690 addition
and
1683 deletion
+1690
-1683
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
+410
-410
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
+347
-348
zh-cn/application-dev/reference/apis/js-apis-bluetooth.md
zh-cn/application-dev/reference/apis/js-apis-bluetooth.md
+632
-634
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md
.../application-dev/reference/apis/js-apis-featureAbility.md
+150
-154
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
+82
-74
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
+67
-61
zh-cn/application-dev/reference/apis/js-apis-sensor.md
zh-cn/application-dev/reference/apis/js-apis-sensor.md
+2
-2
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
浏览文件 @
481ff40b
...
...
@@ -15,11 +15,11 @@ 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.INSTALL_BUNDLE
| system_core | 可安装、卸载应用
|
| ohos.permission.INSTALL_BUNDLE
| system_core | 可安装、卸载应用
|
## bundle.getApplicationInfo
...
...
@@ -37,16 +37,16 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------ | ---- | ---------------------------------------
---------------------
|
| bundleName | string | 是
| 要查询的应用程序包名称。
|
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 否
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------ | ---- | --------------------------------------- |
| bundleName | string | 是
| 要查询的应用程序包名称。
|
| bundleFlags | number | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 否
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。
|
**返回值：**
| 类型
| 说明
|
| -----------
|
-------- |
| 类型
| 说明
|
| -----------
-------------- | ----------
-------- |
| Promise
\<
ApplicationInfo> | Promise形式返回应用程序信息。 |
**示例：**
...
...
@@ -81,12 +81,12 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------------------------------- | ---- | ---------------------------------------
---------------------
|
| bundleName | string | 是
| 要查询的应用程序包名称。
|
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 是
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。
|
| callback | AsyncCallback
\<
ApplicationInfo> | 是
| 程序启动作为入参的回调函数，返回应用程序信息。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------------------------------- | ---- | --------------------------------------- |
| bundleName | string | 是
| 要查询的应用程序包名称。
|
| bundleFlags | number | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 是
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。
|
| callback | AsyncCallback
\<
ApplicationInfo> | 是
| 程序启动作为入参的回调函数，返回应用程序信息。
|
**示例：**
...
...
@@ -120,11 +120,11 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------------------------------- | ---- | ---------------------------------------
---------------------
|
| bundleName | string | 是
| 要查询的应用程序包名称。
|
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| callback | AsyncCallback
\<
ApplicationInfo> | 是
| 程序启动作为入参的回调函数，返回应用程序信息。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------------------------------- | ---- | --------------------------------------- |
| bundleName | string | 是
| 要查询的应用程序包名称。
|
| bundleFlags | number | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| callback | AsyncCallback
\<
ApplicationInfo> | 是
| 程序启动作为入参的回调函数，返回应用程序信息。
|
**示例：**
...
...
@@ -157,15 +157,15 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ---------- | ---------- | ---- | ---------------------------------------
--------------------
|
| bundleFlag | BundleFlag | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 否
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。
|
| 名称
| 类型 | 必填 | 描述
|
| ---------- | ---------- | ---- | --------------------------------------- |
| bundleFlag | BundleFlag | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 否
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。
|
**返回值：**
| 类型
| 说明
|
| --------------------------- | --------------------------
---------
|
| 类型
| 说明
|
| --------------------------- | -------------------------- |
| Promise
<Array
\<
BundleInfo
>
> | Promise形式返回所有可用的BundleInfo |
**示例：**
...
...
@@ -199,10 +199,10 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ---------- | --------------------------------- | ---- | ---------------------------------------
---------------------
|
| bundleFlag | BundleFlag | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。
|
| callback | AsyncCallback
<Array
\<
BundleInfo
>
> | 是
| 程序启动作为入参的回调函数，返回所有可用的BundleInfo。
|
| 名称
| 类型 | 必填 | 描述
|
| ---------- | --------------------------------- | ---- | --------------------------------------- |
| bundleFlag | BundleFlag | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。
|
| callback | AsyncCallback
<Array
\<
BundleInfo
>
> | 是
| 程序启动作为入参的回调函数，返回所有可用的BundleInfo。
|
**示例：**
...
...
@@ -234,11 +234,11 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ---------- | --------------------------------- | ---- | ---------------------------------------
---------------------
|
| bundleFlag | BundleFlag | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。
|
| userId | number | 是
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。
|
| callback | AsyncCallback
<Array
\<
BundleInfo
>
> | 是
| 程序启动作为入参的回调函数，返回所有可用的BundleInfo。
|
| 名称
| 类型 | 必填 | 描述
|
| ---------- | --------------------------------- | ---- | --------------------------------------- |
| bundleFlag | BundleFlag | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。
|
| userId | number | 是
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。
|
| callback | AsyncCallback
<Array
\<
BundleInfo
>
> | 是
| 程序启动作为入参的回调函数，返回所有可用的BundleInfo。
|
**示例：**
...
...
@@ -272,16 +272,16 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------
| ---- | ---------------------
--------------------------------------- |
| bundleName | string
| 是 | 包名
|
| bundleFlags | number
| 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| options | BundleOptions
| 否 | 包含userid。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------
------- | ---- |
--------------------------------------- |
| bundleName | string
| 是 | 包名
|
| bundleFlags | number
| 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| options | BundleOptions
| 否 | 包含userid。
|
**返回值：**
| 类型
| 说明
|
| -------------------- | ----------------------------
--------------
|
| 类型
| 说明
|
| -------------------- | ---------------------------- |
| Promise
\<
BundleInfo> | 返回值为Promise对象，Promise中包含包信息。 |
**示例：**
...
...
@@ -318,11 +318,11 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | -------------------------- | ---- | ---------------------------------------
---------------------
|
| bundleName | string | 是
| 包名
|
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| callback | AsyncCallback
\<
BundleInfo> | 是
| 程序启动作为入参的回调函数，返回包信息。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | -------------------------- | ---- | --------------------------------------- |
| bundleName | string | 是
| 包名
|
| bundleFlags | number | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| callback | AsyncCallback
\<
BundleInfo> | 是
| 程序启动作为入参的回调函数，返回包信息。
|
**示例：**
...
...
@@ -355,12 +355,12 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | -------------------------- | ---- | ---------------------------------------
---------------------
|
| bundleName | string | 是
| 包名
|
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| options | BundleOptions | 是
| 包含userid。
|
| callback | AsyncCallback
\<
BundleInfo> | 是
| 程序启动作为入参的回调函数，返回包信息。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | -------------------------- | ---- | --------------------------------------- |
| bundleName | string | 是
| 包名
|
| bundleFlags | number | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| options | BundleOptions | 是
| 包含userid。
|
| callback | AsyncCallback
\<
BundleInfo> | 是
| 程序启动作为入参的回调函数，返回包信息。
|
**示例：**
...
...
@@ -396,15 +396,15 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------ | ---- | ---------------------------------------
---------------
|
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 否
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------ | ---- | --------------------------------------- |
| bundleFlags | number | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。 |
| userId | number | 否
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。
|
**返回值：**
| 类型
| 说明
|
| -------------------------------- | -------------------------------
-----------------
|
| 类型
| 说明
|
| -------------------------------- | ------------------------------- |
| Promise
<Array
\<
ApplicationInfo
>
> | 返回值为Promise对象，Promise中包含应用信息列表。 |
**示例：**
...
...
@@ -438,11 +438,11 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | -------------------------------------- | ---- | ---------------------------------------
---------------
|
| bundleFlags | number | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。
|
| userId | number | 否
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。
|
| callback | AsyncCallback
<Array
\<
ApplicationInfo
>
> | 是
| 程序启动作为入参的回调函数，返回应用信息列表。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | -------------------------------------- | ---- | --------------------------------------- |
| bundleFlags | number | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。
|
| userId | number | 否
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。
|
| callback | AsyncCallback
<Array
\<
ApplicationInfo
>
> | 是
| 程序启动作为入参的回调函数，返回应用信息列表。
|
**示例：**
...
...
@@ -475,10 +475,10 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | -------------------------------------- | ---- | ---------------------------------------
---------------
|
| bundleFlags | number | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。
|
| callback | AsyncCallback
<Array
\<
ApplicationInfo
>
> | 是
| 程序启动作为入参的回调函数，返回应用信息列表。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | -------------------------------------- | ---- | --------------------------------------- |
| bundleFlags | number | 是
| 用于指定返回的应用信息对象中包含信息的标记。默认值：0，取值范围：大于等于0。
|
| callback | AsyncCallback
<Array
\<
ApplicationInfo
>
> | 是
| 程序启动作为入参的回调函数，返回应用信息列表。
|
**示例：**
...
...
@@ -509,15 +509,15 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------ | ---- | ----------------
----------------------------------------
|
| bundleName | string
| 是 | 要查询的应用程序包名称。
|
| abilityName | string
| 是
| 表示待查询的Ability名称。 |
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------ | ---- | ---------------- |
| bundleName | string
| 是 | 要查询的应用程序包名称。
|
| abilityName | string
| 是
| 表示待查询的Ability名称。 |
**返回值：**
| 类型
| 说明
|
| ---------------------
------- | -------
--------------------- |
| 类型
| 说明
|
| ---------------------
|
--------------------- |
| Promise
\<
AbilityInfo> | Promise形式返回Ability信息。 |
**示例：**
...
...
@@ -550,11 +550,11 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------
| ---- | -------------------------------
-------------------------- |
| bundleName | string
| 是 | 要查询的应用程序包名称。
|
| abilityName | string
| 是 | 表示待查询的Ability名称。
|
| callback | AsyncCallback
\<
AbilityInfo> | 是
| 程序启动作为入参的回调函数，返回Ability信息。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------
--------------------- | ---- |
-------------------------- |
| bundleName | string
| 是 | 要查询的应用程序包名称。
|
| abilityName | string
| 是 | 表示待查询的Ability名称。
|
| callback | AsyncCallback
\<
AbilityInfo> | 是
| 程序启动作为入参的回调函数，返回Ability信息。
|
**示例：**
...
...
@@ -586,15 +586,15 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------ | ---- | ----------------
----------------------------------------
|
| bundleName | string
| 是 | 要查询的应用程序包名称。
|
| abilityName | string
| 是
| 表示待查询的Ability名称。 |
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------ | ---- | ---------------- |
| bundleName | string
| 是 | 要查询的应用程序包名称。
|
| abilityName | string
| 是
| 表示待查询的Ability名称。 |
**返回值：**
| 类型
| 说明
|
| ----------------
------------ | ----------
------------------ |
| 类型
| 说明
|
| ----------------
|
------------------ |
| Promise
\<
string> | Promise形式返回应用名称信息。 |
**示例：**
...
...
@@ -626,11 +626,11 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------
| ---- | -----------------------------------------
---------------- |
| bundleName | string
| 是 | 要查询的应用程序包名称。
|
| abilityName | string
| 是
| 表示待查询的Ability名称。 |
| callback
| AsyncCallback
\<
string> | 是 | 返回应用名称信息。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------
---------------- | ---- |
---------------- |
| bundleName | string
| 是 | 要查询的应用程序包名称。
|
| abilityName | string
| 是
| 表示待查询的Ability名称。 |
| callback
| AsyncCallback
\<
string> | 是 | 返回应用名称信息。
|
**示例：**
...
...
@@ -662,14 +662,14 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----
------- | ------ | ---- | ------------
|
| info
| AbilityInfo | 是 | Ability的配置信息
|
| 名称
| 类型 | 必填 | 描述
|
| ----
| ----------- | ---- | ------------
|
| info
| AbilityInfo | 是 | Ability的配置信息
|
**返回值：**
| 类型
| 说明
|
| -----------------
----------- | ------------------------
|
| 类型
| 说明
|
| -----------------
| -------------------------
|
| Promise
\<
boolean> | Promise形式返回boolean代表是否启用。 |
**示例：**
...
...
@@ -703,10 +703,10 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| --------
--- | ------ | ---- | ------------------------------------------
--------------- |
| info
| AbilityInfo | 是 | Ability的配置信息
|
| callback |
AsyncCallback
\<
boolean> | 是
| 返回boolean代表是否启用 |
| 名称
| 类型 | 必填 | 描述
|
| --------
| ----------------------- | ---- |
--------------- |
| info
| AbilityInfo | 是 | Ability的配置信息
|
| callback |
AsyncCallback
\<
boolean> | 是
| 返回boolean代表是否启用 |
**示例：**
...
...
@@ -740,14 +740,14 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------
- | ------ | ---- | --------------------------------------------
------------ |
| bundleName
| string | 是 | 要查询的应用程序包名称。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------
| ------ | ---- |
------------ |
| bundleName
| string | 是 | 要查询的应用程序包名称。
|
**返回值：**
| 类型
| 说明
|
| -----------------
----------- | ------------------------
|
| 类型
| 说明
|
| -----------------
| -------------------------
|
| Promise
\<
boolean> | Promise形式返回boolean代表是否启用。 |
**示例：**
...
...
@@ -778,15 +778,15 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------
- | ------ | ---- | ------------------------------------------
--------------- |
| bundleName
| string | 是 | 要查询的应用程序包名称。
|
| callback
| AsyncCallback
\<
boolean> | 是
| 返回boolean代表是否启用 |
| 名称
| 类型 | 必填 | 描述
|
| ----------
| ----------------------- | ---- |
--------------- |
| bundleName
| string | 是 | 要查询的应用程序包名称。
|
| callback
| AsyncCallback
\<
boolean> | 是
| 返回boolean代表是否启用 |
**示例：**
```
js
let
bundleName
:
"
com.example.myapplication
"
;
let
bundleName
=
"
com.example.myapplication
"
;
bundle
.
isApplicationEnabled
(
bundleName
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Operation failed. Cause:
'
+
JSON
.
stringify
(
err
));
...
...
@@ -812,16 +812,16 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------ | ---- | -------------------------------------
-----------------------
|
| want | Want | 是
| 包含要查询的应用程序包名称的意图。
|
| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 |
| userId | number | 否
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ------ | ---- | ------------------------------------- |
| want | Want | 是
| 包含要查询的应用程序包名称的意图。
|
| bundleFlags | number | 是
| 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 |
| userId | number | 否
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0
|
**返回值：**
| 类型
| 说明
|
| ---------------------------- | ---------------------
-------
|
| 类型
| 说明
|
| ---------------------------- | --------------------- |
| Promise
<Array
\<
AbilityInfo
>
> | Promise形式返回Ability信息。 |
**示例：**
...
...
@@ -855,12 +855,12 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ---------------------------------- | ---- | -------------------------------------
-----------------------
|
| want | Want | 是
| 指示包含要查询的应用程序包名称的意图。
|
| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 |
| userId | number | 是
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0
|
| callback | AsyncCallback
<Array
\<
AbilityInfo
>
> | 是
| 程序启动作为入参的回调函数，返回Ability信息。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ---------------------------------- | ---- | ------------------------------------- |
| want | Want | 是
| 指示包含要查询的应用程序包名称的意图。
|
| bundleFlags | number | 是
| 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 |
| userId | number | 是
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0
|
| callback | AsyncCallback
<Array
\<
AbilityInfo
>
> | 是
| 程序启动作为入参的回调函数，返回Ability信息。
|
**示例：**
...
...
@@ -892,11 +892,11 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ---------------------------------- | ---- | -------------------------------------
-----------------------
|
| want | Want | 是
| 指示包含要查询的应用程序包名称的意图。
|
| bundleFlags | number | 是 | 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 |
| callback | AsyncCallback
<Array
\<
AbilityInfo
>
> | 是
| 程序启动作为入参的回调函数，返回Ability信息。
|
| 名称
| 类型 | 必填 | 描述
|
| ----------- | ---------------------------------- | ---- | ------------------------------------- |
| want | Want | 是
| 指示包含要查询的应用程序包名称的意图。
|
| bundleFlags | number | 是
| 用于指定返回abilityInfo信息。默认值：0，取值范围：大于等于0。 |
| callback | AsyncCallback
<Array
\<
AbilityInfo
>
> | 是
| 程序启动作为入参的回调函数，返回Ability信息。
|
**示例：**
...
...
@@ -931,8 +931,8 @@ SystemCapability.BundleManager.BundleFramework
**返回值：**
| 类型
| 说明
|
| ------------------------
| -----------
---------------------------------------- |
| 类型
| 说明
|
| ------------------------
- |
---------------------------------------- |
| Promise
\<
BundleInstaller> | 返回值为Promise对象，Promise中包含BundleInstaller。 |
**示例：**
...
...
@@ -974,9 +974,9 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| -------- | ------------------------------
| ---- | -----------------
-------------------------------- |
| callback | AsyncCallback
\<
BundleInstaller> | 是 | 程序启动作为入参的回调函数，返回BundleInstaller。 |
| 名称
| 类型 | 必填 | 描述
|
| -------- | ------------------------------
- | ---- |
-------------------------------- |
| callback | AsyncCallback
\<
BundleInstaller> | 是
| 程序启动作为入参的回调函数，返回BundleInstaller。 |
**示例：**
...
...
@@ -1018,13 +1018,13 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ---------- | ------ | ---- | -------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 |
| 名称
| 类型 | 必填 | 描述
|
| ---------- | ------ | ---- | --------
----
|
| bundleName | string | 是
| 要查询的应用程序包名称。 |
**返回值：**
| 类型
| 说明
|
| --------------
------- | ----------------------
-------------------------------------- |
| 类型
| 说明
|
| --------------
|
-------------------------------------- |
| Promise
\<
Want> | 返回值为Promise对象，Promise中包含拉起指定应用的Want对象。 |
**示例：**
...
...
@@ -1055,10 +1055,10 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ---------- | ------
| ---- |
-------- |
| bundleName | string
| 是 | 要查询的应用程序包名称。
|
| callback | AsyncCallback
\<
Want> | 是 | 程序启动作为入参的回调函数，返回拉起指定应用的want对象。 |
| 名称
| 类型 | 必填 | 描述
|
| ---------- | ------
-------------- | ---- | ----------------------
-------- |
| bundleName | string
| 是 | 要查询的应用程序包名称。
|
| callback | AsyncCallback
\<
Want> | 是
| 程序启动作为入参的回调函数，返回拉起指定应用的want对象。 |
**示例：**
...
...
@@ -1086,13 +1086,13 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----
------
| ------ | ---- | -------- |
| uid
| number | 是
| 要查询的uid。 |
| 名称
| 类型 | 必填 | 描述
|
| ---- | ------ | ---- | -------- |
| uid
| number | 是
| 要查询的uid。 |
**返回值：**
| 类型
| 说明
|
| ----------------
----- | ---------------------------
--------------------------------- |
| 类型
| 说明
|
| ----------------
|
--------------------------------- |
| Promise
\<
string> | 返回值为Promise对象，Promise中包含指定uid的包名。 |
**示例：**
...
...
@@ -1119,10 +1119,10 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称 | 类型
| 必填 | 描述
|
| --------
-- | ------ | ---- |
-------- |
| uid
| number | 是 | 要查询的uid。
|
| callback
| AsyncCallback
\<
string> | 是
| 程序启动作为入参的回调函数，返回指定uid的包名。 |
| 名称 | 类型
| 必填 | 描述
|
| --------
| ---------------------- | ---- | -----------------
-------- |
| uid
| number | 是 | 要查询的uid。
|
| callback
| AsyncCallback
\<
string> | 是
| 程序启动作为入参的回调函数，返回指定uid的包名。 |
**示例：**
...
...
@@ -1154,14 +1154,14 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------
| ------ | ---- |
-------- |
| bundleName
| string | 是 | 要查询的bundleName。
|
| abilityName | string | 是 | 要查询的abilityName。 |
| 名称
| 类型 | 必填 | 描述
|
| ----------
- | ------ | ---- | --------
-------- |
| bundleName
| string | 是 | 要查询的bundleName。
|
| 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
)
>
。 |
**示例：**
...
...
@@ -1193,11 +1193,11 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----------
| ------ | ---- |
-------- |
| bundleName
| string | 是 | 要查询的bundleName。
|
| 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
)
>
。 |
| 名称
| 类型 | 必填 | 描述
|
| ----------
- | ---------------------------------------- | ---- | --------------------------------
-------- |
| bundleName
| string | 是 | 要查询的bundleName。
|
| 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
)
>
。 |
**示例：**
...
...
@@ -1230,16 +1230,16 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| -----------
| ------ | ---- | --------------------
---------------------------------------- |
| want
| Want | 是 | 包含要查询的应用程序包名称的意图。
|
| extensionFlags | number | 是 | 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：大于等于0。 |
| userId
| number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0
|
| 名称
| 类型 | 必填 | 描述
|
| -----------
--- | ------ | ---- |
---------------------------------------- |
| want
| Want | 是 | 包含要查询的应用程序包名称的意图。
|
| extensionFlags | number | 是
| 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：大于等于0。 |
| userId
| number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0
|
**返回值：**
| 类型
| 说明
|
| ----------------------------
|
---------------------------- |
| 类型
| 说明
|
| ----------------------------
--------- | --
---------------------------- |
| Promise
<Array
\<
ExtensionAbilityInfo
>
> | Promise形式返回ExtensionAbility信息。 |
**示例：**
...
...
@@ -1277,12 +1277,12 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| -----------
| ---------------------------------- | ---- | --------------------
---------------------------------------- |
| want
| Want | 是 | 指示包含要查询的应用程序包名称的意图。
|
| extensionFlags | number
| 是
| 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：枚举值，大于等于0。 |
| userId
| number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0
|
| callback
| AsyncCallback
<Array
\<
ExtensionAbilityInfo
>
> | 是 | 程序启动作为入参的回调函数，返回ExtensionAbility信息。
|
| 名称
| 类型 | 必填 | 描述
|
| -----------
--- | ---------------------------------------- | ---- |
---------------------------------------- |
| want
| Want | 是 | 指示包含要查询的应用程序包名称的意图。
|
| extensionFlags | number
| 是
| 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：枚举值，大于等于0。 |
| userId
| number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0
|
| callback
| AsyncCallback
<Array
\<
ExtensionAbilityInfo
>
> | 是 | 程序启动作为入参的回调函数，返回ExtensionAbility信息。
|
**示例：**
...
...
@@ -1318,11 +1318,11 @@ SystemCapability.BundleManager.BundleFramework
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| -----------
| ---------------------------------- | ---- | --------------------
---------------------------------------- |
| want
| Want | 是 | 指示包含要查询的应用程序包名称的意图。
|
| extensionFlags | number
| 是
| 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：大于等于0。 |
| callback
| AsyncCallback
<Array
\<
ExtensionAbilityInfo
>
> | 是 | 程序启动作为入参的回调函数，返回ExtensionAbility信息。
|
| 名称
| 类型 | 必填 | 描述
|
| -----------
--- | ---------------------------------------- | ---- |
---------------------------------------- |
| want
| Want | 是 | 指示包含要查询的应用程序包名称的意图。
|
| extensionFlags | number
| 是
| 用于指定返回ExtensionAbilityInfo信息。默认值：0，取值范围：大于等于0。 |
| callback
| AsyncCallback
<Array
\<
ExtensionAbilityInfo
>
> | 是 | 程序启动作为入参的回调函数，返回ExtensionAbility信息。
|
**示例：**
...
...
@@ -1345,40 +1345,40 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 读写属性 | 类型 | 必填 | 描述
|
| ----------- | ----
---- | ------ | ---- | --------------------
---------------------------------------- |
| deviceId | 只读
| string | 否 | 表示运行指定Ability的设备ID。
|
| bundleName | 只读
| string | 是
| 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读
| string | 是
| 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| uri
| 只读 | string | 否 | 资源标识符。
|
| shortName
| 只读 | string | 否 | ElementName的简名。
|
| 名称
| 读写属性 | 类型 | 必填 | 描述
|
| ----------- | ----
| ------ | ---- |
---------------------------------------- |
| deviceId | 只读
| string | 否 | 表示运行指定Ability的设备ID。
|
| bundleName | 只读
| string | 是
| 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读
| string | 是
| 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| uri
| 只读 | string | 否 | 资源标识符。
|
| shortName
| 只读 | string | 否 | ElementName的简名。
|
## InstallErrorCode
**系统能力:**
SystemCapability.BundleManager.BundleFramework
| 名称
| 默认值 | 说明
|
| ------
| ------ |
------ |
| SUCCESS
| 0 | 安装成功
|
| STATUS_INSTALL_FAILURE
| 1 | 安装失败（不存在安装的应用）
|
| STATUS_INSTALL_FAILURE_ABORTED
| 2 | 安装中止
|
| STATUS_INSTALL_FAILURE_INVALID
| 3 | 安装参数无效
|
| STATUS_INSTALL_FAILURE_CONFLICT
| 4 | 安装冲突 （常见于升级和已有应用基本信息不一致）
|
| STATUS_INSTALL_FAILURE_STORAGE
| 5 | 存储包信息失败
|
| STATUS_INSTALL_FAILURE_INCOMPATIBLE
| 6 | 安装不兼容（常见于版本降级安装或者签名信息错误）
|
| STATUS_UNINSTALL_FAILURE
| 7 | 卸载失败 （不存在卸载的应用）
|
| STATUS_UNINSTALL_FAILURE_BLOCKED
| 8 | 卸载中止 （没有使用）
|
| STATUS_UNINSTALL_FAILURE_ABORTED
| 9 | 卸载中止 （参数无效导致）
|
| STATUS_UNINSTALL_FAILURE_CONFLICT
| 10
| 卸载冲突 （卸载系统应用失败， 结束应用进程失败） |
| STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT
| 0x0B | 安装失败 （下载超时）
|
| STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED
| 0x0C | 安装失败 （下载失败）
|
| STATUS_RECOVER_FAILURE_INVALID
<sup>
8+
</sup>
| 0x0D | 恢复预置应用失败 |
| STATUS_ABILITY_NOT_FOUND
| 0x40 | Ability未找到
|
| STATUS_BMS_SERVICE_ERROR
| 0x41 | BMS服务错误
|
| STATUS_FAILED_NO_SPACE_LEFT
<sup>
8+
</sup>
| 0x42 | 设备空间不足 |
| STATUS_GRANT_REQUEST_PERMISSIONS_FAILED
<sup>
8+
</sup>
| 0x43 | 应用授权失败 |
| STATUS_INSTALL_PERMISSION_DENIED
<sup>
8+
</sup>
| 0x44 | 安装权限拒绝 |
| STATUS_UNINSTALL_PERMISSION_DENIED
<sup>
8+
</sup>
| 0x45 | 卸载权限拒绝 |
| 名称
| 默认值 | 说明
|
| ------
---------------------------------- | ---- | -------------------
------ |
| SUCCESS
| 0 | 安装成功
|
| STATUS_INSTALL_FAILURE
| 1 | 安装失败（不存在安装的应用）
|
| STATUS_INSTALL_FAILURE_ABORTED
| 2 | 安装中止
|
| STATUS_INSTALL_FAILURE_INVALID
| 3 | 安装参数无效
|
| STATUS_INSTALL_FAILURE_CONFLICT
| 4 | 安装冲突 （常见于升级和已有应用基本信息不一致）
|
| STATUS_INSTALL_FAILURE_STORAGE
| 5 | 存储包信息失败
|
| STATUS_INSTALL_FAILURE_INCOMPATIBLE
| 6 | 安装不兼容（常见于版本降级安装或者签名信息错误）
|
| STATUS_UNINSTALL_FAILURE
| 7 | 卸载失败 （不存在卸载的应用）
|
| STATUS_UNINSTALL_FAILURE_BLOCKED
| 8 | 卸载中止 （没有使用）
|
| STATUS_UNINSTALL_FAILURE_ABORTED
| 9 | 卸载中止 （参数无效导致）
|
| STATUS_UNINSTALL_FAILURE_CONFLICT
| 10
| 卸载冲突 （卸载系统应用失败， 结束应用进程失败） |
| STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT
| 0x0B | 安装失败 （下载超时）
|
| STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED
| 0x0C | 安装失败 （下载失败）
|
| STATUS_RECOVER_FAILURE_INVALID
<sup>
8+
</sup>
| 0x0D | 恢复预置应用失败
|
| STATUS_ABILITY_NOT_FOUND
| 0x40 | Ability未找到
|
| STATUS_BMS_SERVICE_ERROR
| 0x41 | BMS服务错误
|
| STATUS_FAILED_NO_SPACE_LEFT
<sup>
8+
</sup>
| 0x42 | 设备空间不足
|
| STATUS_GRANT_REQUEST_PERMISSIONS_FAILED
<sup>
8+
</sup>
| 0x43 | 应用授权失败
|
| STATUS_INSTALL_PERMISSION_DENIED
<sup>
8+
</sup>
| 0x44 | 安装权限拒绝
|
| STATUS_UNINSTALL_PERMISSION_DENIED
<sup>
8+
</sup>
| 0x45 | 卸载权限拒绝
|
## BundleFlag
...
...
@@ -1386,21 +1386,21 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 默认值 | 说明
|
| ------
| ------ |
------ |
| GET_BUNDLE_DEFAULT
| 0x00000000 | 获取默认的应用信息
|
| GET_BUNDLE_WITH_ABILITIES
| 0x00000001 | 获取包括Ability信息的包信息
|
| GET_ABILITY_INFO_WITH_PERMISSION
| 0x00000002 | 获取包括权限的Ability信息
|
| GET_ABILITY_INFO_WITH_APPLICATION
| 0x00000004 | 获取包括应用的Ability信息
|
| GET_APPLICATION_INFO_WITH_PERMISSION
| 0x00000008 | 获取包括权限的应用信息
|
| GET_BUNDLE_WITH_REQUESTED_PERMISSION
| 0x00000010 | 获取包括所需权限的包信息
|
| GET_ABILITY_INFO_WITH_METADATA
<sup>
8+
</sup>
| 0x00000020 | 获取ability的元数据信息 |
| 名称
| 默认值 | 说明
|
| ------
---------------------------------- | ---------- | -------------
------ |
| GET_BUNDLE_DEFAULT
| 0x00000000 | 获取默认的应用信息
|
| GET_BUNDLE_WITH_ABILITIES
| 0x00000001 | 获取包括Ability信息的包信息
|
| GET_ABILITY_INFO_WITH_PERMISSION
| 0x00000002 | 获取包括权限的Ability信息
|
| GET_ABILITY_INFO_WITH_APPLICATION
| 0x00000004 | 获取包括应用的Ability信息
|
| GET_APPLICATION_INFO_WITH_PERMISSION
| 0x00000008 | 获取包括权限的应用信息
|
| GET_BUNDLE_WITH_REQUESTED_PERMISSION
| 0x00000010 | 获取包括所需权限的包信息
|
| GET_ABILITY_INFO_WITH_METADATA
<sup>
8+
</sup>
| 0x00000020 | 获取ability的元数据信息
|
| GET_BUNDLE_WITH_EXTENSION_ABILITY
<sup>
9+
</sup>
| 0x00000020 | 获取包括Ability信息的扩展包信息 |
| GET_APPLICATION_INFO_WITH_METADATA
<sup>
8+
</sup>
| 0x00000040 | 获取应用的元数据信息 |
| GET_APPLICATION_INFO_WITH_METADATA
<sup>
8+
</sup>
| 0x00000040 | 获取应用的元数据信息
|
| GET_ABILITY_INFO_SYSTEMAPP_ONLY
<sup>
8+
</sup>
| 0x00000080 | 获取仅包括系统应用的ability信息 |
| GET_ABILITY_INFO_WITH_DISABLE
<sup>
8+
</sup>
| 0x00000100 | 获取包括被禁用的ability信息 |
| GET_APPLICATION_INFO_WITH_DISABLE
<sup>
8+
</sup>
| 0x00000200 | 获取包括被禁用的应用信息 |
| GET_ALL_APPLICATION_INFO
| 0xFFFF0000 | 获取应用所有的信息
|
| GET_ABILITY_INFO_WITH_DISABLE
<sup>
8+
</sup>
| 0x00000100 | 获取包括被禁用的ability信息
|
| GET_APPLICATION_INFO_WITH_DISABLE
<sup>
8+
</sup>
| 0x00000200 | 获取包括被禁用的应用信息
|
| GET_ALL_APPLICATION_INFO
| 0xFFFF0000 | 获取应用所有的信息
|
## BundleOptions
...
...
@@ -1408,9 +1408,9 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:**
SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------ | ------ | ----
-- | ------ |
------ |
| userId | number | 是
| 是
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------ | ------ | ----
| ---- | ----------------------
------ |
| userId | number | 是
| 是
| 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
## BundleInfo
...
...
@@ -1418,32 +1418,32 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
| ------ | ------ | ------ |
------ |
| name
| string | 是 | 否 | 应用包的名称
|
| type
| string | 是 | 否 | 应用包类型
|
| appId
| string | 是 | 否 | 应用包里应用程序的id
|
| uid
| number | 是 | 否 | 应用包里应用程序的uid
|
| installTime
| number | 是 | 否 | HAP包安装时间
|
| updateTime
| number | 是 | 否 | HAP包更新时间
|
| appInfo
| ApplicationInfo | 是 | 否 | 应用程序的配置信息
|
| abilityInfos
| Array
\<
AbilityInfo> | 是 | 否 | Ability的配置信息
|
| reqPermissions
| Array
\<
string> | 是 | 否 | 应用运行时需向系统申请的权限集合
|
| reqPermissionDetails
| Array
\<
ReqPermissionDetail> | 是 | 否
| 应用运行时需向系统申请的权限集合的详细信息 |
| vendor
| string | 是 | 否 | 应用包的供应商
|
| versionCode
| number | 是 | 否 | 应用包的版本号
|
| versionName
| string | 是 | 否 | 应用包的版本文本描述信息
|
| compatibleVersion
| number | 是 | 否 | 运行应用包所需要最低的SDK版本号
|
| targetVersion
| number | 是 | 否 | 运行应用包所需要最高SDK版本号
|
| isCompressNativeLibs
| boolean | 是 | 否 | 是否压缩应用包的本地库，默认为true
|
| hapModuleInfos
| Array
\<
HapModuleInfo> | 是 | 否 | 模块的配置信息
|
| entryModuleName
| string | 是 | 否 | Entry的模块名称
|
| cpuAbi
| string | 是 | 否 | 应用包的cpuAbi信息
|
| isSilentInstallation
| string | 是 | 否 | 是否通过静默安装
|
| minCompatibleVersionCode
| number | 是 | 否 | 分布式场景下的应用包兼容的最低版本
|
| entryInstallationFree
| boolean | 是 | 否 | Entry是否支持免安装
|
| reqPermissionStates
<sup>
8+
</sup>
| Array
\<
number> | 是 | 否 | 申请权限的授予状态
|
| extensionAbilityInfo
<sup>
9+
</sup>
| Array
\<
ExtensionAbilityInfo> | 是
| 否 | ability的可扩展信息
|
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
--------------------------- | ---------------------------- | ---- | ---- | ---------------
------ |
| name
| string | 是 | 否 | 应用包的名称
|
| type
| string | 是 | 否 | 应用包类型
|
| appId
| string | 是 | 否 | 应用包里应用程序的id
|
| uid
| number | 是 | 否 | 应用包里应用程序的uid
|
| installTime
| number | 是 | 否 | HAP包安装时间
|
| updateTime
| number | 是 | 否 | HAP包更新时间
|
| appInfo
| ApplicationInfo | 是 | 否 | 应用程序的配置信息
|
| abilityInfos
| Array
\<
AbilityInfo> | 是 | 否 | Ability的配置信息
|
| reqPermissions
| Array
\<
string> | 是 | 否 | 应用运行时需向系统申请的权限集合
|
| reqPermissionDetails
| Array
\<
ReqPermissionDetail> | 是 | 否
| 应用运行时需向系统申请的权限集合的详细信息 |
| vendor
| string | 是 | 否 | 应用包的供应商
|
| versionCode
| number | 是 | 否 | 应用包的版本号
|
| versionName
| string | 是 | 否 | 应用包的版本文本描述信息
|
| compatibleVersion
| number | 是 | 否 | 运行应用包所需要最低的SDK版本号
|
| targetVersion
| number | 是 | 否 | 运行应用包所需要最高SDK版本号
|
| isCompressNativeLibs
| boolean | 是 | 否 | 是否压缩应用包的本地库，默认为true
|
| hapModuleInfos
| Array
\<
HapModuleInfo> | 是 | 否 | 模块的配置信息
|
| entryModuleName
| string | 是 | 否 | Entry的模块名称
|
| cpuAbi
| string | 是 | 否 | 应用包的cpuAbi信息
|
| isSilentInstallation
| string | 是 | 否 | 是否通过静默安装
|
| minCompatibleVersionCode
| number | 是 | 否 | 分布式场景下的应用包兼容的最低版本
|
| entryInstallationFree
| boolean | 是 | 否 | Entry是否支持免安装
|
| reqPermissionStates
<sup>
8+
</sup>
| Array
\<
number> | 是 | 否 | 申请权限的授予状态
|
| extensionAbilityInfo
<sup>
9+
</sup>
| Array
\<
ExtensionAbilityInfo> | 是
| 否 | ability的可扩展信息
|
## ApplicationInfo
...
...
@@ -1451,31 +1451,31 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
| ------ | ------ | ------ |
------ |
| name
| string | 是 | 否 | 应用程序的名称
|
| description
| string | 是 | 否 | 应用程序的描述
|
| descriptionId
| number | 是 | 否 | 应用程序的描述id
|
| systemApp
| boolean | 是 | 否 | 判断是否为系统应用程序，默认为false
|
| enabled
| boolean | 是 | 否 | 判断应用程序是否可以使用，默认为true
|
| label
| string | 是 | 否 | 应用程序的标签
|
| labelId
| string | 是 | 否 | 应用程序的标签id
|
| icon
| string | 是 | 否 | 应用程序的图标
|
| iconId
| string | 是 | 否 | 应用程序的图标id
|
| process
| string | 是 | 否
| 应用程序的进程，如果不设置，默认为包的名称 |
| supportedModes
| number | 是 | 否 | 应用程序支持的运行模式
|
| moduleSourceDirs
| Array
\<
string> | 是 | 否 | 应用程序的资源存放的相对路径
|
| permissions
| Array
\<
string> | 是 | 否 | 访问应用程序所需的权限
|
| moduleInfos
| Array
\<
ModuleInfo> | 是 | 否 | 应用程序的模块信息
|
| entryDir
| string | 是 | 否 | 应用程序的文件保存路径
|
| customizeData
| Map
<string
,
Array
\<
CustomizeData
>
> | 是 | 是 | 应用程序的自定义数据
|
| codePath
<sup>
8+
</sup>
| string | 是 | 否 | 应用程序的安装目录
|
| metaData
<sup>
8+
</sup>
| Map
<string
,
Array
\<
CustomizeData
>
> | 是 | 否 | 应用程序的自定义元信息
|
| metaData
<sup>
9+
</sup>
| Map
<string
,
Array
\<
Metadata
>
> | 是 | 否 | 应用程序的元信息
|
| removable
<sup>
8+
</sup>
| boolean | 是 | 否 | 应用程序是否可以被移除
|
| accessTokenId
<sup>
8+
</sup>
| number
| 是 | 否 | 应用程序的accessTokenId
|
| uid
<sup>
8+
</sup>
| number | 是 | 否 | 应用程序的uid
|
| entityType
<sup>
9+
</sup>
| string | 是 | 否 | 应用程序的实体类型
|
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
-------------------- | ---------------------------------- | ---- | ---- | ---------------
------ |
| name
| string | 是 | 否 | 应用程序的名称
|
| description
| string | 是 | 否 | 应用程序的描述
|
| descriptionId
| number | 是 | 否 | 应用程序的描述id
|
| systemApp
| boolean | 是 | 否 | 判断是否为系统应用程序，默认为false
|
| enabled
| boolean | 是 | 否 | 判断应用程序是否可以使用，默认为true
|
| label
| string | 是 | 否 | 应用程序的标签
|
| labelId
| string | 是 | 否 | 应用程序的标签id
|
| icon
| string | 是 | 否 | 应用程序的图标
|
| iconId
| string | 是 | 否 | 应用程序的图标id
|
| process
| string | 是 | 否
| 应用程序的进程，如果不设置，默认为包的名称 |
| supportedModes
| number | 是 | 否 | 应用程序支持的运行模式
|
| moduleSourceDirs
| Array
\<
string> | 是 | 否 | 应用程序的资源存放的相对路径
|
| permissions
| Array
\<
string> | 是 | 否 | 访问应用程序所需的权限
|
| moduleInfos
| Array
\<
ModuleInfo> | 是 | 否 | 应用程序的模块信息
|
| entryDir
| string | 是 | 否 | 应用程序的文件保存路径
|
| customizeData
| Map
<string
,
Array
\<
CustomizeData
>
> | 是 | 是 | 应用程序的自定义数据
|
| codePath
<sup>
8+
</sup>
| string | 是 | 否 | 应用程序的安装目录
|
| metaData
<sup>
8+
</sup>
| Map
<string
,
Array
\<
CustomizeData
>
> | 是 | 否 | 应用程序的自定义元信息
|
| metaData
<sup>
9+
</sup>
| Map
<string
,
Array
\<
Metadata
>
> | 是 | 否 | 应用程序的元信息
|
| removable
<sup>
8+
</sup>
| boolean | 是 | 否 | 应用程序是否可以被移除
|
| accessTokenId
<sup>
8+
</sup>
| number
| 是 | 否 | 应用程序的accessTokenId
|
| uid
<sup>
8+
</sup>
| number | 是 | 否 | 应用程序的uid
|
| entityType
<sup>
9+
</sup>
| string | 是 | 否 | 应用程序的实体类型
|
## ModuleInfo
...
...
@@ -1483,10 +1483,10 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
| ------ | ------ | ------ | --
---- |
| moduleName | string | 是
| 否
| 模块名称 |
| moduleSourceDir | string | 是
| 否
| 安装目录 |
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
--------- | ------ | ---- | ---- |
---- |
| moduleName | string | 是
| 否
| 模块名称 |
| moduleSourceDir | string | 是
| 否
| 安装目录 |
## CustomizeData
...
...
@@ -1494,11 +1494,11 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 可读 | 可写 | 说明
|
| -----
| ------ | ---- | ---- | --------
-------- |
| name
| string | 是 | 是
| 自定义元数据名称 |
| value
| string | 是 | 是 | 自定义元数据值
|
| extra
<sup>
8+
</sup>
| string | 是
| 是 | 自定义资源
|
| 名称
| 类型 | 可读 | 可写 | 说明
|
| -----
------------- | ------ | ---- | ---- |
-------- |
| name
| string | 是 | 是
| 自定义元数据名称 |
| value
| string | 是 | 是 | 自定义元数据值
|
| extra
<sup>
8+
</sup>
| string | 是
| 是 | 自定义资源
|
## HapModuleInfo
...
...
@@ -1507,26 +1507,26 @@ Hap模块信息
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
| ------ | ------ | ------ |
------ |
| name
| string | 是 | 否 | 模块名称
|
| description
| string | 是 | 否 | 模块描述信息
|
| descriptionId
| number | 是 | 否 | 描述信息ID
|
| icon
| string | 是 | 否 | 模块图标
|
| label
| string | 是 | 否 | 模块标签
|
| labelId
| number | 是 | 否 | 模块标签ID
|
| iconId
| number | 是 | 否 | 模块图标ID
|
| backgroundImg
| string | 是 | 否 | 模块背景图片
|
| supportedModes
| number | 是 | 否 | 模块支持的模式
|
| reqCapabilities
| Array
\<
string> | 是 | 否 | 模块运行需要的能力
|
| deviceTypes
| Array
\<
string> | 是 | 否 | 支持运行的设备类型
|
| abilityInfo
| Array
\<
AbilityInfo> | 是 | 否 | Ability信息
|
| moduleName
| string | 是 | 否 | 模块名
|
| mainAbilityName
| string | 是 | 否 | 入口Ability名称
|
| installationFree
| boolean | 是 | 否 | 是否支持免安装
|
| mainElementName
<sup>
8+
</sup>
| string | 是 | 否 | 入口ability信息
|
| extensionAbilityInfo
<sup>
9+
</sup>
| Array
\<
ExtensionAbilityInfo> | 是
| 否
| extensionAbility信息 |
| metadata
<sup>
9+
</sup>
| Array
\<
Metadata> | 是 | 否 | Ability的元信息
|
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
--------------------------- | ---------------------------- | ---- | ---- | ------------
------ |
| name
| string | 是 | 否 | 模块名称
|
| description
| string | 是 | 否 | 模块描述信息
|
| descriptionId
| number | 是 | 否 | 描述信息ID
|
| icon
| string | 是 | 否 | 模块图标
|
| label
| string | 是 | 否 | 模块标签
|
| labelId
| number | 是 | 否 | 模块标签ID
|
| iconId
| number | 是 | 否 | 模块图标ID
|
| backgroundImg
| string | 是 | 否 | 模块背景图片
|
| supportedModes
| number | 是 | 否 | 模块支持的模式
|
| reqCapabilities
| Array
\<
string> | 是 | 否 | 模块运行需要的能力
|
| deviceTypes
| Array
\<
string> | 是 | 否 | 支持运行的设备类型
|
| abilityInfo
| Array
\<
AbilityInfo> | 是 | 否 | Ability信息
|
| moduleName
| string | 是 | 否 | 模块名
|
| mainAbilityName
| string | 是 | 否 | 入口Ability名称
|
| installationFree
| boolean | 是 | 否 | 是否支持免安装
|
| mainElementName
<sup>
8+
</sup>
| string | 是 | 否 | 入口ability信息
|
| extensionAbilityInfo
<sup>
9+
</sup>
| Array
\<
ExtensionAbilityInfo> | 是
| 否
| extensionAbility信息 |
| metadata
<sup>
9+
</sup>
| Array
\<
Metadata> | 是 | 否 | Ability的元信息
|
## ReqPermissionDetail
...
...
@@ -1534,11 +1534,11 @@ Hap模块信息
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
| ------ | ------ | ------ |
------ |
| name | string | 是
| 是 | 需要使用的权限名称
|
| reason | string | 是
| 是 | 描述申请权限的原因
|
| usedScene | UsedScene | 是
| 是
| 权限使用的场景和时机 |
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
--- | --------- | ---- | ---- | ----
------ |
| name | string | 是
| 是 | 需要使用的权限名称
|
| reason | string | 是
| 是 | 描述申请权限的原因
|
| usedScene | UsedScene | 是
| 是
| 权限使用的场景和时机 |
## UsedScene
...
...
@@ -1546,10 +1546,10 @@ Hap模块信息
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
| ------ | ------ | ------ |
------ |
| abilities | Array
\<
string> | 是
| 是
| 使用到该权限的Ability集合 |
| when | string
| 是 | 是 | 使用该权限的时机
|
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
--- | -------------- | ---- | ---- | ----------
------ |
| abilities | Array
\<
string> | 是
| 是
| 使用到该权限的Ability集合 |
| when | string
| 是 | 是 | 使用该权限的时机
|
## AbilityInfo
...
...
@@ -1558,36 +1558,36 @@ Ability信息
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
| ------ | ------ | ------ |
------ |
| bundleName
| string | 是 | 否 | 应用包名
|
| name
| string | 是 | 否 | Ability名称
|
| label
| string | 是 | 否 | Ability对用户显示的名称
|
| description
| string | 是 | 否 | Ability的描述
|
| icon
| string | 是 | 否 | Ability的图标资源文件索引
|
| descriptionId
| number | 是 | 否 | Ability的描述id
|
| iconId
| number | 是 | 否 | Ability的图标id
|
| moduleName
| string | 是 | 否 | Ability所属的HAP包的名称
|
| process
| string | 是 | 否
| Ability的进程，如果不设置，默认为包的名称 |
| targetAbility
| string | 是 | 否 | 当前Ability重用的目标Ability
|
| backgroundModes
| number | 是 | 否 | 表示后台服务的类型
|
| isVisible
| boolean | 是 | 否 | 判断Ability是否可以被其他应用调用
|
| formEnabled
| boolean | 是 | 否 | 判断Ability是否提供卡片能力
|
| type
| AbilityType | 是 | 否 | Ability类型
|
| orientation
| DisplayOrientation | 是 | 否 | Ability的显示模式
|
| launchMode
| LaunchMode | 是 | 否 | Ability的启动模式
|
| permissions
| Array
\<
string> | 是 | 否
| 被其他应用Ability调用时需要申请的权限集合 |
| deviceTypes
| Array
\<
string> | 是 | 否 | Ability支持的设备类型
|
| deviceCapabilities
| Array
\<
string> | 是 | 否 | Ability需要的设备能力
|
| readPermission
| string | 是 | 否 | 读取Ability数据所需的权限
|
| writePermission
| string | 是 | 否 | 向Ability写数据所需的权限
|
| applicationInfo
| ApplicationInfo | 是 | 否 | 应用程序的配置信息
|
| uri
| string | 是 | 否 | 获取Ability的统一资源标识符（URI）
|
| labelId
| number | 是 | 否 | Ability的标签id
|
| subType
| AbilitySubType | 是 | 否 | Ability中枚举使用的模板的子类型
|
| metaData
<sup>
8+
</sup>
| Array
\<
CustomizeData> | 是
| 否 | ability的自定义信息
|
| metaData
<sup>
9+
</sup>
| Array
\<
Metadata>
| 是 | 否 | ability的元信息
|
| enabled
<sup>
8+
</sup>
| boolean | 是 | 否 | ability是否可用
|
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
--------------- | --------------------- | ---- | ---- | ------------------
------ |
| bundleName
| string | 是 | 否 | 应用包名
|
| name
| string | 是 | 否 | Ability名称
|
| label
| string | 是 | 否 | Ability对用户显示的名称
|
| description
| string | 是 | 否 | Ability的描述
|
| icon
| string | 是 | 否 | Ability的图标资源文件索引
|
| descriptionId
| number | 是 | 否 | Ability的描述id
|
| iconId
| number | 是 | 否 | Ability的图标id
|
| moduleName
| string | 是 | 否 | Ability所属的HAP包的名称
|
| process
| string | 是 | 否
| Ability的进程，如果不设置，默认为包的名称 |
| targetAbility
| string | 是 | 否 | 当前Ability重用的目标Ability
|
| backgroundModes
| number | 是 | 否 | 表示后台服务的类型
|
| isVisible
| boolean | 是 | 否 | 判断Ability是否可以被其他应用调用
|
| formEnabled
| boolean | 是 | 否 | 判断Ability是否提供卡片能力
|
| type
| AbilityType | 是 | 否 | Ability类型
|
| orientation
| DisplayOrientation | 是 | 否 | Ability的显示模式
|
| launchMode
| LaunchMode | 是 | 否 | Ability的启动模式
|
| permissions
| Array
\<
string> | 是 | 否
| 被其他应用Ability调用时需要申请的权限集合 |
| deviceTypes
| Array
\<
string> | 是 | 否 | Ability支持的设备类型
|
| deviceCapabilities
| Array
\<
string> | 是 | 否 | Ability需要的设备能力
|
| readPermission
| string | 是 | 否 | 读取Ability数据所需的权限
|
| writePermission
| string | 是 | 否 | 向Ability写数据所需的权限
|
| applicationInfo
| ApplicationInfo | 是 | 否 | 应用程序的配置信息
|
| uri
| string | 是 | 否 | 获取Ability的统一资源标识符（URI）
|
| labelId
| number | 是 | 否 | Ability的标签id
|
| subType
| AbilitySubType | 是 | 否 | Ability中枚举使用的模板的子类型
|
| metaData
<sup>
8+
</sup>
| Array
\<
CustomizeData> | 是
| 否 | ability的自定义信息
|
| metaData
<sup>
9+
</sup>
| Array
\<
Metadata>
| 是 | 否 | ability的元信息
|
| enabled
<sup>
8+
</sup>
| boolean | 是 | 否 | ability是否可用
|
## AbilityType
...
...
@@ -1595,12 +1595,12 @@ Ability类型
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 说明
|
| ------- | ---- | -----------------
----------
|
| UNKNOWN | 无
| 未知Ability类型
|
| PAGE | 无
| Ability有一个UI界面
|
| SERVICE | 无
| Ability没有UI界面
|
| DATA | 无 | Ability用于提供数据访问服务 |
| 名称
| 类型 | 说明
|
| ------- | ---- | ----------------- |
| UNKNOWN | 无
| 未知Ability类型
|
| PAGE | 无
| Ability有一个UI界面
|
| SERVICE | 无
| Ability没有UI界面
|
| DATA | 无
| Ability用于提供数据访问服务 |
## DisplayOrientation
...
...
@@ -1608,12 +1608,12 @@ Ability类型
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 说明
|
| ------------- | ---- | -------------
-----------
|
| UNSPECIFIED | 无
| 屏幕方向--不指定
|
| LANDSCAPE | 无
| 屏幕方向--横屏
|
| PORTRAIT | 无
| 屏幕方向--竖屏
|
| FOLLOW_RECENT | 无 | 屏幕方向--紧跟上一个组件 |
| 名称
| 类型 | 说明
|
| ------------- | ---- | ------------- |
| UNSPECIFIED | 无
| 屏幕方向--不指定
|
| LANDSCAPE | 无
| 屏幕方向--横屏
|
| PORTRAIT | 无
| 屏幕方向--竖屏
|
| FOLLOW_RECENT | 无
| 屏幕方向--紧跟上一个组件 |
## LaunchMode
...
...
@@ -1621,10 +1621,10 @@ Ability类型
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型
| 说明
|
| ---------
-- | ---- | ------
------------- |
| SINGLETON
| 0 | Ability只有一个示例 |
| STANDARD
| 1 | Ability有多个示例
|
| 名称 | 类型
| 说明
|
| ---------
| ---- |
------------- |
| SINGLETON | 0 | Ability只有一个示例 |
| STANDARD
| 1 | Ability有多个示例
|
## AbilitySubType
...
...
@@ -1632,9 +1632,9 @@ Ability的子类型
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 说明
|
| ----------- | ---- | --------------------
---------
|
| UNSPECIFIED | 0 | 未定义Ability子类型
|
| 名称
| 类型 | 说明
|
| ----------- | ---- | -------------------- |
| UNSPECIFIED | 0 | 未定义Ability子类型 |
| CA | 1 | Ability子类型是带有 UI 的服务 |
...
...
@@ -1644,18 +1644,18 @@ ExtensionAbility的类型
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 说明
|
| --------------------
| ---- | ----
------------------------- |
| FORM
<sup>
9+
</sup>
| 0 | ExtensionAbility的类型包括卡片
|
| 名称
| 类型 | 说明
|
| --------------------
---------- | ---- |
------------------------- |
| FORM
<sup>
9+
</sup>
| 0 | ExtensionAbility的类型包括卡片
|
| WORK_SCHEDULER
<sup>
9+
</sup>
| 1 | ExtensionAbility的类型包括行程安排 |
| INPUT_METHOD
<sup>
9+
</sup>
| 2 | ExtensionAbility的类型包括输入法
|
| SERVICE
<sup>
9+
</sup>
| 3 | ExtensionAbility的类型包括服务
|
| ACCESSIBILITY
<sup>
9+
</sup>
| 4 | ExtensionAbility的类型包括无障碍
|
| DATA_SHARE
<sup>
9+
</sup>
| 5 | ExtensionAbility的类型包括数据共享 |
| FILE_SHARE
<sup>
9+
</sup>
| 6 | ExtensionAbility的类型包括文件共享 |
| STATIC_SUBSCRIBER
<sup>
9+
</sup>
| 7 | ExtensionAbility的类型包括订阅者
|
| WALLPAPER
<sup>
9+
</sup>
| 8 | ExtensionAbility的类型包括墙纸
|
| UNSPECIFIED
<sup>
9+
</sup>
| 9 | ExtensionAbility未指定类型 |
| INPUT_METHOD
<sup>
9+
</sup>
| 2 | ExtensionAbility的类型包括输入法
|
| SERVICE
<sup>
9+
</sup>
| 3 | ExtensionAbility的类型包括服务
|
| ACCESSIBILITY
<sup>
9+
</sup>
| 4 | ExtensionAbility的类型包括无障碍
|
| DATA_SHARE
<sup>
9+
</sup>
| 5 | ExtensionAbility的类型包括数据共享 |
| FILE_SHARE
<sup>
9+
</sup>
| 6 | ExtensionAbility的类型包括文件共享 |
| STATIC_SUBSCRIBER
<sup>
9+
</sup>
| 7 | ExtensionAbility的类型包括订阅者
|
| WALLPAPER
<sup>
9+
</sup>
| 8 | ExtensionAbility的类型包括墙纸
|
| UNSPECIFIED
<sup>
9+
</sup>
| 9 | ExtensionAbility未指定类型 |
## ExtensionFlag<sup>9+</sup>
...
...
@@ -1663,11 +1663,11 @@ ExtensionAbility的类型
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 默认值 | 说明
|
| ------
| ------ |
------ |
| GET_EXTENSION_INFO_DEFAULT
<sup>
9+
</sup>
| 0x00000000 | 获取默认的extensionAbilityInfo
|
| GET_EXTENSION_INFO_WITH_PERMISSION
<sup>
9+
</sup>
| 0x00000002 | 获取携带权限信息的extensionAbilityInfo |
| GET_EXTENSION_INFO_WITH_APPLICATION
<sup>
9+
</sup>
| 0x00000004 | 获取携带应用信息的extensionAbilityInfo |
| 名称
| 默认值 | 说明
|
| ------
---------------------------------- | ---------- | ------------------------
------ |
| GET_EXTENSION_INFO_DEFAULT
<sup>
9+
</sup>
| 0x00000000 | 获取默认的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_METADATA
<sup>
9+
</sup>
| 0x00000020 | 获取携带元数据信息的extensionAbilityInfo |
...
...
@@ -1677,11 +1677,11 @@ ExtensionAbility的类型
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 说明
|
| ----------
- | ---- | ---------------
---- |
| AUTO_MODE | -1
| 自动模式 |
| DARK_MODE
| 0 | 夜间模式
|
| LIGHT_MODE
| 1 | 灯光模式
|
| 名称
| 类型 | 说明
|
| ----------
| ---- |
---- |
| AUTO_MODE | -1 | 自动模式 |
| DARK_MODE
| 0 | 夜间模式
|
| LIGHT_MODE
| 1 | 灯光模式
|
## GrantStatus
...
...
@@ -1690,10 +1690,10 @@ ExtensionAbility的类型
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 说明
|
| -----------
| ---- | ---------------
---- |
| PERMISSION_DENIED | -1
| 拒绝许可 |
| PERMISSION_GRANTED
| 0 | 批准 |
| 名称
| 类型 | 说明
|
| -----------
------- | ---- |
---- |
| PERMISSION_DENIED | -1 | 拒绝许可 |
| PERMISSION_GRANTED | 0 | 批准 |
## ExtensionAbilityInfo<sup>9+</sup>
...
...
@@ -1702,22 +1702,22 @@ ExtensionAbility信息
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
| ------ | ------ | ------ |
------ |
| bundleName
<sup>
9+
</sup>
| string | 是 | 否 | 应用包名
|
| moduleName
<sup>
9+
</sup>
| string | 是 | 否 | ExtensionAbility所属的HAP包的名称
|
| name
<sup>
9+
</sup>
| string | 是 | 否 | ExtensionAbility名称
|
| labelId
<sup>
9+
</sup>
| number | 是 | 否 | ExtensionAbility的标签id
|
| descriptionId
<sup>
9+
</sup>
| number | 是 | 否 | ExtensionAbility的描述id
|
| iconId
<sup>
9+
</sup>
| number | 是 | 否 | ExtensionAbility的图标id
|
| isVisible
<sup>
9+
</sup>
| boolean | 是 | 否 | 判断ExtensionAbility是否可以被其他应用调用
|
| extensionAbilityType
<sup>
9+
</sup>
| bundle.ExtensionAbilityType | 是 | 否 | ExtensionAbility类型
|
| permissions
<sup>
9+
</sup>
| Array
\<
string> | 是 | 否
| 被其他应用ExtensionAbility调用时需要申请的权限集合 |
| applicationInfo
<sup>
9+
</sup>
| ApplicationInfo | 是 | 否 | 应用程序的配置信息
|
| metaData
<sup>
9+
</sup>
| Array
\<
Metadata> | 是 | 否 | ExtensionAbility的元信息
|
| enabled
<sup>
9+
</sup>
| boolean | 是 | 否 | ExtensionAbility是否可用
|
| readPermission
<sup>
9+
</sup>
| string | 是 | 否 | 读取ExtensionAbility数据所需的权限
|
| writePermission
<sup>
9+
</sup>
| string | 是 | 否 | 向ExtensionAbility写数据所需的权限
|
| 名称
| 类型 | 可读 | 可写 | 说明
|
| ------
--------------------------- | --------------------------- | ---- | ---- | ---------------------------
------ |
| bundleName
<sup>
9+
</sup>
| string | 是 | 否 | 应用包名
|
| moduleName
<sup>
9+
</sup>
| string | 是 | 否 | ExtensionAbility所属的HAP包的名称
|
| name
<sup>
9+
</sup>
| string | 是 | 否 | ExtensionAbility名称
|
| labelId
<sup>
9+
</sup>
| number | 是 | 否 | ExtensionAbility的标签id
|
| descriptionId
<sup>
9+
</sup>
| number | 是 | 否 | ExtensionAbility的描述id
|
| iconId
<sup>
9+
</sup>
| number | 是 | 否 | ExtensionAbility的图标id
|
| isVisible
<sup>
9+
</sup>
| boolean | 是 | 否 | 判断ExtensionAbility是否可以被其他应用调用
|
| extensionAbilityType
<sup>
9+
</sup>
| bundle.ExtensionAbilityType | 是 | 否 | ExtensionAbility类型
|
| permissions
<sup>
9+
</sup>
| Array
\<
string> | 是 | 否
| 被其他应用ExtensionAbility调用时需要申请的权限集合 |
| applicationInfo
<sup>
9+
</sup>
| ApplicationInfo | 是 | 否 | 应用程序的配置信息
|
| metaData
<sup>
9+
</sup>
| Array
\<
Metadata> | 是 | 否 | ExtensionAbility的元信息
|
| enabled
<sup>
9+
</sup>
| boolean | 是 | 否 | ExtensionAbility是否可用
|
| readPermission
<sup>
9+
</sup>
| string | 是 | 否 | 读取ExtensionAbility数据所需的权限
|
| writePermission
<sup>
9+
</sup>
| string | 是 | 否 | 向ExtensionAbility写数据所需的权限
|
## Metadata<sup>9+</sup>
...
...
@@ -1726,8 +1726,8 @@ ExtensionAbility信息
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ------ | ---- | ---- | ---------------- |
| name
<sup>
9+
</sup>
| string | 是 | 是 | 元数据名称 |
| value
<sup>
9+
</sup>
| string | 是 | 是 | 元数据值 |
| resource
<sup>
9+
</sup>
| string | 是 | 是 | 元数据资源 |
\ No newline at end of file
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------------- | ------ | ---- | ---- | ----- |
| name
<sup>
9+
</sup>
| string | 是 | 是 | 元数据名称 |
| value
<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
...
...
@@ -20,8 +20,8 @@ createAppAccountManager(): AppAccountManager
**系统能力：**
SystemCapability.Account.AppAccount
**返回值：**
| 类型
| 说明
|
| ----------------- | ------------
------------
|
| 类型
| 说明
|
| ----------------- | ------------ |
| AppAccountManager | 获取应用帐号模块的实例。 |
**示例：**
...
...
@@ -43,10 +43,10 @@ addAccount(name: string, callback: AsyncCallback<void>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ---------------------
---------------------
|
| name | string | 是
| 要添加的应用帐户的名称。
|
| callback | AsyncCallback
<
void
>
| 是 | 将此应用的帐号名添加到帐号管理服务的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | --------------------- |
| name | string | 是
| 要添加的应用帐户的名称。
|
| callback | AsyncCallback
<
void
>
| 是
| 将此应用的帐号名添加到帐号管理服务的回调。 |
**示例：**
...
...
@@ -67,11 +67,11 @@ addAccount(name: string, extraInfo: string, callback: AsyncCallback<void>)
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------------------------- | ---- | ----------------------------------------
--------------------
|
| name | string | 是
| 要添加的应用帐户的名称。
|
| extraInfo | string | 是 | 要添加的应用帐户的额外信息(例如token等)，额外的信息不能是应用帐号的敏感信息。 |
| callback | AsyncCallback
<
void
>
| 是
| 将此应用程序的帐号名和额外信息添加到帐号管理服务中的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------------------------- | ---- | ---------------------------------------- |
| name | string | 是
| 要添加的应用帐户的名称。
|
| extraInfo | string | 是
| 要添加的应用帐户的额外信息(例如token等)，额外的信息不能是应用帐号的敏感信息。 |
| callback | AsyncCallback
<
void
>
| 是
| 将此应用程序的帐号名和额外信息添加到帐号管理服务中的回调。
|
**示例：**
...
...
@@ -94,15 +94,15 @@ addAccount(name: string, extraInfo?: string): Promise<void>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------ | ---- | --------------------------------
----------------------------
|
| name | string | 是
| 要添加的应用帐户的名称。
|
| extraInfo | string | 是 | 要添加的应用帐户的额外信息，额外的信息不能是应用帐号的敏感信息。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------ | ---- | -------------------------------- |
| name | string | 是
| 要添加的应用帐户的名称。
|
| extraInfo | string | 是
| 要添加的应用帐户的额外信息，额外的信息不能是应用帐号的敏感信息。 |
**返回值：**
| 类型
| 说明
|
| ------------------- | ---------------------
--------------
|
| 类型
| 说明
|
| ------------------- | --------------------- |
| Promise
<
void
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -126,12 +126,12 @@ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: a
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------- | ---- | ---------------
---------------
|
| owner | string | 是 | 要添加的应用帐户的所有者包名。 |
| authType | string | 是
| 要添加的应用帐户的鉴权类型。
|
| options | {[key: string]: any} | 是
| 鉴权所需要的可选项。
|
| callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------- | ---- | --------------- |
| owner | string | 是
| 要添加的应用帐户的所有者包名。 |
| authType | string | 是
| 要添加的应用帐户的鉴权类型。
|
| options | {[key: string]: any} | 是
| 鉴权所需要的可选项。
|
| callback | AuthenticatorCallback | 是
| 认证器回调，用于返回鉴权结果。 |
**示例：**
...
...
@@ -167,10 +167,10 @@ deleteAccount(name: string, callback: AsyncCallback<void>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | -----------------
-----------------
|
| name | string | 是
| 要删除的应用帐户的名称。
|
| callback | AsyncCallback
<
void
>
| 是 | 帐号管理服务中删除应用帐号的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ----------------- |
| name | string | 是
| 要删除的应用帐户的名称。
|
| callback | AsyncCallback
<
void
>
| 是
| 帐号管理服务中删除应用帐号的回调。 |
**示例：**
...
...
@@ -191,14 +191,14 @@ deleteAccount(name: string): Promise<void>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ----
-- | ------ | ---- | ------------
------------ |
| name
| string | 是
| 要删除的应用帐户的名称。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- |
------------ |
| name
| string | 是
| 要删除的应用帐户的名称。 |
**返回值：**
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| 类型
| 说明
|
| :------------------ | :-------------------- |
| Promise
<
void
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -222,11 +222,11 @@ disableAppAccess(name: string, bundleName: string, callback: AsyncCallback<vo
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------- | ---- | -------------------------------
-----------------------------
|
| name | string | 是
| 要禁用访问的第三方应用帐户的名称。
|
| bundleName | string | 是
| 第三方应用的包名。
|
| callback | AsyncCallback
<
void
>
| 是 | 禁止指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------- | ---- | ------------------------------- |
| name | string | 是
| 要禁用访问的第三方应用帐户的名称。
|
| bundleName | string | 是
| 第三方应用的包名。
|
| callback | AsyncCallback
<
void
>
| 是
| 禁止指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 |
**示例：**
...
...
@@ -247,15 +247,15 @@ disableAppAccess(name: string, bundleName: string): Promise<void>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | -----------------
-----------------
|
| name | string | 是 | 要禁用访问的第三方应用帐户的名称。 |
| bundleName | string | 是
| 第三方应用的包名。
|
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | ----------------- |
| name | string | 是
| 要禁用访问的第三方应用帐户的名称。 |
| bundleName | string | 是
| 第三方应用的包名。
|
**返回值：**
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| 类型
| 说明
|
| :------------------ | :-------------------- |
| Promise
<
void
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -279,11 +279,11 @@ enableAppAccess(name: string, bundleName: string, callback: AsyncCallback<voi
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------- | ---- | -------------------------------
-----------------------------
|
| name | string | 是
| 应用帐号名称。
|
| bundleName | string | 是
| 第三方应用的包名。
|
| callback | AsyncCallback
<
void
>
| 是 | 允许指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------- | ---- | ------------------------------- |
| name | string | 是
| 应用帐号名称。
|
| bundleName | string | 是
| 第三方应用的包名。
|
| callback | AsyncCallback
<
void
>
| 是
| 允许指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 |
**示例：**
...
...
@@ -304,15 +304,15 @@ enableAppAccess(name: string, bundleName: string): Promise<void>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | ---------
---------
|
| name | string | 是
| 应用帐号名称。
|
| bundleName | string | 是 | 第三方应用的包名。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | --------- |
| name | string | 是
| 应用帐号名称。
|
| bundleName | string | 是
| 第三方应用的包名。 |
**返回值：**
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| 类型
| 说明
|
| :------------------ | :-------------------- |
| Promise
<
void
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -337,10 +337,10 @@ checkAppAccountSyncEnable(name: string, callback: AsyncCallback<boolean>):
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ---------------------------- | ---- | ----------------------
----------------------
|
| name | string | 是
| 应用帐号名称。
|
| callback | AsyncCallback
<
boolean
>
| 是 | 检查指定应用帐号是否允许应用数据同步的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ---------------------------- | ---- | ---------------------- |
| name | string | 是
| 应用帐号名称。
|
| callback | AsyncCallback
<
boolean
>
| 是
| 检查指定应用帐号是否允许应用数据同步的回调。 |
**示例：**
...
...
@@ -364,14 +364,14 @@ checkAppAccountSyncEnable(name: string): Promise<boolean>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ----
-- | ------ | ---- | -------
------- |
| name
| string | 是
| 应用帐号名称。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- |
------- |
| name
| string | 是
| 应用帐号名称。 |
**返回值：**
| 类型
| 说明
|
| :--------------------- | :--------------------
--------------
|
| 类型
| 说明
|
| :--------------------- | :-------------------- |
| Promise
<
boolean
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -395,12 +395,12 @@ setAccountCredential(name: string, credentialType: string, credential: string,ca
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ------------------------- | ---- | --------------
--------------
|
| name | string | 是
| 应用程序帐户的名称。
|
| credentialType | string | 是
| 要设置的凭据的类型。
|
| credential | string | 是
| 要设置的凭据。
|
| callback | AsyncCallback
<
void
>
| 是 | 设置此应用帐号的凭据的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ------------------------- | ---- | -------------- |
| name | string | 是
| 应用程序帐户的名称。
|
| credentialType | string | 是
| 要设置的凭据的类型。
|
| credential | string | 是
| 要设置的凭据。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置此应用帐号的凭据的回调。 |
**示例：**
...
...
@@ -421,16 +421,16 @@ setAccountCredential(name: string, credentialType: string, credential: string):
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ------ | ---- | ----------
----------
|
| name | string | 是
| 应用帐户的名称。
|
| credentialType | string | 是 | 要设置的凭据的类型。 |
| credential | string | 是
| 要设置的凭据。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ------ | ---- | ---------- |
| name | string | 是
| 应用帐户的名称。
|
| credentialType | string | 是
| 要设置的凭据的类型。 |
| credential | string | 是
| 要设置的凭据。
|
**返回值：**
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| 类型
| 说明
|
| :------------------ | :-------------------- |
| Promise
<
void
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -454,11 +454,11 @@ setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback<
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------------------------- | ---- | ----------------
----------------
|
| name | string | 是
| 应用帐户的名称。
|
| extraInfo | string | 是
| 要设置的额外信息。
|
| callback | AsyncCallback
<
void
>
| 是 | 设置此应用帐号的额外信息的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------------------------- | ---- | ---------------- |
| name | string | 是
| 应用帐户的名称。
|
| extraInfo | string | 是
| 要设置的额外信息。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置此应用帐号的额外信息的回调。 |
**示例：**
...
...
@@ -479,15 +479,15 @@ setAccountExtraInfo(name: string, extraInfo: string): Promise<void>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------ | ---- | ---------
---------
|
| name | string | 是
| 应用帐户的名称。
|
| extraInfo | string | 是 | 要设置的额外信息。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------ | ---- | --------- |
| name | string | 是
| 应用帐户的名称。
|
| extraInfo | string | 是
| 要设置的额外信息。 |
**返回值：**
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| 类型
| 说明
|
| :------------------ | :-------------------- |
| Promise
<
void
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -513,11 +513,11 @@ setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | -------------------------
-------------------------
|
| name | string | 是
| 应用帐户的名称。
|
| isEnable | boolean | 是
| 是否允许应用数据同步。
|
| callback | AsyncCallback
<
void
>
| 是 | 设置指定的应用帐号是否允许应用程序数据同步的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ------------------------- |
| name | string | 是
| 应用帐户的名称。
|
| isEnable | boolean | 是
| 是否允许应用数据同步。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置指定的应用帐号是否允许应用程序数据同步的回调。 |
**示例：**
...
...
@@ -540,15 +540,15 @@ setAppAccountSyncEnable(name: string, isEnable: boolean): Promise<void>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------- | ---- | -----------
-----------
|
| name | string | 是
| 应用帐户的名称。
|
| isEnable | boolean | 是 | 是否允许应用数据同步。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------- | ---- | ----------- |
| name | string | 是
| 应用帐户的名称。
|
| isEnable | boolean | 是
| 是否允许应用数据同步。 |
**返回值：**
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| 类型
| 说明
|
| :------------------ | :-------------------- |
| Promise
<
void
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -572,12 +572,12 @@ setAssociatedData(name: string, key: string, value: string, callback: AsyncCallb
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | -----------------
-----------------
|
| name | string | 是
| 应用帐户的名称。
|
| key | string | 是 | 要设置的数据的键，密钥可以自定义。 |
| value | string | 是
| 要设置的数据的值。
|
| callback | AsyncCallback
<
void
>
| 是 | 设置与此应用帐号关联的数据的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ----------------- |
| name | string | 是
| 应用帐户的名称。
|
| key | string | 是
| 要设置的数据的键，密钥可以自定义。 |
| value | string | 是
| 要设置的数据的值。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置与此应用帐号关联的数据的回调。 |
**示例：**
...
...
@@ -597,16 +597,16 @@ setAssociatedData(name: string, key: string, value: string): Promise<void>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -----
- | ------ | ---- | -----------------
----------------- |
| name
| string | 是 | 应用帐户的名称。
|
| key
| string | 是
| 要设置的数据的键，密钥可以自定义。 |
| value
| string | 是 | 要设置的数据的值。
|
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ------ | ---- |
----------------- |
| name
| string | 是 | 应用帐户的名称。
|
| key
| string | 是
| 要设置的数据的键，密钥可以自定义。 |
| value
| string | 是 | 要设置的数据的值。
|
**返回值：**
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| 类型
| 说明
|
| :------------------ | :-------------------- |
| Promise
<
void
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -630,11 +630,11 @@ getAccountCredential(name: string, credentialType: string, callback: AsyncCallba
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | --------------------------- | ---- | --------------
--------------
|
| name | string | 是
| 应用帐号名称。
|
| credentialType | string | 是
| 要获取的凭据的类型。
|
| callback | AsyncCallback
<
string
>
| 是 | 获取此应用帐号的凭据的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | --------------------------- | ---- | -------------- |
| name | string | 是
| 应用帐号名称。
|
| credentialType | string | 是
| 要获取的凭据的类型。
|
| callback | AsyncCallback
<
string
>
| 是
| 获取此应用帐号的凭据的回调。 |
**示例：**
...
...
@@ -656,15 +656,15 @@ getAccountCredential(name: string, credentialType: string): Promise<string>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ------ | ---- | ----------
----------
|
| name | string | 是
| 应用帐号名称。
|
| credentialType | string | 是 | 要获取的凭据的类型。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ------ | ---- | ---------- |
| name | string | 是
| 应用帐号名称。
|
| credentialType | string | 是
| 要获取的凭据的类型。 |
**返回值：**
| 类型
| 说明
|
| :-------------------- | :--------------------
--------------
|
| 类型
| 说明
|
| :-------------------- | :-------------------- |
| Promise
<
string
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -688,10 +688,10 @@ getAccountExtraInfo(name: string, callback: AsyncCallback<string>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ----------------
----------------
|
| name | string | 是
| 应用帐号名称。
|
| callback | AsyncCallback
<
string
>
| 是 | 获取此应用帐号的额外信息的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ---------------- |
| name | string | 是
| 应用帐号名称。
|
| callback | AsyncCallback
<
string
>
| 是
| 获取此应用帐号的额外信息的回调。 |
**示例：**
...
...
@@ -713,14 +713,14 @@ getAccountExtraInfo(name: string): Promise<string>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ----
-- | ------ | ---- | -------
------- |
| name
| string | 是
| 应用帐号名称。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- |
------- |
| name
| string | 是
| 应用帐号名称。 |
**返回值：**
| 类型
| 说明
|
| :-------------------- | :--------------------
--------------
|
| 类型
| 说明
|
| :-------------------- | :-------------------- |
| Promise
<
string
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -744,11 +744,11 @@ getAssociatedData(name: string, key: string, callback: AsyncCallback<string&g
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | -----------------
-----------------
|
| name | string | 是
| 应用帐号名称。
|
| key | string | 是
| 要获取的数据的key。
|
| callback | AsyncCallback
<
string
>
| 是 | 获取与此应用帐号关联的数据的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ----------------- |
| name | string | 是
| 应用帐号名称。
|
| key | string | 是
| 要获取的数据的key。
|
| callback | AsyncCallback
<
string
>
| 是
| 获取与此应用帐号关联的数据的回调。 |
**示例：**
...
...
@@ -770,15 +770,15 @@ getAssociatedData(name: string, key: string): Promise<string>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ----
-- | ------ | ---- | --------
----------- |
| name
| string | 是 | 应用帐号名称。
|
| key
| string | 是
| 要获取的数据的key。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- |
----------- |
| name
| string | 是 | 应用帐号名称。
|
| key
| string | 是
| 要获取的数据的key。 |
**返回值：**
| 类型
| 说明
|
| :-------------------- | :--------------------
--------------
|
| 类型
| 说明
|
| :-------------------- | :-------------------- |
| Promise
<
string
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -804,9 +804,9 @@ getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>&
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------- | ---- | --------
-------- |
| callback | AsyncCallback
<
Array
<
AppAccountInfo
>>
| 是 | 应用帐号信息列表 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
-------- |
| callback | AsyncCallback
<
Array
<
AppAccountInfo
>>
| 是
| 应用帐号信息列表 |
**示例：**
...
...
@@ -830,8 +830,8 @@ getAllAccessibleAccounts(): Promise<Array<AppAccountInfo>>
**参数：**
| 类型 | 说明
|
| ----------------------------------------
-- | --------------
--------------------- |
| 类型 | 说明 |
| ----------------------------------------
|
--------------------- |
| Promise
<
Array
<
AppAccountInfo
>>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -857,10 +857,10 @@ getAllAccounts(owner: string, callback: AsyncCallback<Array<AppAccountInfo
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------- | ---- | --------
-------- |
| owner | string
| 是 | 应用包名称
|
| callback | AsyncCallback
<
Array
<
AppAccountInfo
>>
| 是 | 应用帐号信息列表 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
-------- |
| owner | string
| 是 | 应用包名称
|
| callback | AsyncCallback
<
Array
<
AppAccountInfo
>>
| 是
| 应用帐号信息列表 |
**示例：**
...
...
@@ -885,14 +885,14 @@ getAllAccounts(owner: string): Promise<Array<AppAccountInfo>>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -----
- | ------ | ---- | -----
----- |
| owner
| string | 是
| 应用包名称 |
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ------ | ---- |
----- |
| owner
| string | 是
| 应用包名称 |
**参数：**
| 类型 | 说明
|
| ----------------------------------------
-- | --------------
--------------------- |
| 类型 | 说明 |
| ----------------------------------------
|
--------------------- |
| Promise
<
Array
<
AppAccountInfo
>>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -917,11 +917,11 @@ on(type: 'change', owners: Array<string>, callback: Callback<Array<A
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--- | ---- | ------------------------------
------------------------------ |
| type | 'change'
| 是
| 关于帐户更改事件，当帐户所有者更新帐户时，订阅者将收到通知。 |
| owners | Array
<
string
>
| 是 | 指示帐户的所有者。
|
| callback | Callback
<
Array
<
AppAccountInfo
>>
| 是
| 订阅指定帐号所有者的帐户变更事件的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
------------------------------ |
| type | 'change'
| 是
| 关于帐户更改事件，当帐户所有者更新帐户时，订阅者将收到通知。 |
| owners | Array
<
string
>
| 是 | 指示帐户的所有者。
|
| callback | Callback
<
Array
<
AppAccountInfo
>>
| 是
| 订阅指定帐号所有者的帐户变更事件的回调。
|
**示例：**
...
...
@@ -948,10 +948,10 @@ off(type: 'change', callback?: Callback<Array\<AppAccountInfo>>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | -------------------------------- | ---- | ------------
------------
|
| type | 'change' | 是
| 关于帐户更改事件。
|
| callback | Callback
<Array
\<
AppAccountInfo
>
> | 否 | 取消订阅帐号事件的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | -------------------------------- | ---- | ------------ |
| type | 'change' | 是
| 关于帐户更改事件。
|
| callback | Callback
<Array
\<
AppAccountInfo
>
> | 否
| 取消订阅帐号事件的回调。 |
**示例：**
...
...
@@ -981,13 +981,13 @@ authenticate(name: string, owner: string, authType: string, options: {[key: stri
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------- | ---- | ---------------
---------------
|
| name | string | 是
| 要鉴权的应用帐户的名称。
|
| owner | string | 是 | 要鉴权的应用帐户的所有者包名。 |
| authType | string | 是
| 鉴权类型。
|
| options | {[key: string]: any} | 是
| 鉴权所需的可选项。
|
| callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------- | ---- | --------------- |
| name | string | 是
| 要鉴权的应用帐户的名称。
|
| owner | string | 是
| 要鉴权的应用帐户的所有者包名。 |
| authType | string | 是
| 鉴权类型。
|
| options | {[key: string]: any} | 是
| 鉴权所需的可选项。
|
| callback | AuthenticatorCallback | 是
| 认证器回调，用于返回鉴权结果。 |
**示例：**
...
...
@@ -1023,12 +1023,12 @@ getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCall
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | -----------
-----------
|
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是 | 应用帐户的所有者包名。 |
| authType | string | 是
| 鉴权类型。
|
| callback | AsyncCallback
<
string
>
| 是
| 查询结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ----------- |
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是
| 应用帐户的所有者包名。 |
| authType | string | 是
| 鉴权类型。
|
| callback | AsyncCallback
<
string
>
| 是
| 查询结果的回调。
|
**示例：**
...
...
@@ -1050,16 +1050,16 @@ getOAuthToken(name: string, owner: string, authType: string): Promise<string&
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | -----------
-----------
|
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是 | 应用帐户的所有者包名。 |
| authType | string | 是
| 鉴权类型。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ----------- |
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是
| 应用帐户的所有者包名。 |
| authType | string | 是
| 鉴权类型。
|
**参数：**
| 类型
| 说明
|
| --------------------- | ---------------------
--------------
|
| 类型
| 说明
|
| --------------------- | --------------------- |
| Promise
<
string
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -1083,12 +1083,12 @@ setOAuthToken(name: string, authType: string, token: string, callback: AsyncCall
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | --------
--------
|
| name | string | 是 | 应用帐户的名称。 |
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| OAuth令牌。
|
| callback | AsyncCallback
<
void
>
| 是 | 设置结果的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | -------- |
| name | string | 是
| 应用帐户的名称。 |
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| OAuth令牌。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置结果的回调。 |
**示例：**
...
...
@@ -1109,16 +1109,16 @@ setOAuthToken(name: string, authType: string, token: string): Promise<void>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | --------
--------
|
| name | string | 是 | 应用帐户的名称。 |
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| OAuth令牌。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | -------- |
| name | string | 是
| 应用帐户的名称。 |
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| OAuth令牌。
|
**参数：**
| 类型
| 说明
|
| ------------------- | ---------------------
--------------
|
| 类型
| 说明
|
| ------------------- | --------------------- |
| Promise
<
void
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -1142,13 +1142,13 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string, c
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ------------
----------
|
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是
| 应用帐户的所有者包名。
|
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| 要删除的OAuth令牌。
|
| callback | AsyncCallback
<
void
>
| 是
| 删除结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ------------ |
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是
| 应用帐户的所有者包名。
|
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| 要删除的OAuth令牌。
|
| callback | AsyncCallback
<
void
>
| 是
| 删除结果的回调。
|
**示例：**
...
...
@@ -1169,17 +1169,17 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string):
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ------------
----------
|
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是
| 应用帐户的所有者包名。
|
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| 要删除的OAuth令牌。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ------------ |
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是
| 应用帐户的所有者包名。
|
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| 要删除的OAuth令牌。
|
**参数：**
| 类型
| 说明
|
| ------------------- | ---------------------
--------------
|
| 类型
| 说明
|
| ------------------- | --------------------- |
| Promise
<
void
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -1203,13 +1203,13 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------- | ---- | ------------
------------
|
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是 | 被设置可见性的应用包名。 |
| isVisible | boolean | 是
| 是否可见。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------- | ---- | ------------ |
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是
| 被设置可见性的应用包名。 |
| isVisible | boolean | 是
| 是否可见。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置结果的回调。
|
**示例：**
...
...
@@ -1230,24 +1230,23 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------- | ---- | ------------
------------
|
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是 | 被设置可见性的应用包名。 |
| isVisible | boolean | 是
| 是否可见。
|
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------- | ---- | ------------ |
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是
| 被设置可见性的应用包名。 |
| isVisible | boolean | 是
| 是否可见。
|
**参数：**
| 类型
| 说明
|
| ------------------- | ---------------------
--------------
|
| 类型
| 说明
|
| ------------------- | --------------------- |
| Promise
<
void
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
```
const appAccountManager = account_appAccount.createAppAccountManager();
const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true).then(() => {
console.log('setOAuthTokenVisibility successfully');
}).catch((err) => {
...
...
@@ -1265,12 +1264,12 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, ca
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ---------------------------- | ---- | -------------
-------------
|
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是 | 用于检查可见性的应用包名。 |
| callback | AsyncCallback
<
boolean
>
| 是
| 检查结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ---------------------------- | ---- | ------------- |
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是
| 用于检查可见性的应用包名。 |
| callback | AsyncCallback
<
boolean
>
| 是
| 检查结果的回调。
|
**示例：**
...
...
@@ -1292,16 +1291,16 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | -------------
-------------
|
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是 | 用于检查可见性的应用包名。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | ------------- |
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是
| 用于检查可见性的应用包名。 |
**参数：**
| 类型
| 说明
|
| ---------------------- | ---------------------
--------------
|
| 类型
| 说明
|
| ---------------------- | --------------------- |
| Promise
<
boolean
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -1325,11 +1324,11 @@ getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback<Array&
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------- | ---- | -----------
----------- |
| name | string
| 是 | 应用帐户的名称。
|
| owner | string
| 是
| 应用帐户的所有者包名。 |
| callback | AsyncCallback
<
Array
<
OAuthTokenInfo
>>
| 是
| 查询结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
----------- |
| name | string
| 是 | 应用帐户的名称。
|
| owner | string
| 是
| 应用帐户的所有者包名。 |
| callback | AsyncCallback
<
Array
<
OAuthTokenInfo
>>
| 是
| 查询结果的回调。
|
**示例：**
...
...
@@ -1351,15 +1350,15 @@ getAllOAuthTokens(name: string, owner: string): Promise<Array<OAuthTokenIn
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -----
- | ------ | ---- | -----------
----------- |
| name
| string | 是 | 应用帐户的名称。
|
| owner
| string | 是
| 应用帐户的所有者包名。 |
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ------ | ---- |
----------- |
| name
| string | 是 | 应用帐户的名称。
|
| owner
| string | 是
| 应用帐户的所有者包名。 |
**参数：**
| 类型 | 说明
|
| ----------------------------------------
-- | --------------
--------------------- |
| 类型 | 说明 |
| ----------------------------------------
|
--------------------- |
| Promise
<
Array
<
OAuthTokenInfo
>>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -1383,11 +1382,11 @@ getOAuthList(name: string, authType: string, callback: AsyncCallback<Array<
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | -----------
-----------
|
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是 | 应用帐户的所有者包名。 |
| callback | AsyncCallback
<
Array
<
string
>>
| 是
| 查询结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | ----------- |
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是
| 应用帐户的所有者包名。 |
| callback | AsyncCallback
<
Array
<
string
>>
| 是
| 查询结果的回调。
|
**示例：**
...
...
@@ -1409,15 +1408,15 @@ getOAuthList(name: string, authType: string): Promise<Array<string>>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -----
- | ------ | ---- | -----------
----------- |
| name
| string | 是 | 应用帐户的名称。
|
| owner
| string | 是
| 应用帐户的所有者包名。 |
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ------ | ---- |
----------- |
| name
| string | 是 | 应用帐户的名称。
|
| owner
| string | 是
| 应用帐户的所有者包名。 |
**参数：**
| 类型
| 说明
|
| ---------------------------------- | ---------------------
--------------
|
| 类型
| 说明
|
| ---------------------------------- | --------------------- |
| Promise
<
Array
<
string
>>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -1441,10 +1440,10 @@ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback<Authentic
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ----------------------------------------
-- | ---- | --------
-------- |
| sessionId | string
| 是
| 鉴权会话的标识。 |
| callback | AsyncCallback
<
AuthenticatorCallback
>
| 是 | 查询结果的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ----------------------------------------
| ---- |
-------- |
| sessionId | string
| 是
| 鉴权会话的标识。 |
| callback | AsyncCallback
<
AuthenticatorCallback
>
| 是
| 查询结果的回调。 |
**示例：**
...
...
@@ -1476,14 +1475,14 @@ getAuthenticatorCallback(sessionId: string): Promise<AuthenticatorCallback>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------ | ---- | --------
--------
|
| sessionId | string | 是 | 鉴权会话的标识。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------ | ---- | -------- |
| sessionId | string | 是
| 鉴权会话的标识。 |
**参数：**
| 类型
| 说明
|
| ------------------------------------ | ---------------------
--------------
|
| 类型
| 说明
|
| ------------------------------------ | --------------------- |
| Promise
<
AuthenticatorCallback
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -1516,10 +1515,10 @@ getAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | -------------------------------------- | ---- | -----------
-----------
|
| owner | string | 是 | 应用帐户的所有者包名。 |
| callback | AsyncCallback
<
AuthenticatorInfo
>
| 是
| 查询结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | -------------------------------------- | ---- | ----------- |
| owner | string | 是
| 应用帐户的所有者包名。 |
| callback | AsyncCallback
<
AuthenticatorInfo
>
| 是
| 查询结果的回调。
|
**示例：**
...
...
@@ -1541,14 +1540,14 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -----
- | ------ | ---- | -----------
----------- |
| owner
| string | 是
| 应用帐户的所有者包名。 |
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ------ | ---- |
----------- |
| owner
| string | 是
| 应用帐户的所有者包名。 |
**参数：**
| 类型
| 说明
|
| -------------------------------- | ---------------------
--------------
|
| 类型
| 说明
|
| -------------------------------- | --------------------- |
| Promise
<
AuthenticatorInfo
>
| Promise实例，用于获取异步返回结果。 |
**示例：**
...
...
@@ -1568,10 +1567,10 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>
**系统能力：**
以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名
| 类型 | 必填 | 说明
|
| -----
- | ------ | ---- | -----------
----------- |
| owner
| string | 是
| 应用帐户的所有者包名。 |
| name
| string | 是 | 应用帐户的名称。
|
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ------ | ---- |
----------- |
| owner
| string | 是
| 应用帐户的所有者包名。 |
| name
| string | 是 | 应用帐户的名称。
|
## OAuthTokenInfo<sup>8+</sup>
...
...
@@ -1579,10 +1578,10 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>
**系统能力：**
以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | --------
--------
|
| authType | string | 是 | 令牌的鉴权类型。 |
| token | string | 是
| 令牌的取值。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | -------- |
| authType | string | 是
| 令牌的鉴权类型。 |
| token | string | 是
| 令牌的取值。
|
## AuthenticatorInfo<sup>8+</sup>
...
...
@@ -1590,11 +1589,11 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>
**系统能力：**
以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名
| 类型 | 必填 | 说明
|
| ------- | ------ | ---- | ----------
----------
|
| owner | string | 是 | 认证器的所有者包名。 |
| iconId | string | 是
| 认证器的图标标识。
|
| labelId | string | 是
| 认证器的标签标识。
|
| 参数名
| 类型 | 必填 | 说明
|
| ------- | ------ | ---- | ---------- |
| owner | string | 是
| 认证器的所有者包名。 |
| iconId | string | 是
| 认证器的图标标识。
|
| labelId | string | 是
| 认证器的标签标识。
|
## Constants<sup>8+</sup>
...
...
@@ -1602,19 +1601,19 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>
**系统能力：**
以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 名称
| 默认值 | 描述
|
| ----------------------------- | ---------------------- | -------------
------------
|
| ACTION_ADD_ACCOUNT_IMPLICITLY | "addAccountImplicitly" | 表示操作_隐式添加帐号。
|
| ACTION_AUTHENTICATE | "authenticate" | 表示操作_鉴权。
|
| KEY_NAME | "name" | 表示键名_应用帐户名称。
|
| 名称
| 默认值 | 描述
|
| ----------------------------- | ---------------------- | ------------- |
| ACTION_ADD_ACCOUNT_IMPLICITLY | "addAccountImplicitly" | 表示操作_隐式添加帐号。 |
| ACTION_AUTHENTICATE | "authenticate" | 表示操作_鉴权。 |
| KEY_NAME | "name" | 表示键名_应用帐户名称。 |
| KEY_OWNER | "owner" | 表示键名_应用帐户所有者。 |
| KEY_TOKEN | "token" | 表示键名_令牌。
|
| KEY_ACTION | "action" | 表示键名_操作。
|
| KEY_AUTH_TYPE | "authType" | 表示键名_鉴权类型。
|
| KEY_SESSION_ID | "sessionId" | 表示键名_会话标识。
|
| KEY_CALLER_PID | "callerPid" | 表示键名_调用方PID。
|
| KEY_CALLER_UID | "callerUid" | 表示键名_调用方UID。
|
| KEY_CALLER_BUNDLE_NAME | "callerBundleName" | 表示键名_调用方包名。
|
| KEY_TOKEN | "token" | 表示键名_令牌。 |
| KEY_ACTION | "action" | 表示键名_操作。 |
| KEY_AUTH_TYPE | "authType" | 表示键名_鉴权类型。 |
| KEY_SESSION_ID | "sessionId" | 表示键名_会话标识。 |
| KEY_CALLER_PID | "callerPid" | 表示键名_调用方PID。 |
| KEY_CALLER_UID | "callerUid" | 表示键名_调用方UID。 |
| KEY_CALLER_BUNDLE_NAME | "callerBundleName" | 表示键名_调用方包名。 |
## ResultCode<sup>8+</sup>
...
...
@@ -1622,27 +1621,27 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>
**系统能力：**
以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 名称
| 默认值 | 描述
|
| ----------------------------------- | -----
- | ------------
------------ |
| SUCCESS | 0
| 表示操作成功。
|
| ERROR_ACCOUNT_NOT_EXIST | 10001
| 表示应用帐户不存在。
|
| ERROR_APP_ACCOUNT_SERVICE_EXCEPTION | 10002
| 表示应用帐户服务异常。
|
| ERROR_INVALID_PASSWORD | 10003
| 表示密码无效。
|
| ERROR_INVALID_REQUEST | 10004
| 表示请求无效。
|
| ERROR_INVALID_RESPONSE | 10005
| 表示响应无效。
|
| ERROR_NETWORK_EXCEPTION | 10006
| 表示网络异常。
|
| ERROR_OAUTH_AUTHENTICATOR_NOT_EXIST | 10007
| 表示认证器不存在。
|
| ERROR_OAUTH_CANCELED | 10008
| 表示鉴权取消。
|
| ERROR_OAUTH_LIST_TOO_LARGE | 10009
| 表示开放授权列表过大。
|
| ERROR_OAUTH_SERVICE_BUSY | 10010
| 表示开放授权服务忙碌。
|
| ERROR_OAUTH_SERVICE_EXCEPTION | 10011
| 表示开放授权服务异常。
|
| ERROR_OAUTH_SESSION_NOT_EXIST | 10012
| 表示鉴权会话不存在。
|
| ERROR_OAUTH_TIMEOUT | 10013
| 表示鉴权超时。
|
| ERROR_OAUTH_TOKEN_NOT_EXIST | 10014
| 表示开放授权令牌不存在。 |
| ERROR_OAUTH_TOKEN_TOO_MANY | 10015
| 表示开放授权令牌过多。
|
| ERROR_OAUTH_UNSUPPORT_ACTION | 10016
| 表示不支持的鉴权操作。
|
| ERROR_OAUTH_UNSUPPORT_AUTH_TYPE | 10017
| 表示不支持的鉴权类型。
|
| ERROR_PERMISSION_DENIED | 10018
| 表示权限不足。
|
| 名称
| 默认值 | 描述
|
| ----------------------------------- | -----
|
------------ |
| SUCCESS | 0
| 表示操作成功。
|
| ERROR_ACCOUNT_NOT_EXIST | 10001
| 表示应用帐户不存在。
|
| ERROR_APP_ACCOUNT_SERVICE_EXCEPTION | 10002
| 表示应用帐户服务异常。
|
| ERROR_INVALID_PASSWORD | 10003
| 表示密码无效。
|
| ERROR_INVALID_REQUEST | 10004
| 表示请求无效。
|
| ERROR_INVALID_RESPONSE | 10005
| 表示响应无效。
|
| ERROR_NETWORK_EXCEPTION | 10006
| 表示网络异常。
|
| ERROR_OAUTH_AUTHENTICATOR_NOT_EXIST | 10007
| 表示认证器不存在。
|
| ERROR_OAUTH_CANCELED | 10008
| 表示鉴权取消。
|
| ERROR_OAUTH_LIST_TOO_LARGE | 10009
| 表示开放授权列表过大。
|
| ERROR_OAUTH_SERVICE_BUSY | 10010
| 表示开放授权服务忙碌。
|
| ERROR_OAUTH_SERVICE_EXCEPTION | 10011
| 表示开放授权服务异常。
|
| ERROR_OAUTH_SESSION_NOT_EXIST | 10012
| 表示鉴权会话不存在。
|
| ERROR_OAUTH_TIMEOUT | 10013
| 表示鉴权超时。
|
| ERROR_OAUTH_TOKEN_NOT_EXIST | 10014 | 表示开放授权令牌不存在。 |
| ERROR_OAUTH_TOKEN_TOO_MANY | 10015
| 表示开放授权令牌过多。
|
| ERROR_OAUTH_UNSUPPORT_ACTION | 10016
| 表示不支持的鉴权操作。
|
| ERROR_OAUTH_UNSUPPORT_AUTH_TYPE | 10017
| 表示不支持的鉴权类型。
|
| ERROR_PERMISSION_DENIED | 10018
| 表示权限不足。
|
## AuthenticatorCallback<sup>8+</sup>
...
...
@@ -1657,10 +1656,10 @@ onResult: (code: number, result: {[key: string]: any}) => void
**系统能力：**
SystemCapability.Account.AppAccount
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------ | -------------------- | ---- | ------
------
|
| code | number | 是 | 鉴权结果码。 |
| result | {[key: string]: any} | 是
| 鉴权结果。
|
| 参数名
| 类型 | 必填 | 说明
|
| ------ | -------------------- | ---- | ------ |
| code | number | 是
| 鉴权结果码。 |
| result | {[key: string]: any} | 是
| 鉴权结果。
|
**示例：**
...
...
@@ -1687,9 +1686,9 @@ onRequestRedirected: (request: Want) => void
**系统能力：**
SystemCapability.Account.AppAccount
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------- | ---- | ---- | ----------
----------
|
| request | Want | 是 | 用于跳转的请求信息。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------- | ---- | ---- | ---------- |
| request | Want | 是
| 用于跳转的请求信息。 |
**示例：**
...
...
@@ -1724,12 +1723,12 @@ addAccountImplicitly(authType: string, callerBundleName: string, options: {[key:
**系统能力：**
SystemCapability.Account.AppAccount
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ---------------- | --------------------- | ---- | ---------------
---------------
|
| authType | string | 是
| 应用帐户的鉴权类型。
|
| callerBundleName | string | 是
| 鉴权请求方的包名。
|
| options | {[key: string]: any} | 是
| 鉴权所需要的可选项。
|
| callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------------- | --------------------- | ---- | --------------- |
| authType | string | 是
| 应用帐户的鉴权类型。
|
| callerBundleName | string | 是
| 鉴权请求方的包名。
|
| options | {[key: string]: any} | 是
| 鉴权所需要的可选项。
|
| callback | AuthenticatorCallback | 是
| 认证器回调，用于返回鉴权结果。 |
### authenticate<sup>8+</sup>
...
...
@@ -1740,13 +1739,13 @@ authenticate(name: string, authType: string, callerBundleName: string, options:
**系统能力：**
SystemCapability.Account.AppAccount
**参数：**
| 接口名
| 类型 | 必填 | 说明
|
| ---------------- | --------------------- | ---- | ---------------
---------------
|
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 应用帐户的鉴权类型。
|
| callerBundleName | string | 是
| 鉴权请求方的包名。
|
| options | {[key: string]: any} | 是
| 鉴权所需要的可选项。
|
| callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 |
| 接口名
| 类型 | 必填 | 说明
|
| ---------------- | --------------------- | ---- | --------------- |
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 应用帐户的鉴权类型。
|
| callerBundleName | string | 是
| 鉴权请求方的包名。
|
| options | {[key: string]: any} | 是
| 鉴权所需要的可选项。
|
| callback | AuthenticatorCallback | 是
| 认证器回调，用于返回鉴权结果。 |
**示例：**
...
...
zh-cn/application-dev/reference/apis/js-apis-bluetooth.md
浏览文件 @
481ff40b
...
...
@@ -24,8 +24,6 @@ ohos.permission.DISCOVER_BLUETOOTH
ohos.permission.LOCATION
## bluetooth.enableBluetooth<sup>8+</sup><a name="enableBluetooth"></a>
enableBluetooth(): boolean
...
...
@@ -38,8 +36,8 @@ enableBluetooth(): boolean
**返回值：**
| 类型
| 说明
|
| ------- | ------------------------
---------------
|
| 类型
| 说明
|
| ------- | ------------------------ |
| boolean | 打开蓝牙，成功返回true，否则返回false。 |
**示例：**
...
...
@@ -61,8 +59,8 @@ disableBluetooth(): boolean
**返回值：**
| 类型
| 说明
|
| ------- | ------------------------
---------------
|
| 类型
| 说明
|
| ------- | ------------------------ |
| boolean | 关闭蓝牙，成功返回true，否则返回false。 |
**示例：**
...
...
@@ -84,8 +82,8 @@ getLocalName(): string
**返回值：**
| 类型
| 说明
|
| ------ | ---------
---------
|
| 类型
| 说明
|
| ------ | --------- |
| string | 蓝牙本地设备名称。 |
**示例：**
...
...
@@ -107,8 +105,8 @@ getState(): BluetoothState
**返回值：**
| 类型
| 说明
|
| --------------------------------- | ---------
---------
|
| 类型
| 说明
|
| --------------------------------- | --------- |
|
[
BluetoothState
](
#bluetoothstate
)
| 表示蓝牙开关状态。 |
**示例：**
...
...
@@ -130,8 +128,8 @@ getBtConnectionState(): ProfileConnectionState
**返回值：**
| 类型
| 说明
|
| ----------------------------------------
--------- | ------------
------------------- |
| 类型
| 说明
|
| ----------------------------------------
|
------------------- |
|
[
ProfileConnectionState
](
#profileconnectionstate
)
| 表示蓝牙设备的Profile连接状态。 |
**示例：**
...
...
@@ -153,14 +151,14 @@ setLocalName(name: string): boolean
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ----
-- | ------ | ---- | ------------------
--------------------- |
| name
| string | 是
| 要设置的蓝牙名称，最大长度为248字节数。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- |
--------------------- |
| name
| string | 是
| 要设置的蓝牙名称，最大长度为248字节数。 |
**返回值：**
| 类型
| 说明
|
| ------- | ------------------------------
---------------------
|
| 类型
| 说明
|
| ------- | ------------------------------ |
| boolean | 设置蓝牙本地设备名称，成功返回true，否则返回false。 |
**示例：**
...
...
@@ -182,14 +180,14 @@ pairDevice(deviceId: string): boolean
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | -----------------------------------
----------------
|
| deviceId | string | 是 | 表示配对的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ----------------------------------- |
| deviceId | string | 是
| 表示配对的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：**
| 类型
| 说明
|
| ------- | --------------------------
-----------------
|
| 类型
| 说明
|
| ------- | -------------------------- |
| boolean | 发起蓝牙配对，成功返回true，否则返回false。 |
**示例：**
...
...
@@ -212,14 +210,14 @@ getProfileConnState(profileId: ProfileId): ProfileConnectionState
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | --------- | ---- | -------------------------------------
-----------
|
| ProfileId | profileId | 是 | 表示profile的枚举值，例如：PROFILE_A2DP_SOURCE。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------- | --------- | ---- | ------------------------------------- |
| ProfileId | profileId | 是
| 表示profile的枚举值，例如：PROFILE_A2DP_SOURCE。 |
**返回值：**
| 类型
| 说明
|
| ----------------------------------------
--------- | ------
------------- |
| 类型
| 说明
|
| ----------------------------------------
|
------------- |
|
[
ProfileConnectionState
](
#ProfileConnectionState
)
| profile的连接状态。 |
**示例：**
...
...
@@ -241,14 +239,14 @@ cancelPairedDevice(deviceId: string): boolean
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | -------------------------------------
------------------
|
| deviceId | string | 是 | 表示要删除的远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ------------------------------------- |
| deviceId | string | 是
| 表示要删除的远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：**
| 类型
| 说明
|
| ------- | --------------------------
-----------------
|
| 类型
| 说明
|
| ------- | -------------------------- |
| boolean | 启动取消配对，成功返回true，否则返回false。 |
**示例：**
...
...
@@ -270,14 +268,14 @@ getRemoteDeviceName(deviceId: string): string
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ---------------------------------
--------------
|
| deviceId | string | 是 | 表示远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | --------------------------------- |
| deviceId | string | 是
| 表示远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：**
| 类型
| 说明
|
| ------ | -------------
-------------
|
| 类型
| 说明
|
| ------ | ------------- |
| string | 以字符串格式返回设备名称。 |
**示例：**
...
...
@@ -299,14 +297,14 @@ getRemoteDeviceClass(deviceId: string): DeviceClass
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ---------------------------------
--------------
|
| deviceId | string | 是 | 表示远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | --------------------------------- |
| deviceId | string | 是
| 表示远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：**
| 类型
| 说明
|
| --------------------------- | --------
--------
|
| 类型
| 说明
|
| --------------------------- | -------- |
|
[
DeviceClass
](
#deviceclass
)
| 远程设备的类别。 |
**示例：**
...
...
@@ -328,8 +326,8 @@ getPairedDevices(): Array<string>
**返回值：**
| 类型
| 说明
|
| ------------------- | -------------
-------------
|
| 类型
| 说明
|
| ------------------- | ------------- |
| Array
<
string
>
| 已配对蓝牙设备的地址列表。 |
**示例：**
...
...
@@ -351,15 +349,15 @@ setBluetoothScanMode(mode: ScanMode, duration: number): boolean
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------- | ---- | ----------------------------
---------------------------
|
| mode |
[
ScanMode
](
#scanmode
)
| 是
| 蓝牙扫描模式。
|
| duration | number | 是 | 设备可被发现的持续时间，单位为秒；设置为0则持续可发现。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------- | ---- | ---------------------------- |
| mode |
[
ScanMode
](
#scanmode
)
| 是
| 蓝牙扫描模式。
|
| duration | number | 是
| 设备可被发现的持续时间，单位为秒；设置为0则持续可发现。 |
**返回值：**
| 类型
| 说明
|
| ------- | --------------------------
-----------------
|
| 类型
| 说明
|
| ------- | -------------------------- |
| boolean | 设置蓝牙扫描，成功返回true，否则返回false。 |
**示例：**
...
...
@@ -382,8 +380,8 @@ getBluetoothScanMode(): ScanMode
**返回值：**
| 类型
| 说明
|
| --------------------- | -------
-------
|
| 类型
| 说明
|
| --------------------- | ------- |
|
[
ScanMode
](
#scanmode
)
| 蓝牙扫描模式。 |
**示例：**
...
...
@@ -405,8 +403,8 @@ startBluetoothDiscovery(): boolean
**返回值：**
| 类型
| 说明
|
| ------- | --------------------------
-----------------
|
| 类型
| 说明
|
| ------- | -------------------------- |
| boolean | 开启蓝牙扫描，成功返回true，否则返回false。 |
**示例：**
...
...
@@ -433,8 +431,8 @@ stopBluetoothDiscovery(): boolean
**返回值：**
| 类型
| 说明
|
| ------- | --------------------------
-----------------
|
| 类型
| 说明
|
| ------- | -------------------------- |
| boolean | 关闭蓝牙扫描，成功返回true，否则返回false。 |
**示例：**
...
...
@@ -456,15 +454,15 @@ setDevicePairingConfirmation(device: string, accept: boolean): boolean
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------- | ---- | --------------------------------
-------------
|
| device | string | 是 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| accept | boolean | 是
| 接受配对请求设置为true，否则设置为false。
|
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------- | ---- | -------------------------------- |
| device | string | 是
| 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| accept | boolean | 是
| 接受配对请求设置为true，否则设置为false。
|
**返回值：**
| 类型
| 说明
|
| ------- | ----------------------------
-------------------
|
| 类型
| 说明
|
| ------- | ---------------------------- |
| boolean | 设置设备配对确认，成功返回true，否则返回false。 |
**示例：**
...
...
@@ -491,10 +489,10 @@ on(type: "bluetoothDeviceFind", callback: Callback<Array<string>>):
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------- | ---- | --------------------------------------
----------------------
|
| type | string | 是
| 填写"bluetoothDeviceFind"字符串，表示蓝牙设备发现事件。
|
| callback | Callback
<
Array
<
string
>>
| 是
| 表示回调函数的入参，发现的设备集合。回调函数由用户创建通过该接口注册。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------- | ---- | -------------------------------------- |
| type | string | 是
| 填写"bluetoothDeviceFind"字符串，表示蓝牙设备发现事件。
|
| callback | Callback
<
Array
<
string
>>
| 是
| 表示回调函数的入参，发现的设备集合。回调函数由用户创建通过该接口注册。
|
**返回值：**
...
...
@@ -522,10 +520,10 @@ off(type: "bluetoothDeviceFind", callback?: Callback<Array<string>>)
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------- | ---- | ----------------------------------------
--------------------
|
| type | string | 是
| 填写"bluetoothDeviceFind"字符串，表示蓝牙设备发现事件。
|
| callback | Callback
<
Array
<
string
>>
| 否 | 表示取消订阅蓝牙设备发现事件上报。不填该参数则取消订阅该type对应的所有回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------- | ---- | ---------------------------------------- |
| type | string | 是
| 填写"bluetoothDeviceFind"字符串，表示蓝牙设备发现事件。
|
| callback | Callback
<
Array
<
string
>>
| 否
| 表示取消订阅蓝牙设备发现事件上报。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
...
...
@@ -554,10 +552,10 @@ on(type: "pinRequired", callback: Callback<PinRequiredParam>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
------------- | ---- | ----------------------------
-------------------------------- |
| type | string
| 是 | 填写"pinRequired"字符串，表示配对请求事件。
|
| callback | Callback
<
[PinRequiredParam](#pinrequiredparam)
>
| 是 | 表示回调函数的入参，配对请求。回调函数由用户创建通过该接口注册。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
-------------------------------- |
| type | string
| 是 | 填写"pinRequired"字符串，表示配对请求事件。
|
| callback | Callback
<
[PinRequiredParam](#pinrequiredparam)
>
| 是
| 表示回调函数的入参，配对请求。回调函数由用户创建通过该接口注册。 |
**返回值：**
...
...
@@ -585,10 +583,10 @@ off(type: "pinRequired", callback?: Callback<PinRequiredParam>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
------------- | ---- | --------------------
---------------------------------------- |
| type | string
| 是 | 填写"pinRequired"字符串，表示配对请求事件。
|
| callback | Callback
<
[PinRequiredParam](#pinrequiredparam)
>
| 否 | 表示取消订阅蓝牙配对请求事件上报，入参为配对请求参数。不填该参数则取消订阅该type对应的所有回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是 | 填写"pinRequired"字符串，表示配对请求事件。
|
| callback | Callback
<
[PinRequiredParam](#pinrequiredparam)
>
| 否
| 表示取消订阅蓝牙配对请求事件上报，入参为配对请求参数。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
...
...
@@ -617,10 +615,10 @@ on(type: "bondStateChange", callback: Callback<BondStateParam>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
---- | ---- | ------------------------
------------------------------------ |
| type | string
| 是 | 填写"bondStateChange"字符串，表示蓝牙配对状态改变事件。
|
| callback | Callback
<
[BondStateParam](#bondstate)
>
| 是
| 表示回调函数的入参，配对的状态。回调函数由用户创建通过该接口注册。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
------------------------------------ |
| type | string
| 是 | 填写"bondStateChange"字符串，表示蓝牙配对状态改变事件。
|
| callback | Callback
<
[BondStateParam](#bondstate)
>
| 是
| 表示回调函数的入参，配对的状态。回调函数由用户创建通过该接口注册。
|
**返回值：**
...
...
@@ -648,10 +646,10 @@ off(type: "bondStateChange", callback?: Callback<BondStateParam>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
---- | ---- | --------------------
---------------------------------------- |
| type | string
| 是 | 填写"bondStateChange"字符串，表示蓝牙配对状态改变事件。
|
| callback | Callback
<
[BondStateParam](#bondstate)
>
| 否 | 表示取消订阅蓝牙配对状态改变事件上报。不填该参数则取消订阅该type对应的所有回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是 | 填写"bondStateChange"字符串，表示蓝牙配对状态改变事件。
|
| callback | Callback
<
[BondStateParam](#bondstate)
>
| 否
| 表示取消订阅蓝牙配对状态改变事件上报。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
...
...
@@ -680,10 +678,10 @@ on(type: "stateChange", callback: Callback<BluetoothState>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--------- | ---- | ----------------------------
-------------------------------- |
| type | string
| 是 | 填写"stateChange"字符串，表示蓝牙状态改变事件。
|
| callback | Callback
<
[BluetoothState](#bluetoothstate)
>
| 是 | 表示回调函数的入参，蓝牙状态。回调函数由用户创建通过该接口注册。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
-------------------------------- |
| type | string
| 是 | 填写"stateChange"字符串，表示蓝牙状态改变事件。
|
| callback | Callback
<
[BluetoothState](#bluetoothstate)
>
| 是
| 表示回调函数的入参，蓝牙状态。回调函数由用户创建通过该接口注册。 |
**返回值：**
...
...
@@ -711,10 +709,10 @@ off(type: "stateChange", callback?: Callback<BluetoothState>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--------- | ---- | --------------------
---------------------------------------- |
| type | string
| 是 | 填写"stateChange"字符串，表示蓝牙状态改变事件。
|
| callback | Callback
<
[BluetoothState](#bluetoothstate)
>
| 否 | 表示取消订阅蓝牙状态改变事件上报。不填该参数则取消订阅该type对应的所有回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是 | 填写"stateChange"字符串，表示蓝牙状态改变事件。
|
| callback | Callback
<
[BluetoothState](#bluetoothstate)
>
| 否
| 表示取消订阅蓝牙状态改变事件上报。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
...
...
@@ -743,11 +741,11 @@ sppListen(name: string, option: SppOption, callback: AsyncCallback<number>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | -----------------------
---------------
|
| name | string | 是
| 服务的名称。
|
| option |
[
SppOption
](
#sppoption
)
| 是
| spp监听配置参数。
|
| callback | AsyncCallback
<
number
>
| 是 | 表示回调函数的入参，服务端Socket的id。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ----------------------- |
| name | string | 是
| 服务的名称。
|
| option |
[
SppOption
](
#sppoption
)
| 是
| spp监听配置参数。
|
| callback | AsyncCallback
<
number
>
| 是
| 表示回调函数的入参，服务端Socket的id。 |
**示例：**
...
...
@@ -776,10 +774,10 @@ sppAccept(serverSocket: number, callback: AsyncCallback<number>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------------ | --------------------------- | ---- | -----------------------
---------------
|
| serverSocket | number | 是
| 服务端socket的id。
|
| callback | AsyncCallback
<
number
>
| 是 | 表示回调函数的入参，客户端socket的id。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------------ | --------------------------- | ---- | ----------------------- |
| serverSocket | number | 是
| 服务端socket的id。
|
| callback | AsyncCallback
<
number
>
| 是
| 表示回调函数的入参，客户端socket的id。 |
**示例：**
...
...
@@ -809,11 +807,11 @@ sppConnect(device: string, option: SppOption, callback: AsyncCallback<number&
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ------------------------------
-----------
|
| device | string | 是 | 对端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| option |
[
SppOption
](
#sppoption
)
| 是
| spp客户端连接配置参数。
|
| callback | AsyncCallback
<
number
>
| 是
| 表示回调函数的入参，客户端socket的id。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ------------------------------ |
| device | string | 是
| 对端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| option |
[
SppOption
](
#sppoption
)
| 是
| spp客户端连接配置参数。
|
| callback | AsyncCallback
<
number
>
| 是
| 表示回调函数的入参，客户端socket的id。
|
**示例：**
...
...
@@ -842,9 +840,9 @@ sppCloseServerSocket(socket: number): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | ---------------
-------
|
| socket | number | 是 | 服务端监听socket的id。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | --------------- |
| socket | number | 是
| 服务端监听socket的id。 |
**示例：**
...
...
@@ -863,10 +861,10 @@ sppCloseClientSocket(socket: number): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | -------------
-----
|
| 参数名
| 类型 | 必填 | 说明
|
| socket | number | 是 | 客户端socket的id。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | ------------- |
| 参数名
| 类型 | 必填 | 说明
|
| socket | number | 是
| 客户端socket的id。 |
**示例：**
...
...
@@ -885,15 +883,15 @@ sppWrite(clientSocket: number, data: ArrayBuffer): boolean
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------------ | ----------- | ---- | -------------
-----
|
| clientSocket | number | 是 | 客户端socket的id。 |
| data | ArrayBuffer | 是
| 写入的数据。
|
| 参数名
| 类型 | 必填 | 说明
|
| ------------ | ----------- | ---- | ------------- |
| clientSocket | number | 是
| 客户端socket的id。 |
| data | ArrayBuffer | 是
| 写入的数据。
|
**返回值：**
| 类型
| 说明
|
| ------- | -------------------------
----------------
|
| 类型
| 说明
|
| ------- | ------------------------- |
| boolean | 写数据操作，成功返回true，否则返回false。 |
**示例：**
...
...
@@ -921,11 +919,11 @@ on(type: "sppRead", clientSocket: number, callback: Callback<ArrayBuffer>)
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------------ | --------------------------- | ---- | --------------------------
--------------
|
| type | string | 是 | 填写"sppRead"字符串，表示spp读请求事件。 |
| clientSocket | number | 是
| 客户端socket的id。
|
| callback | Callback
<
ArrayBuffer
>
| 是
| 表示回调函数的入参，读取到的数据。
|
| 参数名
| 类型 | 必填 | 说明
|
| ------------ | --------------------------- | ---- | -------------------------- |
| type | string | 是
| 填写"sppRead"字符串，表示spp读请求事件。 |
| clientSocket | number | 是
| 客户端socket的id。
|
| callback | Callback
<
ArrayBuffer
>
| 是
| 表示回调函数的入参，读取到的数据。
|
**返回值：**
...
...
@@ -952,11 +950,11 @@ off(type: "sppRead", clientSocket: number, callback?: Callback<ArrayBuffer>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------------ | --------------------------- | ---- | ----------------------------------------
--------------------
|
| type | string | 是
| 填写"sppRead"字符串，表示spp读请求事件。
|
| clientSocket | number | 是
| 客户端Socket的id。
|
| callback | Callback
<
ArrayBuffer
>
| 否 | 表示取消订阅spp读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------------ | --------------------------- | ---- | ---------------------------------------- |
| type | string | 是
| 填写"sppRead"字符串，表示spp读请求事件。
|
| clientSocket | number | 是
| 客户端Socket的id。
|
| callback | Callback
<
ArrayBuffer
>
| 否
| 表示取消订阅spp读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
...
...
@@ -979,20 +977,20 @@ getProfile(profileId: ProfileId): A2dpSourceProfile | HandsFreeAudioGatewayProfi
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | --------- | ---- | -------------------------------------
-----------
|
| ProfileId | profileId | 是 | 表示profile的枚举值，例如：PROFILE_A2DP_SOURCE。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------- | --------- | ---- | ------------------------------------- |
| ProfileId | profileId | 是
| 表示profile的枚举值，例如：PROFILE_A2DP_SOURCE。 |
**返回值：**
| 类型
| 说明
|
| ----------------------------------------
----------- | --------------------
---------------------------------------- |
| 类型
| 说明
|
| ----------------------------------------
|
---------------------------------------- |
| A2dpSourceProfile 或者 HandsFreeAudioGatewayProfile | 对应的profile的对象实例，当前支持A2dpSourceProfile， HandsFreeAudioGatewayProfile。 |
**示例：**
```
js
A2dpSourceProfile
a2dpSrc
=
bluetooth
.
getProfile
(
PROFILE_A2DP_SOURCE
);
let
a2dpSrc
=
bluetooth
.
getProfile
(
PROFILE_A2DP_SOURCE
);
```
...
...
@@ -1008,8 +1006,8 @@ createGattServer(): GattServer
**返回值：**
| 类型
| 说明
|
| ------------------------- | ------------------------------------
------------------------
|
| 类型
| 说明
|
| ------------------------- | ------------------------------------ |
|
[
GattServer
](
#gattserver
)
| server端类，使用server端方法之前需要创建该类的实例进行操作。 |
**示例：**
...
...
@@ -1029,14 +1027,14 @@ createGattClientDevice(deviceId: string): GattClientDevice
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ------------------------------------
-----------
|
| deviceId | string | 是 | 对端设备地址，
例如："XX:XX:XX:XX:XX:XX"。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ------------------------------------ |
| deviceId | string | 是
| 对端设备地址，
例如："XX:XX:XX:XX:XX:XX"。 |
**返回值：**
| 类型
| 说明
|
| ------------------------------------- | ------------------------------------
------------------------
|
| 类型
| 说明
|
| ------------------------------------- | ------------------------------------ |
|
[
GattClientDevice
](
#gattclientdevice
)
| client端类，使用client端方法之前需要创建该类的实例进行操作。 |
**示例：**
...
...
@@ -1058,8 +1056,8 @@ getConnectedBLEDevices(): Array<string>
**返回值：**
| 类型
| 说明
|
| ------------------- | -------------------
----------------
|
| 类型
| 说明
|
| ------------------- | ------------------- |
| Array
<
string
>
| 返回和当前设备连接BLE设备地址集合。 |
**示例：**
...
...
@@ -1081,10 +1079,10 @@ startBLEScan(filters: Array<ScanFilter>, options?: ScanOptions): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------- | -------------------------------------- | ---- | -----------------------------------
-------------------------
|
| filters | Array
<
[ScanFilter](#scanfilter)
>
| 是 | 表示扫描结果过滤策略集合，如果不使用过滤的方式，该参数设置为null。 |
| options |
[
ScanOptions
](
#scanoptions
)
| 否
| 表示扫描的参数配置，可选参数。
|
| 参数名
| 类型 | 必填 | 说明
|
| ------- | -------------------------------------- | ---- | ----------------------------------- |
| filters | Array
<
[ScanFilter](#scanfilter)
>
| 是
| 表示扫描结果过滤策略集合，如果不使用过滤的方式，该参数设置为null。 |
| options |
[
ScanOptions
](
#scanoptions
)
| 否
| 表示扫描的参数配置，可选参数。
|
**返回值：**
...
...
@@ -1145,10 +1143,10 @@ on(type: "BLEDeviceFind", callback: Callback<Array<ScanResult>>): vo
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------- | ---- | -------------------------
----------------------------------- |
| type | string
| 是 | 填写"BLEDeviceFind"字符串，表示BLE设备发现事件。
|
| callback | Callback
<
Array
<
[ScanResult](#scanresult)
>>
| 是 | 表示回调函数的入参，发现的设备集合。回调函数由用户创建通过该接口注册。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
----------------------------------- |
| type | string
| 是 | 填写"BLEDeviceFind"字符串，表示BLE设备发现事件。
|
| callback | Callback
<
Array
<
[ScanResult](#scanresult)
>>
| 是
| 表示回调函数的入参，发现的设备集合。回调函数由用户创建通过该接口注册。 |
**返回值：**
...
...
@@ -1176,10 +1174,10 @@ off(type: "BLEDeviceFind", callback?: Callback<Array<ScanResult>>):
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------- | ---- | --------------------
---------------------------------------- |
| type | string
| 是 | 填写"BLEDeviceFind"字符串，表示BLE设备发现事件。
|
| callback | Callback
<
Array
<
[ScanResult](#scanresult)
>>
| 否 | 表示取消订阅BLE设备发现事件上报。不填该参数则取消订阅该type对应的所有回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是 | 填写"BLEDeviceFind"字符串，表示BLE设备发现事件。
|
| callback | Callback
<
Array
<
[ScanResult](#scanresult)
>>
| 否
| 表示取消订阅BLE设备发现事件上报。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
...
...
@@ -1217,9 +1215,9 @@ getConnectionDevices(): Array<string>
**返回值：**
| |
|
| ------------------- | -------------
-------------
|
| 类型
| 说明
|
| | |
| ------------------- | ------------- |
| 类型
| 说明
|
| Array
<
string
>
| 返回已连接设备的地址列表。 |
...
...
@@ -1235,16 +1233,16 @@ getDeviceState(device: string): ProfileConnectionState
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | -------
-------
|
| device | string | 是 | 远端设备地址。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | ------- |
| device | string | 是
| 远端设备地址。 |
|
**返回值：**
|
|
|
| ----------------------------------------
--------- | --------
--------------- |
| 类型
| 说明
|
|
|
|
| ----------------------------------------
|
--------------- |
| 类型
| 说明
|
|
[
ProfileConnectionState
](
#profileconnectionState
)
| 返回profile的连接状态。 |
...
...
@@ -1265,23 +1263,23 @@ connect(device: string): boolean
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | -------
-------
|
| device | string | 是 | 远端设备地址。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | ------- |
| device | string | 是
| 远端设备地址。 |
|
**返回值：**
| |
|
| ------- | -------------------
----------
|
| 类型
| 说明
|
| | |
| ------- | ------------------- |
| 类型
| 说明
|
| boolean | 成功返回true，失败返回false。 |
**示例：**
```
js
A2dpSourceProfile
a2dpSrc
=
bluetooth
.
getProfile
(
PROFILE_A2DP_SOURCE
);
boolean
ret
=
a2dpSrc
.
connect
(
'
XX:XX:XX:XX:XX:XX
'
);
let
a2dpSrc
=
bluetooth
.
getProfile
(
PROFILE_A2DP_SOURCE
)
let
ret
=
a2dpSrc
.
connect
(
'
XX:XX:XX:XX:XX:XX
'
);
```
...
...
@@ -1297,23 +1295,23 @@ disconnect(device: string): boolean
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | -------
-------
|
| device | string | 是 | 远端设备地址。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | ------- |
| device | string | 是
| 远端设备地址。 |
|
**返回值：**
| |
|
| ------- | -------------------
----------
|
| 类型
| 说明
|
| | |
| ------- | ------------------- |
| 类型
| 说明
|
| boolean | 成功返回true，失败返回false。 |
**示例：**
```
js
A2dpSourceProfile
a2dpSrc
=
bluetooth
.
getProfile
(
PROFILE_A2DP_SOURCE
);
boolean
ret
=
a2dpSrc
.
disconnect
(
'
XX:XX:XX:XX:XX:XX
'
);
let
a2dpSrc
=
bluetooth
.
getProfile
(
PROFILE_A2DP_SOURCE
);
let
boolean
ret
=
a2dpSrc
.
disconnect
(
'
XX:XX:XX:XX:XX:XX
'
);
```
...
...
@@ -1327,10 +1325,10 @@ on(type: "connectionStateChange", callback: Callback<[StateChangeParam](#Stat
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
------------- | ---- | -----------------
---------------------------------------- |
| type | string
| 是
| 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback
<
[StateChangeParam](#StateChangeParam)
>
| 是
| 表示回调函数的入参。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是
| 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback
<
[StateChangeParam](#StateChangeParam)
>
| 是
| 表示回调函数的入参。
|
**返回值：**
...
...
@@ -1356,10 +1354,10 @@ off(type: "connectionStateChange", callback: Callback<[StateChangeParam](#Sta
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
------------- | ---- | -----------------
---------------------------------------- |
| type | string
| 是
| 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback
<
[StateChangeParam](#StateChangeParam)
>
| 是
| 表示回调函数的入参。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是
| 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback
<
[StateChangeParam](#StateChangeParam)
>
| 是
| 表示回调函数的入参。
|
**返回值：**
...
...
@@ -1385,22 +1383,22 @@ getPlayingState(device: string): PlayingState
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | -------
-------
|
| device | string | 是 | 远端设备地址。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | ------- |
| device | string | 是
| 远端设备地址。 |
**返回值：**
| |
|
| ----------------------------- | ----------
----------
|
| 类型
| 说明
|
| | |
| ----------------------------- | ---------- |
| 类型
| 说明
|
|
[
PlayingState
](
#PlayingState
)
| 远端设备的播放状态。 |
**示例：**
```
js
A2dpSourceProfile
a2dpSrc
=
bluetooth
.
getProfile
(
PROFILE_A2DP_SOURCE
);
PlayingState
state
=
a2dpSrc
.
getPlayingState
(
'
XX:XX:XX:XX:XX:XX
'
);
let
a2dpSrc
=
bluetooth
.
getProfile
(
PROFILE_A2DP_SOURCE
);
let
state
=
a2dpSrc
.
getPlayingState
(
'
XX:XX:XX:XX:XX:XX
'
);
```
...
...
@@ -1421,23 +1419,23 @@ connect(device: string): boolean
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | -------
-------
|
| device | string | 是 | 远端设备地址。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | ------- |
| device | string | 是
| 远端设备地址。 |
|
**返回值：**
| |
|
| ------- | -------------------
----------
|
| 类型
| 说明
|
| | |
| ------- | ------------------- |
| 类型
| 说明
|
| boolean | 成功返回true，失败返回false。 |
**示例：**
```
js
HandsFreeAudioGatewayProfile
hfpAg
=
bluetooth
.
getProfile
(
PROFILE_HANDS_FREE_AUDIO_GATEWAY
);
boolean
ret
=
hfpAg
.
connect
(
'
XX:XX:XX:XX:XX:XX
'
);
let
hfpAg
=
bluetooth
.
getProfile
(
PROFILE_HANDS_FREE_AUDIO_GATEWAY
);
let
ret
=
hfpAg
.
connect
(
'
XX:XX:XX:XX:XX:XX
'
);
```
...
...
@@ -1453,22 +1451,22 @@ disconnect(device: string): boolean
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | -------
-------
|
| device | string | 是 | 远端设备地址。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ------ | ---- | ------- |
| device | string | 是
| 远端设备地址。 |
|
**返回值：**
| 类型
| 说明
|
| ------- | -------------------
----------
|
| 类型
| 说明
|
| ------- | ------------------- |
| boolean | 成功返回true，失败返回false。 |
**示例：**
```
js
HandsFreeAudioGatewayProfile
hfpAg
=
bluetooth
.
getProfile
(
PROFILE_HANDS_FREE_AUDIO_GATEWAY
);
boolean
ret
=
hfpAg
.
disconnect
(
'
XX:XX:XX:XX:XX:XX
'
);
let
hfpAg
=
bluetooth
.
getProfile
(
PROFILE_HANDS_FREE_AUDIO_GATEWAY
);
let
ret
=
hfpAg
.
disconnect
(
'
XX:XX:XX:XX:XX:XX
'
);
```
...
...
@@ -1482,10 +1480,10 @@ on(type: "connectionStateChange", callback: Callback<[StateChangeParam](#Stat
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
------------- | ---- | -----------------
---------------------------------------- |
| type | string
| 是
| 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback
<
[StateChangeParam](#StateChangeParam)
>
| 是
| 表示回调函数的入参。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是
| 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback
<
[StateChangeParam](#StateChangeParam)
>
| 是
| 表示回调函数的入参。
|
**返回值：**
...
...
@@ -1511,10 +1509,10 @@ off(type: "connectionStateChange", callback: Callback<[StateChangeParam](#Sta
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
------------- | ---- | -----------------
---------------------------------------- |
| type | string
| 是
| 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback
<
[StateChangeParam](#StateChangeParam)
>
| 是
| 表示回调函数的入参。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是
| 填写"connectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback
<
[StateChangeParam](#StateChangeParam)
>
| 是
| 表示回调函数的入参。
|
**返回值：**
...
...
@@ -1547,11 +1545,11 @@ startAdvertising(setting: AdvertiseSetting, advData: AdvertiseData, advResponse?
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ----------- | ------------------------------------- | ---- | --------------
-----------
|
| setting |
[
AdvertiseSetting
](
#advertisesetting
)
| 是
| BLE广播的相关参数。
|
| advData |
[
AdvertiseData
](
#advertisedata
)
| 是
| BLE广播包内容。
|
| advResponse |
[
AdvertiseData
](
#advertisedata
)
| 否 | BLE回复扫描请求回复响应。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----------- | ------------------------------------- | ---- | -------------- |
| setting |
[
AdvertiseSetting
](
#advertisesetting
)
| 是
| BLE广播的相关参数。
|
| advData |
[
AdvertiseData
](
#advertisedata
)
| 是
| BLE广播包内容。
|
| advResponse |
[
AdvertiseData
](
#advertisedata
)
| 否
| BLE回复扫描请求回复响应。 |
**返回值：**
...
...
@@ -1636,14 +1634,14 @@ server端添加服务。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------- | --------------------------- | ---- | ------------------------
--------------
|
| service |
[
GattService
](
#gattservice
)
| 是 | 服务端的service数据。BLE广播的相关参数 |
| 参数名
| 类型 | 必填 | 说明
|
| ------- | --------------------------- | ---- | ------------------------ |
| service |
[
GattService
](
#gattservice
)
| 是
| 服务端的service数据。BLE广播的相关参数 |
**返回值：**
| 类型
| 说明
|
| ------- | --------------------------
-----------------
|
| 类型
| 说明
|
| ------- | -------------------------- |
| boolean | 添加服务操作，成功返回true，否则返回false。 |
**示例：**
...
...
@@ -1695,15 +1693,15 @@ 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。 |
**示例：**
...
...
@@ -1744,16 +1742,16 @@ server端特征值发生变化时，主动通知已连接的client设备。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------------------- | ----------------------------------------
----- | ---- | --------------
--------------------------------------- |
| deviceId | string
| 是
| 接收通知的client端设备地址，例如“XX:XX:XX:XX:XX:XX”。 |
| notifyCharacteristic |
[
NotifyCharacteristic
](
#notifycharacteristic
)
| 是
| 通知的特征值数据。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------------------- | ----------------------------------------
| ---- |
--------------------------------------- |
| deviceId | string
| 是
| 接收通知的client端设备地址，例如“XX:XX:XX:XX:XX:XX”。 |
| notifyCharacteristic |
[
NotifyCharacteristic
](
#notifycharacteristic
)
| 是
| 通知的特征值数据。
|
**返回值：**
| |
|
| ------- | ------------------------
---------------
|
| 类型
| 说明
|
| | |
| ------- | ------------------------ |
| 类型
| 说明
|
| boolean | 通知操作，成功返回true，否则返回false。 |
**示例：**
...
...
@@ -1778,15 +1776,15 @@ server端回复client端的读写请求。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | --------------------------------- | ---- | ---------------
---------
|
| serverResponse |
[
ServerResponse
](
#serverresponse
)
| 是 | server端回复的响应数据。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | --------------------------------- | ---- | --------------- |
| serverResponse |
[
ServerResponse
](
#serverresponse
)
| 是
| server端回复的响应数据。 |
**返回值：**
| |
|
| ------- | --------------------------
-----------------
|
| 类型
| 说明
|
| | |
| ------- | -------------------------- |
| 类型
| 说明
|
| boolean | 回复响应操作，成功返回true，否则返回false。 |
**示例：**
...
...
@@ -1826,10 +1824,10 @@ server端订阅特征值读请求事件。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | -----------------
------------------------------------- |
| type | string
| 是
| 填写"characteristicRead"字符串，表示特征值读请求事件。 |
| callback | Callback
<
[CharacteristicReadReq](#characteristicreadreq)
>
| 是
| 表示回调函数的入参，client端发送的读请求数据。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
------------------------------------- |
| type | string
| 是
| 填写"characteristicRead"字符串，表示特征值读请求事件。 |
| callback | Callback
<
[CharacteristicReadReq](#characteristicreadreq)
>
| 是
| 表示回调函数的入参，client端发送的读请求数据。
|
**返回值：**
...
...
@@ -1874,10 +1872,10 @@ server端取消订阅特征值读请求事件。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type | string
| 是 | 填写"characteristicRead"字符串，表示特征值读请求事件。
|
| callback | Callback
<
[CharacteristicReadReq](#characteristicreadreq)
>
| 否 | 表示取消订阅特征值读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是 | 填写"characteristicRead"字符串，表示特征值读请求事件。
|
| callback | Callback
<
[CharacteristicReadReq](#characteristicreadreq)
>
| 否
| 表示取消订阅特征值读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
...
...
@@ -1903,10 +1901,10 @@ server端订阅特征值写请求事件。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
----------------- | ---- | -----------------
-------------------------------------- |
| type | string
| 是
| 填写"characteristicWrite"字符串，表示特征值写请求事件。 |
| callback | Callback
<
[DescriptorWriteReq](#descriptorwritereq)
>
| 是
| 表示回调函数的入参，client端发送的写请求数据。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
-------------------------------------- |
| type | string
| 是
| 填写"characteristicWrite"字符串，表示特征值写请求事件。 |
| callback | Callback
<
[DescriptorWriteReq](#descriptorwritereq)
>
| 是
| 表示回调函数的入参，client端发送的写请求数据。
|
**返回值：**
...
...
@@ -1954,10 +1952,10 @@ server端取消订阅特征值写请求事件。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type | string
| 是 | 填写"characteristicWrite"字符串，表示特征值写请求事件。
|
| callback | Callback
<
[CharacteristicWriteReq](#characteristicwritereq)
>
| 否 | 表示取消订阅特征值写请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是 | 填写"characteristicWrite"字符串，表示特征值写请求事件。
|
| callback | Callback
<
[CharacteristicWriteReq](#characteristicwritereq)
>
| 否
| 表示取消订阅特征值写请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
...
...
@@ -1983,10 +1981,10 @@ server端订阅描述符读请求事件。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--------------- | ---- | -----------------
--------------------------------- |
| type | string
| 是
| 填写"descriptorRead"字符串，表示描述符读请求事件。 |
| callback | Callback
<
[DescriptorReadReq](#descriptorreadreq)
>
| 是
| 表示回调函数的入参，client端发送的读请求数据。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
--------------------------------- |
| type | string
| 是
| 填写"descriptorRead"字符串，表示描述符读请求事件。 |
| callback | Callback
<
[DescriptorReadReq](#descriptorreadreq)
>
| 是
| 表示回调函数的入参，client端发送的读请求数据。
|
**返回值：**
...
...
@@ -2031,10 +2029,10 @@ server端取消订阅描述符读请求事件。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--------------- | ---- | --------------------
---------------------------------------- |
| type | string
| 是 | 填写"descriptorRead"字符串，表示描述符读请求事件。
|
| callback | Callback
<
[DescriptorReadReq](#descriptorreadreq)
>
| 否 | 表示取消订阅描述符读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是 | 填写"descriptorRead"字符串，表示描述符读请求事件。
|
| callback | Callback
<
[DescriptorReadReq](#descriptorreadreq)
>
| 否
| 表示取消订阅描述符读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
...
...
@@ -2060,10 +2058,10 @@ server端订阅描述符写请求事件。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
----------------- | ---- | -----------------
---------------------------------- |
| type | string
| 是
| 填写"descriptorWrite"字符串，表示描述符写请求事件。 |
| callback | Callback
<
[DescriptorWriteReq](#descriptorwritereq)
>
| 是
| 表示回调函数的入参，client端发送的写请求数据。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------- |
| type | string
| 是
| 填写"descriptorWrite"字符串，表示描述符写请求事件。 |
| callback | Callback
<
[DescriptorWriteReq](#descriptorwritereq)
>
| 是
| 表示回调函数的入参，client端发送的写请求数据。
|
**返回值：**
...
...
@@ -2111,10 +2109,10 @@ server端取消订阅描述符写请求事件。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
----------------- | ---- | --------------------
---------------------------------------- |
| type | string
| 是 | 填写"descriptorWrite"字符串，表示描述符写请求事件。
|
| callback | Callback
<
[DescriptorWriteReq](#descriptorwritereq)
>
| 否 | 表示取消订阅描述符写请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是 | 填写"descriptorWrite"字符串，表示描述符写请求事件。
|
| callback | Callback
<
[DescriptorWriteReq](#descriptorwritereq)
>
| 否
| 表示取消订阅描述符写请求事件上报。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
...
...
@@ -2140,10 +2138,10 @@ server端订阅BLE连接状态变化事件。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | -----------------
---------------------------------------- |
| type | string
| 是
| 填写"connectStateChange"字符串，表示BLE连接状态变化事件。 |
| callback | Callback
<
[BLEConnectChangedState](#bleconnectchangedstate)
>
| 是
| 表示回调函数的入参，连接状态。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是
| 填写"connectStateChange"字符串，表示BLE连接状态变化事件。 |
| callback | Callback
<
[BLEConnectChangedState](#bleconnectchangedstate)
>
| 是
| 表示回调函数的入参，连接状态。
|
**返回值：**
...
...
@@ -2174,10 +2172,10 @@ server端取消订阅BLE连接状态变化事件。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type | string
| 是 | 填写"connectStateChange"字符串，表示BLE连接状态变化事件。
|
| callback | Callback
<
[BLEConnectChangedState](#bleconnectchangedstate)
>
| 否 | 表示取消订阅BLE连接状态变化事件。不填该参数则取消订阅该type对应的所有回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是 | 填写"connectStateChange"字符串，表示BLE连接状态变化事件。
|
| callback | Callback
<
[BLEConnectChangedState](#bleconnectchangedstate)
>
| 否
| 表示取消订阅BLE连接状态变化事件。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
...
...
@@ -2208,8 +2206,8 @@ client端发起连接远端蓝牙低功耗设备。
**返回值：**
| 类型
| 说明
|
| ------- | -------------------------
----------------
|
| 类型
| 说明
|
| ------- | ------------------------- |
| boolean | 连接操作成功返回true，操作失败返回false。 |
**示例：**
...
...
@@ -2232,8 +2230,8 @@ client端断开与远端蓝牙低功耗设备的连接。
**返回值：**
| 类型
| 说明
|
| ------- | ----------------------------
-------------------
|
| 类型
| 说明
|
| ------- | ---------------------------- |
| boolean | 断开连接操作，成功返回true，操作失败返回false。 |
**示例：**
...
...
@@ -2256,8 +2254,8 @@ close(): boolean
**返回值：**
| 类型
| 说明
|
| ------- | --------------------------
-----------------
|
| 类型
| 说明
|
| ------- | -------------------------- |
| boolean | 关闭操作，成功返回true，操作失败返回false。 |
**示例：**
...
...
@@ -2282,9 +2280,9 @@ client端获取蓝牙低功耗设备的所有服务，即服务发现 。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | ------------------
------------------------ |
| callback | AsyncCallback
<
Array
<
[GattService](#gattservice)
>>
| 是 | client进行服务发现，通过注册回调函数获取。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
------------------------ |
| callback | AsyncCallback
<
Array
<
[GattService](#gattservice)
>>
| 是
| client进行服务发现，通过注册回调函数获取。 |
**返回值：**
...
...
@@ -2326,8 +2324,8 @@ client端获取蓝牙低功耗设备的所有服务，即服务发现。
**返回值：**
| 类型
| 说明
|
| ----------------------------------------
--------------- | --------------
--------------------------- |
| 类型
| 说明
|
| ----------------------------------------
|
--------------------------- |
| Promise
<
Array
<
[GattService](#gattservice)
>>
| client进行服务发现，通过promise形式获取。 |
**示例：**
...
...
@@ -2357,10 +2355,10 @@ client端读取蓝牙低功耗设备特定服务的特征值。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ----------------------------------------
-------------------- | ---- | -----------------
----------------------- |
| characteristic |
[
BLECharacteristic
](
#blecharacteristic
)
| 是 | 待读取的特征值。
|
| callback | AsyncCallback
<
[BLECharacteristic](#blecharacteristic)
>
| 是 | client读取特征值，通过注册回调函数获取。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ----------------------------------------
| ---- |
----------------------- |
| characteristic |
[
BLECharacteristic
](
#blecharacteristic
)
| 是 | 待读取的特征值。
|
| callback | AsyncCallback
<
[BLECharacteristic](#blecharacteristic)
>
| 是
| client读取特征值，通过注册回调函数获取。 |
**返回值：**
...
...
@@ -2411,15 +2409,15 @@ client端读取蓝牙低功耗设备特定服务的特征值。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | --------------------------------------- | ---- | --------
--------
|
| characteristic |
[
BLECharacteristic
](
#blecharacteristic
)
| 是 | 待读取的特征值。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | --------------------------------------- | ---- | -------- |
| characteristic |
[
BLECharacteristic
](
#blecharacteristic
)
| 是
| 待读取的特征值。 |
**返回值：**
|
|
|
| ----------------------------------------
-------------- | -------------
-------------------------- |
| 类型
| 说明
|
|
|
|
| ----------------------------------------
|
-------------------------- |
| 类型
| 说明
|
| Promise
<
[BLECharacteristic](#blecharacteristic)
>
| client读取特征值，通过promise形式获取。 |
**示例：**
...
...
@@ -2458,10 +2456,10 @@ client端读取蓝牙低功耗设备特定的特征包含的描述符。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ----------------------------------------
-------------------- | ---- | -----------------
----------------------- |
| descriptor |
[
BLEDescriptor
](
#bledescriptor
)
| 是 | 待读取的描述符。
|
| callback | AsyncCallback
<
[BLECharacteristic](#blecharacteristic)
>
| 是 | client读取描述符，通过注册回调函数获取。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ----------------------------------------
| ---- |
----------------------- |
| descriptor |
[
BLEDescriptor
](
#bledescriptor
)
| 是 | 待读取的描述符。
|
| callback | AsyncCallback
<
[BLECharacteristic](#blecharacteristic)
>
| 是
| client读取描述符，通过注册回调函数获取。 |
**返回值：**
...
...
@@ -2502,15 +2500,15 @@ client端读取蓝牙低功耗设备特定的特征包含的描述符。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------------- | ---- | --------
--------
|
| descriptor |
[
BLEDescriptor
](
#bledescriptor
)
| 是 | 待读取的描述符。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------------- | ---- | -------- |
| descriptor |
[
BLEDescriptor
](
#bledescriptor
)
| 是
| 待读取的描述符。 |
**返回值：**
|
|
|
| ----------------------------------------
------ | -------------
-------------------------- |
| 类型
| 说明
|
|
|
|
| ----------------------------------------
|
-------------------------- |
| 类型
| 说明
|
| Promise
<
[BLEDescriptor](#bledescriptor)
>
| client读取描述符，通过promise形式获取。 |
**示例：**
...
...
@@ -2539,14 +2537,14 @@ client端向低功耗蓝牙设备写入特定的特征值。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | --------------------------------------- | ---- | -------------------
-------------------
|
| characteristic |
[
BLECharacteristic
](
#blecharacteristic
)
| 是 | 蓝牙设备特征对应的二进制值及其它参数。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | --------------------------------------- | ---- | ------------------- |
| characteristic |
[
BLECharacteristic
](
#blecharacteristic
)
| 是
| 蓝牙设备特征对应的二进制值及其它参数。 |
**返回值：**
| 类型
| 说明
|
| ------- | ---------------------------
------------------
|
| 类型
| 说明
|
| ------- | --------------------------- |
| boolean | 写特征值操作成功返回true，操作失败返回false。 |
**示例：**
...
...
@@ -2589,14 +2587,14 @@ client端向低功耗蓝牙设备特定的描述符写入二进制数据。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------------- | ---- | ------------------
------------------
|
| descriptor |
[
BLEDescriptor
](
#bledescriptor
)
| 是 | 蓝牙设备描述符的二进制值及其它参数。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------------- | ---- | ------------------ |
| descriptor |
[
BLEDescriptor
](
#bledescriptor
)
| 是
| 蓝牙设备描述符的二进制值及其它参数。 |
**返回值：**
| 类型
| 说明
|
| ------- | ---------------------------
------------------
|
| 类型
| 说明
|
| ------- | --------------------------- |
| boolean | 写描述符操作成功返回true，操作失败返回false。 |
**示例：**
...
...
@@ -2630,14 +2628,14 @@ client协商远端蓝牙低功耗设备的最大传输单元（Maximum Transmiss
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ----
-- | ------ | ---- | --------
-------------- |
| mtu
| number | 是
| 设置范围为22~512字节。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- |
-------------- |
| mtu
| number | 是
| 设置范围为22~512字节。 |
**返回值：**
| 类型
| 说明
|
| ------- | ----------------------------
----------------
|
| 类型
| 说明
|
| ------- | ---------------------------- |
| boolean | MTU协商操作成功返回true，操作失败返回false。 |
**示例：**
...
...
@@ -2660,15 +2658,15 @@ setNotifyCharacteristicChanged(characteristic: BLECharacteristic, enable: boolea
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | --------------------------------------- | ---- | -----------------------------
--------------
|
| characteristic |
[
BLECharacteristic
](
#blecharacteristic
)
| 是
| 蓝牙低功耗特征。
|
| enable | boolean | 是 | 启用接收notify设置为true，否则设置为false。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | --------------------------------------- | ---- | ----------------------------- |
| characteristic |
[
BLECharacteristic
](
#blecharacteristic
)
| 是
| 蓝牙低功耗特征。
|
| enable | boolean | 是
| 启用接收notify设置为true，否则设置为false。 |
**返回值：**
| 类型
| 说明
|
| ------- | -------------------------
----------------
|
| 类型
| 说明
|
| ------- | ------------------------- |
| boolean | 设置操作成功返回true，操作失败返回false。 |
**示例：**
...
...
@@ -2691,10 +2689,10 @@ on(type: "BLECharacteristicChange", callback: Callback<BLECharacteristic>)
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--------------- | ---- | -----------------
---------------------------------------- |
| type | string
| 是
| 填写"BLECharacteristicChange"字符串，表示特征值变化事件。 |
| callback | Callback
<
[BLECharacteristic](#blecharacteristic)
>
| 是
| 表示蓝牙低功耗设备的特征值变化事件的回调函数。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是
| 填写"BLECharacteristicChange"字符串，表示特征值变化事件。 |
| callback | Callback
<
[BLECharacteristic](#blecharacteristic)
>
| 是
| 表示蓝牙低功耗设备的特征值变化事件的回调函数。
|
**返回值：**
...
...
@@ -2725,10 +2723,10 @@ off(type: "BLECharacteristicChange", callback?: Callback<BLECharacteristic>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--------------- | ---- | --------------------
---------------------------------------- |
| type | string
| 是 | 填写"BLECharacteristicChange"字符串，表示特征值变化事件。
|
| callback | Callback
<
[BLECharacteristic](#blecharacteristic)
>
| 否 | 表示取消订阅蓝牙低功耗设备的特征值变化事件。不填该参数则取消订阅该type对应的所有回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是 | 填写"BLECharacteristicChange"字符串，表示特征值变化事件。
|
| callback | Callback
<
[BLECharacteristic](#blecharacteristic)
>
| 否
| 表示取消订阅蓝牙低功耗设备的特征值变化事件。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
...
...
@@ -2754,10 +2752,10 @@ client端订阅蓝牙低功耗设备的连接状态变化事件。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type | string
| 是
| 填写"BLEConnectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback
<
[BLEConnectChangedState](#bleconnectchangedstate)
>
| 是
| 表示连接状态，已连接或断开。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是
| 填写"BLEConnectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback
<
[BLEConnectChangedState](#bleconnectchangedstate)
>
| 是
| 表示连接状态，已连接或断开。
|
**返回值：**
...
...
@@ -2787,10 +2785,10 @@ off(type: "BLEConnectionStateChange", callback?: Callback<BLEConnectChangedSt
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type | string
| 是
| 填写"BLEConnectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback
<
[BLEConnectChangedState](#bleconnectchangedstate)
>
| 否 | 表示取消订阅蓝牙低功耗设备的连接状态变化事件。不填该参数则取消订阅该type对应的所有回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type | string
| 是
| 填写"BLEConnectionStateChange"字符串，表示连接状态变化事件。 |
| callback | Callback
<
[BLEConnectChangedState](#bleconnectchangedstate)
>
| 否
| 表示取消订阅蓝牙低功耗设备的连接状态变化事件。不填该参数则取消订阅该type对应的所有回调。 |
**返回值：**
...
...
@@ -2816,9 +2814,9 @@ client获取远端蓝牙低功耗设备名。
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | -------------------------------
-------------------
|
| callback | AsyncCallback
<
string
>
| 是 | client获取对端server设备名，通过注册回调函数获取。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ------------------------------- |
| callback | AsyncCallback
<
string
>
| 是
| client获取对端server设备名，通过注册回调函数获取。 |
**返回值：**
...
...
@@ -2848,8 +2846,8 @@ client获取远端蓝牙低功耗设备名。
**返回值：**
| 类型
| 说明
|
| --------------------- | ----------------------------------
---------------
|
| 类型
| 说明
|
| --------------------- | ---------------------------------- |
| Promise
<
string
>
| client获取对端server设备名，通过promise形式获取。 |
**示例：**
...
...
@@ -2876,9 +2874,9 @@ client获取远端蓝牙低功耗设备的信号强度 (Received Signal Strength
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ------------------------------
---------------------
|
| callback | AsyncCallback
<
number
>
| 是 | 返回信号强度，单位
dBm，通过注册回调函数获取。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ------------------------------ |
| callback | AsyncCallback
<
number
>
| 是
| 返回信号强度，单位
dBm，通过注册回调函数获取。 |
**返回值：**
...
...
@@ -2909,8 +2907,8 @@ client获取远端蓝牙低功耗设备的信号强度 (Received Signal Strength
**返回值：**
| 类型
| 说明
|
| --------------------- | ---------------------------------
-----------------
|
| 类型
| 说明
|
| --------------------- | --------------------------------- |
| Promise
<
number
>
| 返回信号强度，单位
dBm，通过promise形式获取。 |
**示例：**
...
...
@@ -2929,14 +2927,14 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 默认值
| 说明
|
| ----------------------------------------
-- | ------ | --------
--------------- |
| SCAN_MODE_NONE
| 0 | 没有扫描模式。
|
| SCAN_MODE_CONNECTABLE
| 1
| 可连接扫描模式。 |
| SCAN_MODE_GENERAL_DISCOVERABLE
| 2 | general发现模式。
|
| SCAN_MODE_LIMITED_DISCOVERABLE
| 3 | limited发现模式。
|
| SCAN_MODE_CONNECTABLE_GENERAL_DISCOVERABLE | 4
| 可连接general发现模式。 |
| SCAN_MODE_CONNECTABLE_LIMITED_DISCOVERABLE | 5
| 可连接limited发现模式。 |
| 名称 | 默认值
| 说明
|
| ----------------------------------------
| ---- |
--------------- |
| SCAN_MODE_NONE
| 0 | 没有扫描模式。
|
| SCAN_MODE_CONNECTABLE
| 1
| 可连接扫描模式。 |
| SCAN_MODE_GENERAL_DISCOVERABLE
| 2 | general发现模式。
|
| SCAN_MODE_LIMITED_DISCOVERABLE
| 3 | limited发现模式。
|
| SCAN_MODE_CONNECTABLE_GENERAL_DISCOVERABLE | 4 | 可连接general发现模式。 |
| SCAN_MODE_CONNECTABLE_LIMITED_DISCOVERABLE | 5 | 可连接limited发现模式。 |
## BondState<sup>8+</sup><a name="BondState"></a>
...
...
@@ -2944,11 +2942,11 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 默认值 | 说明
|
| ------------------ | ----
-- | ------
------ |
| BOND_STATE_INVALID | 0
| 无效的配对。 |
| BOND_STATE_BONDING | 1
| 正在配对。
|
| BOND_STATE_BONDED | 2
| 已配对。
|
| 名称
| 默认值 | 说明
|
| ------------------ | ----
|
------ |
| BOND_STATE_INVALID | 0 | 无效的配对。 |
| BOND_STATE_BONDING | 1
| 正在配对。
|
| BOND_STATE_BONDED | 2
| 已配对。
|
## SppOption<sup>8+</sup><a name="SppOption"></a>
...
...
@@ -2957,11 +2955,11 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------ | ------------------- | ---- | ---- | -----------
-----
|
| uuid | string | 是
| 是 | spp单据的uuid。
|
| secure | boolean | 是
| 是 | 是否是安全通道。
|
| type |
[
SppType
](
#spptype
)
| 是
| 是
| Spp链路类型。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------ | ------------------- | ---- | ---- | ----------- |
| uuid | string | 是
| 是 | spp单据的uuid。
|
| secure | boolean | 是
| 是 | 是否是安全通道。
|
| type |
[
SppType
](
#spptype
)
| 是
| 是
| Spp链路类型。 |
## SppType<sup>8+</sup><a name="SppType"></a>
...
...
@@ -2970,9 +2968,9 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 默认值 | 说明
|
| ---------- | ----
-- | -------
------------- |
| SPP_RFCOMM | 0
| 表示rfcomm链路类型。 |
| 名称
| 默认值 | 说明
|
| ---------- | ----
|
------------- |
| SPP_RFCOMM | 0 | 表示rfcomm链路类型。 |
## GattService
...
...
@@ -2981,12 +2979,12 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------------- | ----------------------------------------
------------ | ---- | ---- | --------------------
---------------------------------------- |
| serviceUuid | string
| 是 | 是
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| isPrimary | boolean
| 是 | 是 | 如果是主服务设置为true，否则设置为false。
|
| characteristics | Array
<
[BLECharacteristic](#blecharacteristic)
>
| 是
| 是 | 当前服务包含的特征列表。
|
| includeServices | Array
<
[GattService](#gattservice)
>
| 是 | 是 | 当前服务依赖的其它服务。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------------- | ----------------------------------------
| ---- | ---- |
---------------------------------------- |
| serviceUuid | string
| 是 | 是
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| isPrimary | boolean
| 是 | 是 | 如果是主服务设置为true，否则设置为false。
|
| characteristics | Array
<
[BLECharacteristic](#blecharacteristic)
>
| 是
| 是 | 当前服务包含的特征列表。
|
| includeServices | Array
<
[GattService](#gattservice)
>
| 是 | 是 | 当前服务依赖的其它服务。
|
## BLECharacteristic
...
...
@@ -2995,12 +2993,12 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------- | ----------------------------------------
---- | ---- | ---- | --------------------
---------------------------------------- |
| serviceUuid | string
| 是 | 是
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string
| 是 | 是
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| characteristicValue | ArrayBuffer
| 是 | 是 | 特征对应的二进制值。
|
| descriptors | Array
<
[BLEDescriptor](#bledescriptor)
>
| 是
| 是 | 特定特征的描述符列表。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------- | ----------------------------------------
| ---- | ---- |
---------------------------------------- |
| serviceUuid | string
| 是 | 是
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string
| 是 | 是
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| characteristicValue | ArrayBuffer
| 是 | 是 | 特征对应的二进制值。
|
| descriptors | Array
<
[BLEDescriptor](#bledescriptor)
>
| 是
| 是 | 特定特征的描述符列表。
|
## BLEDescriptor
...
...
@@ -3009,12 +3007,12 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------ | ----------- | ---- | ---- | ----------------------------------------
--------------------
|
| serviceUuid | string | 是
| 是
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string | 是
| 是
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| descriptorUuid | string | 是
| 是
| 描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。 |
| descriptorValue | ArrayBuffer | 是
| 是 | 描述符对应的二进制值。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------ | ----------- | ---- | ---- | ---------------------------------------- |
| serviceUuid | string | 是
| 是
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string | 是
| 是
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| descriptorUuid | string | 是
| 是
| 描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。 |
| descriptorValue | ArrayBuffer | 是
| 是 | 描述符对应的二进制值。
|
## NotifyCharacteristic
...
...
@@ -3023,12 +3021,12 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------- | ----------- | ---- | ---- | ----------------------------------------
--------------------
|
| serviceUuid | string | 是
| 是
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string | 是
| 是
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| characteristicValue | ArrayBuffer | 是
| 是 | 特征对应的二进制值。
|
| confirm | boolean | 是
| 是
| 如果是notification则对端回复确认设置为true，如果是indication则对端不需要回复确认设置为false。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------- | ----------- | ---- | ---- | ---------------------------------------- |
| serviceUuid | string | 是
| 是
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string | 是
| 是
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| characteristicValue | ArrayBuffer | 是
| 是 | 特征对应的二进制值。
|
| confirm | boolean | 是
| 是
| 如果是notification则对端回复确认设置为true，如果是indication则对端不需要回复确认设置为false。 |
## CharacteristicReadReq
...
...
@@ -3037,13 +3035,13 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------ | ------
-- | ---- | ---- | --------------------
---------------------------------------- |
| deviceId | string
| 是 | 否
| 表示发送特征值读请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number
| 是 | 否 | 表示读请求的传输ID，server端回复响应时需填写相同的传输ID。
|
| offset | number
| 是 | 否
| 表示读特征值数据的起始位置。例如：k表示从第k个字节开始读，server端回复响应时需填写相同的offset。 |
| characteristicUuid | string
| 是 | 否
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| serviceUuid | string
| 是 | 否
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------ | ------
| ---- | ---- |
---------------------------------------- |
| deviceId | string
| 是 | 否
| 表示发送特征值读请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number
| 是 | 否 | 表示读请求的传输ID，server端回复响应时需填写相同的传输ID。
|
| offset | number
| 是 | 否
| 表示读特征值数据的起始位置。例如：k表示从第k个字节开始读，server端回复响应时需填写相同的offset。 |
| characteristicUuid | string
| 是 | 否
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| serviceUuid | string
| 是 | 否
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
## CharacteristicWriteReq
...
...
@@ -3052,14 +3050,14 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------ | ------
-- | ---- | ---- | --------------------
---------------------------------------- |
| deviceId | string
| 是 | 否
| 表示发送特征值写请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number
| 是 | 否 | 表示写请求的传输ID，server端回复响应时需填写相同的传输ID。
|
| offset | number
| 是 | 否
| 表示写特征值数据的起始位置。例如：k表示从第k个字节开始写，server端回复响应时需填写相同的offset。 |
| descriptorUuid | string
| 是 | 否
| 表示描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string
| 是 | 否
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| serviceUuid | string
| 是 | 否
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------ | ------
| ---- | ---- |
---------------------------------------- |
| deviceId | string
| 是 | 否
| 表示发送特征值写请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number
| 是 | 否 | 表示写请求的传输ID，server端回复响应时需填写相同的传输ID。
|
| offset | number
| 是 | 否
| 表示写特征值数据的起始位置。例如：k表示从第k个字节开始写，server端回复响应时需填写相同的offset。 |
| descriptorUuid | string
| 是 | 否
| 表示描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string
| 是 | 否
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| serviceUuid | string
| 是 | 否
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
## DescriptorReadReq
...
...
@@ -3068,14 +3066,14 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------ | ------
-- | ---- | ---- | --------------------
---------------------------------------- |
| deviceId | string
| 是 | 否
| 表示发送描述符读请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number
| 是 | 否 | 表示读请求的传输ID，server端回复响应时需填写相同的传输ID。
|
| offset | number
| 是 | 否
| 表示读描述符数据的起始位置。例如：k表示从第k个字节开始读，server端回复响应时需填写相同的offset。 |
| descriptorUuid | string
| 是 | 否
| 表示描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string
| 是 | 否
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| serviceUuid | string
| 是 | 否
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------ | ------
| ---- | ---- |
---------------------------------------- |
| deviceId | string
| 是 | 否
| 表示发送描述符读请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number
| 是 | 否 | 表示读请求的传输ID，server端回复响应时需填写相同的传输ID。
|
| offset | number
| 是 | 否
| 表示读描述符数据的起始位置。例如：k表示从第k个字节开始读，server端回复响应时需填写相同的offset。 |
| descriptorUuid | string
| 是 | 否
| 表示描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string
| 是 | 否
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| serviceUuid | string
| 是 | 否
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
## DescriptorWriteReq
...
...
@@ -3084,17 +3082,17 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------ | ----------- | ---- | ---- | ----------------------------------------
--------------------
|
| deviceId | string | 是
| 否
| 表示发送描述符写请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number | 是
| 否 | 表示写请求的传输ID，server端回复响应时需填写相同的传输ID。
|
| offset | number | 是
| 否
| 表示写描述符数据的起始位置。例如：k表示从第k个字节开始写，server端回复响应时需填写相同的offset。 |
| isPrep | boolean | 是
| 否 | 表示写请求是否立即执行。
|
| needRsp | boolean | 是
| 否 | 表示是否要给client端回复响应。
|
| value | ArrayBuffer | 是
| 否 | 表示写入的描述符二进制数据。
|
| descriptorUuid | string | 是
| 否
| 表示描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string | 是
| 否
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| serviceUuid | string | 是
| 否
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------------ | ----------- | ---- | ---- | ---------------------------------------- |
| deviceId | string | 是
| 否
| 表示发送描述符写请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| transId | number | 是
| 否 | 表示写请求的传输ID，server端回复响应时需填写相同的传输ID。
|
| offset | number | 是
| 否
| 表示写描述符数据的起始位置。例如：k表示从第k个字节开始写，server端回复响应时需填写相同的offset。 |
| isPrep | boolean | 是
| 否 | 表示写请求是否立即执行。
|
| needRsp | boolean | 是
| 否 | 表示是否要给client端回复响应。
|
| value | ArrayBuffer | 是
| 否 | 表示写入的描述符二进制数据。
|
| descriptorUuid | string | 是
| 否
| 表示描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。 |
| characteristicUuid | string | 是
| 否
| 特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。 |
| serviceUuid | string | 是
| 否
| 特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。 |
## ServerResponse
...
...
@@ -3103,13 +3101,13 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ----------- | ---- | ---- | --------------------------------------
----------------------
|
| deviceId | string | 是
| 否 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。
|
| transId | number | 是
| 否 | 表示请求的传输ID，与订阅的读/写请求事件携带的ID保持一致。
|
| status | number | 是
| 否 | 表示响应的状态，设置为0即可，表示正常。
|
| offset | number | 是
| 否
| 表示请求的读/写起始位置，与订阅的读/写请求事件携带的offset保持一致。 |
| value | ArrayBuffer | 是
| 否 | 表示回复响应的二进制数据。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ----------- | ---- | ---- | -------------------------------------- |
| deviceId | string | 是
| 否 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。
|
| transId | number | 是
| 否 | 表示请求的传输ID，与订阅的读/写请求事件携带的ID保持一致。
|
| status | number | 是
| 否 | 表示响应的状态，设置为0即可，表示正常。
|
| offset | number | 是
| 否
| 表示请求的读/写起始位置，与订阅的读/写请求事件携带的offset保持一致。 |
| value | ArrayBuffer | 是
| 否 | 表示回复响应的二进制数据。
|
## BLEConnectChangedState
...
...
@@ -3118,10 +3116,10 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ----------------------------------------
--------- | ---- | ---- | -------------
-------------------------------- |
| deviceId | string
| 是 | 否
| 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| state |
[
ProfileConnectionState
](
#profileconnectionState
)
| 是
| 是 | 表示BLE连接状态的枚举。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ----------------------------------------
| ---- | ---- |
-------------------------------- |
| deviceId | string
| 是 | 否
| 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| state |
[
ProfileConnectionState
](
#profileconnectionState
)
| 是
| 是 | 表示BLE连接状态的枚举。
|
## ProfileConnectionState
...
...
@@ -3130,12 +3128,12 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 默认值 | 说明
|
| ------------------- | ----
-- | -------
-------------- |
| STATE_DISCONNECTED | 0
| 表示profile已断连。
|
| STATE_CONNECTING | 1
| 表示profile正在连接。 |
| STATE_CONNECTED | 2
| 表示profile已连接。
|
| STATE_DISCONNECTING | 3
| 表示profile正在断连。 |
| 名称
| 默认值 | 说明
|
| ------------------- | ----
|
-------------- |
| STATE_DISCONNECTED | 0
| 表示profile已断连。
|
| STATE_CONNECTING | 1 | 表示profile正在连接。 |
| STATE_CONNECTED | 2
| 表示profile已连接。
|
| STATE_DISCONNECTING | 3 | 表示profile正在断连。 |
## ScanFilter
...
...
@@ -3144,11 +3142,11 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----------- | ------
-- | ---- | ---- | --------------------
---------------------------------------- |
| deviceId | string
| 是 | 是 | 表示过滤的BLE设备地址，例如："XX:XX:XX:XX:XX:XX"。
|
| name | string
| 是 | 是 | 表示过滤的BLE设备名。
|
| serviceUuid | string
| 是 | 是
| 表示过滤包含该UUID服务的设备，例如：00001888-0000-1000-8000-00805f9b34fb。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----------- | ------
| ---- | ---- |
---------------------------------------- |
| deviceId | string
| 是 | 是 | 表示过滤的BLE设备地址，例如："XX:XX:XX:XX:XX:XX"。
|
| name | string
| 是 | 是 | 表示过滤的BLE设备名。
|
| serviceUuid | string
| 是 | 是
| 表示过滤包含该UUID服务的设备，例如：00001888-0000-1000-8000-00805f9b34fb。 |
## ScanOptions
...
...
@@ -3157,11 +3155,11 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------- | ----------------------- | ---- | ---- | --------------------------------------
-----------------
|
| interval | number | 是
| 是 | 表示扫描结果上报延迟时间，默认值为0。
|
| dutyMode |
[
ScanDuty
](
#scanduty
)
| 是
| 是 | 表示扫描模式，默认值为SCAN_MODE_LOW_POWER。
|
| matchMode |
[
MatchMode
](
#matchmode
)
| 是
| 是
| 表示硬件的过滤匹配模式，默认值为MATCH_MODE_AGGRESSIVE。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------- | ----------------------- | ---- | ---- | -------------------------------------- |
| interval | number | 是
| 是 | 表示扫描结果上报延迟时间，默认值为0。
|
| dutyMode |
[
ScanDuty
](
#scanduty
)
| 是
| 是 | 表示扫描模式，默认值为SCAN_MODE_LOW_POWER。
|
| matchMode |
[
MatchMode
](
#matchmode
)
| 是
| 是
| 表示硬件的过滤匹配模式，默认值为MATCH_MODE_AGGRESSIVE。 |
## ScanDuty
...
...
@@ -3170,11 +3168,11 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 默认值 | 说明
|
| --------------------- | ----
-- | ------------
------------ |
| SCAN_MODE_LOW_POWER | 0
| 表示低功耗模式，默认值。 |
| SCAN_MODE_BALANCED | 1
| 表示均衡模式。
|
| SCAN_MODE_LOW_LATENCY | 2
| 表示低延迟模式。
|
| 名称
| 默认值 | 说明
|
| --------------------- | ----
|
------------ |
| SCAN_MODE_LOW_POWER | 0 | 表示低功耗模式，默认值。 |
| SCAN_MODE_BALANCED | 1
| 表示均衡模式。
|
| SCAN_MODE_LOW_LATENCY | 2
| 表示低延迟模式。
|
## MatchMode
...
...
@@ -3183,10 +3181,10 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 默认值 | 说明
|
| --------------------- | ----
-- | --------------------
---------------------------------------- |
| MATCH_MODE_AGGRESSIVE | 1
| 表示硬件上报扫描结果门限较低，比如扫描到的功率较低或者一段时间扫描到的次数较少也触发上报，默认值。 |
| MATCH_MODE_STICKY | 2
| 表示硬件上报扫描结果门限较高，更高的功率门限以及扫描到多次才会上报。
|
| 名称
| 默认值 | 说明
|
| --------------------- | ----
|
---------------------------------------- |
| MATCH_MODE_AGGRESSIVE | 1 | 表示硬件上报扫描结果门限较低，比如扫描到的功率较低或者一段时间扫描到的次数较少也触发上报，默认值。 |
| MATCH_MODE_STICKY | 2
| 表示硬件上报扫描结果门限较高，更高的功率门限以及扫描到多次才会上报。
|
## ScanResult
...
...
@@ -3195,11 +3193,11 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ----------- | ---- | ---- | ----------------------------------
---------------
|
| deviceId | string | 是
| 否
| 表示扫描到的设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| rssi | number | 是
| 否 | 表示扫描到的设备的rssi值。
|
| data | ArrayBuffer | 是
| 否
| 表示扫描到的设备发送的广播包。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ----------- | ---- | ---- | ---------------------------------- |
| deviceId | string | 是
| 否
| 表示扫描到的设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| rssi | number | 是
| 否 | 表示扫描到的设备的rssi值。
|
| data | ArrayBuffer | 是
| 否
| 表示扫描到的设备发送的广播包。 |
## BluetoothState
...
...
@@ -3208,15 +3206,15 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 默认值 | 说明
|
| --------------------- | ----
-- | -----------
------------------ |
| STATE_OFF | 0
| 表示蓝牙已关闭。
|
| STATE_TURNING_ON | 1
| 表示蓝牙正在打开。
|
| STATE_ON | 2
| 表示蓝牙已打开。
|
| STATE_TURNING_OFF | 3
| 表示蓝牙正在关闭。
|
| STATE_BLE_TURNING_ON | 4
| 表示蓝牙正在打开LE-only模式。 |
| STATE_BLE_ON | 5
| 表示蓝牙正处于LE-only模式。
|
| STATE_BLE_TURNING_OFF | 6
| 表示蓝牙正在关闭LE-only模式。 |
| 名称
| 默认值 | 说明
|
| --------------------- | ----
|
------------------ |
| STATE_OFF | 0
| 表示蓝牙已关闭。
|
| STATE_TURNING_ON | 1
| 表示蓝牙正在打开。
|
| STATE_ON | 2
| 表示蓝牙已打开。
|
| STATE_TURNING_OFF | 3
| 表示蓝牙正在关闭。
|
| STATE_BLE_TURNING_ON | 4 | 表示蓝牙正在打开LE-only模式。 |
| STATE_BLE_ON | 5
| 表示蓝牙正处于LE-only模式。
|
| STATE_BLE_TURNING_OFF | 6 | 表示蓝牙正在关闭LE-only模式。 |
## AdvertiseSetting
...
...
@@ -3225,11 +3223,11 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----------- | -------
- | ---- | ---- | --------------------
---------------------------------------- |
| interval | number
| 是 | 是
| 表示广播间隔，最小值设置32个slot表示20ms，最大值设置16777215个slot，默认值设置为1600个slot表示1s。 |
| txPower | number
| 是 | 是 | 表示发送功率，最小值设置-127，最大值设置1，默认值设置-7，单位dbm。
|
| connectable | boolean
| 是 | 是 | 表示是否是可连接广播，默认值设置为true。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----------- | -------
| ---- | ---- |
---------------------------------------- |
| interval | number
| 是 | 是
| 表示广播间隔，最小值设置32个slot表示20ms，最大值设置16777215个slot，默认值设置为1600个slot表示1s。 |
| txPower | number
| 是 | 是 | 表示发送功率，最小值设置-127，最大值设置1，默认值设置-7，单位dbm。
|
| connectable | boolean
| 是 | 是 | 表示是否是可连接广播，默认值设置为true。
|
## AdvertiseData
...
...
@@ -3238,11 +3236,11 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------------- | ----------------------------------------
-------- | ---- | ---- | -----------
--------------------------- |
| serviceUuids | Array
<
string
>
| 是 | 是
| 表示要广播的服务
UUID
列表。 |
| manufactureData | Array
<
[ManufactureData](#manufacturedata)
>
| 是
| 是 | 表示要广播的广播的制造商信息列表。
|
| serviceData | Array
<
[ServiceData](#servicedata)
>
| 是 | 是 | 表示要广播的服务数据列表。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------------- | ----------------------------------------
| ---- | ---- |
--------------------------- |
| serviceUuids | Array
<
string
>
| 是 | 是
| 表示要广播的服务
UUID
列表。 |
| manufactureData | Array
<
[ManufactureData](#manufacturedata)
>
| 是
| 是 | 表示要广播的广播的制造商信息列表。
|
| serviceData | Array
<
[ServiceData](#servicedata)
>
| 是 | 是 | 表示要广播的服务数据列表。
|
## ManufactureData
...
...
@@ -3251,10 +3249,10 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ---------------- | ------------------- | ---- | ---- | ------------------
-------------
|
| manufactureId | Array
<
string
>
| 是
| 是
| 表示制造商的ID，由蓝牙SIG分配。 |
| manufactureValue | ArrayBuffer | 是
| 是 | 表示制造商发送的制造商数据。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ---------------- | ------------------- | ---- | ---- | ------------------ |
| manufactureId | Array
<
string
>
| 是
| 是
| 表示制造商的ID，由蓝牙SIG分配。 |
| manufactureValue | ArrayBuffer | 是
| 是 | 表示制造商发送的制造商数据。
|
## ServiceData
...
...
@@ -3263,10 +3261,10 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------ | ----------- | ---- | ---- | ----------
------
|
| serviceUuid | string | 是
| 是
| 表示服务的UUID。 |
| serviceValue | ArrayBuffer | 是
| 是 | 表示服务数据。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------------ | ----------- | ---- | ---- | ---------- |
| serviceUuid | string | 是
| 是
| 表示服务的UUID。 |
| serviceValue | ArrayBuffer | 是
| 是 | 表示服务数据。
|
## PinRequiredParam<sup>8+</sup><a name="PinRequiredParam"></a>
...
...
@@ -3275,10 +3273,10 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ------
-- | ---- | ---- | ---------
----------- |
| deviceId | string
| 是 | 否
| 表示要配对的设备ID。 |
| pinCode | string
| 是 | 否
| 表示要配对的密钥。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ------
| ---- | ---- |
----------- |
| deviceId | string
| 是 | 否
| 表示要配对的设备ID。 |
| pinCode | string
| 是 | 否
| 表示要配对的密钥。 |
## StateChangeParam<sup>8+</sup><a name="StateChangeParam"></a>
...
...
@@ -3287,10 +3285,10 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ----------------------------------------
--------- | ---- | ---- | ------------
------------------- |
| deviceId | string
| 是 | 否 | 表示蓝牙设备地址。
|
| state |
[
ProfileConnectionState
](
#ProfileConnectionState
)
| 是
| 否
| 表示蓝牙设备的profile连接状态。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ----------------------------------------
| ---- | ---- |
------------------- |
| deviceId | string
| 是 | 否 | 表示蓝牙设备地址。
|
| state |
[
ProfileConnectionState
](
#ProfileConnectionState
)
| 是
| 否
| 表示蓝牙设备的profile连接状态。 |
## DeviceClass<sup>8+</sup><a name="DeviceClass"></a>
...
...
@@ -3299,11 +3297,11 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------------- | ----------------------------------- | ---- | ---- | ----------------
----------------
|
| majorClass |
[
MajorClass
](
#majorclass
)
| 是
| 否 | 表示蓝牙设备主要类别的枚举。
|
| majorMinorClass |
[
MajorMinorClass
](
#majorminorclass
)
| 是
| 否
| 表示主要次要蓝牙设备类别的枚举。 |
| classOfDevice | number | 是
| 否 | 表示设备类别。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------------- | ----------------------------------- | ---- | ---- | ---------------- |
| majorClass |
[
MajorClass
](
#majorclass
)
| 是
| 否 | 表示蓝牙设备主要类别的枚举。
|
| majorMinorClass |
[
MajorMinorClass
](
#majorminorclass
)
| 是
| 否
| 表示主要次要蓝牙设备类别的枚举。 |
| classOfDevice | number | 是
| 否 | 表示设备类别。
|
...
...
@@ -3313,19 +3311,19 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 默认值 | 说明
|
| ------------------- | ------ | ----------
----------
|
| MAJOR_MISC | 0x0000 | 表示杂项设备。
|
| MAJOR_COMPUTER | 0x0100 | 表示计算机设备。
|
| MAJOR_PHONE | 0x0200 | 表示手机设备。
|
| MAJOR_NETWORKING | 0x0300 | 表示网络设备。
|
| 名称
| 默认值 | 说明
|
| ------------------- | ------ | ---------- |
| MAJOR_MISC | 0x0000 | 表示杂项设备。 |
| MAJOR_COMPUTER | 0x0100 | 表示计算机设备。 |
| MAJOR_PHONE | 0x0200 | 表示手机设备。 |
| MAJOR_NETWORKING | 0x0300 | 表示网络设备。 |
| MAJOR_AUDIO_VIDEO | 0x0400 | 表示音频和视频设备。 |
| MAJOR_PERIPHERAL | 0x0500 | 表示外围设备。
|
| MAJOR_IMAGING | 0x0600 | 表示成像设备。
|
| MAJOR_WEARABLE | 0x0700 | 表示可穿戴设备。
|
| MAJOR_TOY | 0x0800 | 表示玩具设备。
|
| MAJOR_HEALTH | 0x0900 | 表示健康设备。
|
| MAJOR_UNCATEGORIZED | 0x1F00 | 表示未分类设备。
|
| MAJOR_PERIPHERAL | 0x0500 | 表示外围设备。 |
| MAJOR_IMAGING | 0x0600 | 表示成像设备。 |
| MAJOR_WEARABLE | 0x0700 | 表示可穿戴设备。 |
| MAJOR_TOY | 0x0800 | 表示玩具设备。 |
| MAJOR_HEALTH | 0x0900 | 表示健康设备。 |
| MAJOR_UNCATEGORIZED | 0x1F00 | 表示未分类设备。 |
## MajorMinorClass<sup>8+</sup><a name="MajorMinorClass"></a>
...
...
@@ -3334,94 +3332,94 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 默认值 | 说明
|
| ----------------------------------------
- | ------ | ---------------
--------------- |
| COMPUTER_UNCATEGORIZED
| 0x0100 | 表示未分类计算机设备。
|
| COMPUTER_DESKTOP
| 0x0104 | 表示台式计算机设备。
|
| COMPUTER_SERVER
| 0x0108 | 表示服务器设备。
|
| COMPUTER_LAPTOP
| 0x010C | 表示便携式计算机设备。
|
| COMPUTER_HANDHELD_PC_PDA
| 0x0110 | 表示手持式计算机设备。
|
| COMPUTER_PALM_SIZE_PC_PDA
| 0x0114 | 表示掌上电脑设备。
|
| COMPUTER_WEARABLE
| 0x0118 | 表示可穿戴计算机设备。
|
| COMPUTER_TABLET
| 0x011C | 表示平板电脑设备。
|
| PHONE_UNCATEGORIZED
| 0x0200 | 表示未分类手机设备。
|
| PHONE_CELLULAR
| 0x0204 | 表示便携式手机设备。
|
| PHONE_CORDLESS
| 0x0208 | 表示无线电话设备。
|
| PHONE_SMART
| 0x020C | 表示智能手机设备。
|
| PHONE_MODEM_OR_GATEWAY
| 0x0210 | 表示调制解调器或网关手机设备。 |
| PHONE_ISDN
| 0x0214 | 表示ISDN手机设备。
|
| NETWORK_FULLY_AVAILABLE
| 0x0300 | 表示网络完全可用设备。
|
| NETWORK_1_TO_17_UTILIZED
| 0x0320 | 表示使用网络1到17设备。
|
| NETWORK_17_TO_33_UTILIZED
| 0x0340 | 表示使用网络17到33设备。
|
| NETWORK_33_TO_50_UTILIZED
| 0x0360 | 表示使用网络33到50设备。
|
| NETWORK_60_TO_67_UTILIZED
| 0x0380 | 表示使用网络60到67设备。
|
| NETWORK_67_TO_83_UTILIZED
| 0x03A0 | 表示使用网络67到83设备。
|
| NETWORK_83_TO_99_UTILIZED
| 0x03C0 | 表示使用网络83到99设备。
|
| NETWORK_NO_SERVICE
| 0x03E0 | 表示网络无服务设备。
|
| AUDIO_VIDEO_UNCATEGORIZED
| 0x0400 | 表示未分类音频视频设备。
|
| AUDIO_VIDEO_WEARABLE_HEADSET
| 0x0404 | 表示可穿戴式音频视频设备。
|
| AUDIO_VIDEO_HANDSFREE
| 0x0408 | 表示免提音频视频设备。
|
| AUDIO_VIDEO_MICROPHONE
| 0x0410 | 表示麦克风音频视频设备。
|
| AUDIO_VIDEO_LOUDSPEAKER
| 0x0414 | 表示扬声器音频视频设备。
|
| AUDIO_VIDEO_HEADPHONES
| 0x0418 | 表示头戴式音频视频设备。
|
| AUDIO_VIDEO_PORTABLE_AUDIO
| 0x041C | 表示便携式音频视频设备。
|
| AUDIO_VIDEO_CAR_AUDIO
| 0x0420 | 表示汽车音频视频设备。
|
| AUDIO_VIDEO_SET_TOP_BOX
| 0x0424 | 表示机顶盒音频视频设备。
|
| AUDIO_VIDEO_HIFI_AUDIO
| 0x0428 | 表示高保真音响设备。
|
| AUDIO_VIDEO_VCR
| 0x042C | 表示录像机音频视频设备。
|
| AUDIO_VIDEO_VIDEO_CAMERA
| 0x0430 | 表示照相机音频视频设备。
|
| AUDIO_VIDEO_CAMCORDER
| 0x0434 | 表示摄像机音频视频设备。
|
| AUDIO_VIDEO_VIDEO_MONITOR
| 0x0438 | 表示监视器音频视频设备。
|
| AUDIO_VIDEO_VIDEO_DISPLAY_AND_LOUDSPEAKER | 0x043C | 表示视频显示器和扬声器设备。
|
| AUDIO_VIDEO_VIDEO_CONFERENCING
| 0x0440 | 表示音频视频会议设备。
|
| AUDIO_VIDEO_VIDEO_GAMING_TOY
| 0x0448 | 表示游戏玩具音频视频设备。
|
| PERIPHERAL_NON_KEYBOARD_NON_POINTING
| 0x0500 | 表示非键盘非指向外围设备。
|
| PERIPHERAL_KEYBOARD
| 0x0540 | 表示外设键盘设备。
|
| PERIPHERAL_POINTING_DEVICE
| 0x0580 | 表示定点装置外围设备。
|
| PERIPHERAL_KEYBOARD_POINTING
| 0x05C0 | 表示键盘指向外围设备。
|
| PERIPHERAL_UNCATEGORIZED
| 0x0500 | 表示未分类外围设备。
|
| PERIPHERAL_JOYSTICK
| 0x0504 | 表示周边操纵杆设备。
|
| PERIPHERAL_GAMEPAD
| 0x0508 | 表示周边游戏板设备。
|
| PERIPHERAL_REMOTE_CONTROL
| 0x05C0 | 表示远程控制外围设备。
|
| PERIPHERAL_SENSING_DEVICE
| 0x0510 | 表示外围传感设备设备。
|
| PERIPHERAL_DIGITIZER_TABLET
| 0x0514 | 表示外围数字化仪平板电脑设备。 |
| PERIPHERAL_CARD_READER
| 0x0518 | 表示外围读卡器设备。
|
| PERIPHERAL_DIGITAL_PEN
| 0x051C | 表示外设数码笔设备。
|
| PERIPHERAL_SCANNER_RFID
| 0x0520 | 表示射频识别扫描仪外围设备。
|
| PERIPHERAL_GESTURAL_INPUT
| 0x0522 | 表示手势输入外围设备。
|
| IMAGING_UNCATEGORIZED
| 0x0600 | 表示未分类的图像设备。
|
| IMAGING_DISPLAY
| 0x0610 | 表示图像显示设备。
|
| IMAGING_CAMERA
| 0x0620 | 表示成像照相机设备。
|
| IMAGING_SCANNER
| 0x0640 | 表示成像扫描仪设备。
|
| IMAGING_PRINTER
| 0x0680 | 表示成像打印机设备。
|
| WEARABLE_UNCATEGORIZED
| 0x0700 | 表示未分类的可穿戴设备。
|
| WEARABLE_WRIST_WATCH
| 0x0704 | 表示可穿戴腕表设备。
|
| WEARABLE_PAGER
| 0x0708 | 表示可穿戴寻呼机设备。
|
| WEARABLE_JACKET
| 0x070C | 表示夹克可穿戴设备。
|
| WEARABLE_HELMET
| 0x0710 | 表示可穿戴头盔设备。
|
| WEARABLE_GLASSES
| 0x0714 | 表示可穿戴眼镜设备。
|
| TOY_UNCATEGORIZED
| 0x0800 | 表示未分类的玩具设备。
|
| TOY_ROBOT
| 0x0804 | 表示玩具机器人设备。
|
| TOY_VEHICLE
| 0x0808 | 表示玩具车设备。
|
| TOY_DOLL_ACTION_FIGURE
| 0x080C | 表示人形娃娃玩具设备。
|
| TOY_CONTROLLER
| 0x0810 | 表示玩具控制器设备。
|
| TOY_GAME
| 0x0814 | 表示玩具游戏设备。
|
| HEALTH_UNCATEGORIZED
| 0x0900 | 表示未分类健康设备。
|
| HEALTH_BLOOD_PRESSURE
| 0x0904 | 表示血压健康设备。
|
| HEALTH_THERMOMETER
| 0x0908 | 表示温度计健康设备。
|
| HEALTH_WEIGHING
| 0x090C | 表示体重健康设备。
|
| HEALTH_GLUCOSE
| 0x0910 | 表示葡萄糖健康设备。
|
| HEALTH_PULSE_OXIMETER
| 0x0914 | 表示脉搏血氧仪健康设备。
|
| HEALTH_PULSE_RATE
| 0x0918 | 表示脉搏率健康设备。
|
| HEALTH_DATA_DISPLAY
| 0x091C | 表示数据显示健康设备。
|
| HEALTH_STEP_COUNTER
| 0x0920 | 表示阶梯计数器健康设备。
|
| HEALTH_BODY_COMPOSITION_ANALYZER
| 0x0924 | 表示身体成分分析仪健康设备。
|
| HEALTH_PEAK_FLOW_MOITOR
| 0x0928 | 表示湿度计健康设备。
|
| HEALTH_MEDICATION_MONITOR
| 0x092C | 表示药物监视仪健康设备。
|
| HEALTH_KNEE_PROSTHESIS
| 0x0930 | 表示膝盖假肢健康设备。
|
| HEALTH_ANKLE_PROSTHESIS
| 0x0934 | 表示脚踝假肢健康设备。
|
| HEALTH_GENERIC_HEALTH_MANAGER
| 0x0938 | 表示通用健康管理设备。
|
| HEALTH_PERSONAL_MOBILITY_DEVICE
| 0x093C | 表示个人移动健康设备。
|
| 名称
| 默认值 | 说明
|
| ----------------------------------------
| ------ |
--------------- |
| COMPUTER_UNCATEGORIZED
| 0x0100 | 表示未分类计算机设备。
|
| COMPUTER_DESKTOP
| 0x0104 | 表示台式计算机设备。
|
| COMPUTER_SERVER
| 0x0108 | 表示服务器设备。
|
| COMPUTER_LAPTOP
| 0x010C | 表示便携式计算机设备。
|
| COMPUTER_HANDHELD_PC_PDA
| 0x0110 | 表示手持式计算机设备。
|
| COMPUTER_PALM_SIZE_PC_PDA
| 0x0114 | 表示掌上电脑设备。
|
| COMPUTER_WEARABLE
| 0x0118 | 表示可穿戴计算机设备。
|
| COMPUTER_TABLET
| 0x011C | 表示平板电脑设备。
|
| PHONE_UNCATEGORIZED
| 0x0200 | 表示未分类手机设备。
|
| PHONE_CELLULAR
| 0x0204 | 表示便携式手机设备。
|
| PHONE_CORDLESS
| 0x0208 | 表示无线电话设备。
|
| PHONE_SMART
| 0x020C | 表示智能手机设备。
|
| PHONE_MODEM_OR_GATEWAY | 0x0210 | 表示调制解调器或网关手机设备。 |
| PHONE_ISDN
| 0x0214 | 表示ISDN手机设备。
|
| NETWORK_FULLY_AVAILABLE
| 0x0300 | 表示网络完全可用设备。
|
| NETWORK_1_TO_17_UTILIZED
| 0x0320 | 表示使用网络1到17设备。
|
| NETWORK_17_TO_33_UTILIZED
| 0x0340 | 表示使用网络17到33设备。
|
| NETWORK_33_TO_50_UTILIZED
| 0x0360 | 表示使用网络33到50设备。
|
| NETWORK_60_TO_67_UTILIZED
| 0x0380 | 表示使用网络60到67设备。
|
| NETWORK_67_TO_83_UTILIZED
| 0x03A0 | 表示使用网络67到83设备。
|
| NETWORK_83_TO_99_UTILIZED
| 0x03C0 | 表示使用网络83到99设备。
|
| NETWORK_NO_SERVICE
| 0x03E0 | 表示网络无服务设备。
|
| AUDIO_VIDEO_UNCATEGORIZED
| 0x0400 | 表示未分类音频视频设备。
|
| AUDIO_VIDEO_WEARABLE_HEADSET
| 0x0404 | 表示可穿戴式音频视频设备。
|
| AUDIO_VIDEO_HANDSFREE
| 0x0408 | 表示免提音频视频设备。
|
| AUDIO_VIDEO_MICROPHONE
| 0x0410 | 表示麦克风音频视频设备。
|
| AUDIO_VIDEO_LOUDSPEAKER
| 0x0414 | 表示扬声器音频视频设备。
|
| AUDIO_VIDEO_HEADPHONES
| 0x0418 | 表示头戴式音频视频设备。
|
| AUDIO_VIDEO_PORTABLE_AUDIO
| 0x041C | 表示便携式音频视频设备。
|
| AUDIO_VIDEO_CAR_AUDIO
| 0x0420 | 表示汽车音频视频设备。
|
| AUDIO_VIDEO_SET_TOP_BOX
| 0x0424 | 表示机顶盒音频视频设备。
|
| AUDIO_VIDEO_HIFI_AUDIO
| 0x0428 | 表示高保真音响设备。
|
| AUDIO_VIDEO_VCR
| 0x042C | 表示录像机音频视频设备。
|
| AUDIO_VIDEO_VIDEO_CAMERA
| 0x0430 | 表示照相机音频视频设备。
|
| AUDIO_VIDEO_CAMCORDER
| 0x0434 | 表示摄像机音频视频设备。
|
| AUDIO_VIDEO_VIDEO_MONITOR
| 0x0438 | 表示监视器音频视频设备。
|
| AUDIO_VIDEO_VIDEO_DISPLAY_AND_LOUDSPEAKER | 0x043C | 表示视频显示器和扬声器设备。 |
| AUDIO_VIDEO_VIDEO_CONFERENCING
| 0x0440 | 表示音频视频会议设备。
|
| AUDIO_VIDEO_VIDEO_GAMING_TOY
| 0x0448 | 表示游戏玩具音频视频设备。
|
| PERIPHERAL_NON_KEYBOARD_NON_POINTING
| 0x0500 | 表示非键盘非指向外围设备。
|
| PERIPHERAL_KEYBOARD
| 0x0540 | 表示外设键盘设备。
|
| PERIPHERAL_POINTING_DEVICE
| 0x0580 | 表示定点装置外围设备。
|
| PERIPHERAL_KEYBOARD_POINTING
| 0x05C0 | 表示键盘指向外围设备。
|
| PERIPHERAL_UNCATEGORIZED
| 0x0500 | 表示未分类外围设备。
|
| PERIPHERAL_JOYSTICK
| 0x0504 | 表示周边操纵杆设备。
|
| PERIPHERAL_GAMEPAD
| 0x0508 | 表示周边游戏板设备。
|
| PERIPHERAL_REMOTE_CONTROL
| 0x05C0 | 表示远程控制外围设备。
|
| PERIPHERAL_SENSING_DEVICE
| 0x0510 | 表示外围传感设备设备。
|
| PERIPHERAL_DIGITIZER_TABLET | 0x0514 | 表示外围数字化仪平板电脑设备。 |
| PERIPHERAL_CARD_READER
| 0x0518 | 表示外围读卡器设备。
|
| PERIPHERAL_DIGITAL_PEN
| 0x051C | 表示外设数码笔设备。
|
| PERIPHERAL_SCANNER_RFID
| 0x0520 | 表示射频识别扫描仪外围设备。
|
| PERIPHERAL_GESTURAL_INPUT
| 0x0522 | 表示手势输入外围设备。
|
| IMAGING_UNCATEGORIZED
| 0x0600 | 表示未分类的图像设备。
|
| IMAGING_DISPLAY
| 0x0610 | 表示图像显示设备。
|
| IMAGING_CAMERA
| 0x0620 | 表示成像照相机设备。
|
| IMAGING_SCANNER
| 0x0640 | 表示成像扫描仪设备。
|
| IMAGING_PRINTER
| 0x0680 | 表示成像打印机设备。
|
| WEARABLE_UNCATEGORIZED
| 0x0700 | 表示未分类的可穿戴设备。
|
| WEARABLE_WRIST_WATCH
| 0x0704 | 表示可穿戴腕表设备。
|
| WEARABLE_PAGER
| 0x0708 | 表示可穿戴寻呼机设备。
|
| WEARABLE_JACKET
| 0x070C | 表示夹克可穿戴设备。
|
| WEARABLE_HELMET
| 0x0710 | 表示可穿戴头盔设备。
|
| WEARABLE_GLASSES
| 0x0714 | 表示可穿戴眼镜设备。
|
| TOY_UNCATEGORIZED
| 0x0800 | 表示未分类的玩具设备。
|
| TOY_ROBOT
| 0x0804 | 表示玩具机器人设备。
|
| TOY_VEHICLE
| 0x0808 | 表示玩具车设备。
|
| TOY_DOLL_ACTION_FIGURE
| 0x080C | 表示人形娃娃玩具设备。
|
| TOY_CONTROLLER
| 0x0810 | 表示玩具控制器设备。
|
| TOY_GAME
| 0x0814 | 表示玩具游戏设备。
|
| HEALTH_UNCATEGORIZED
| 0x0900 | 表示未分类健康设备。
|
| HEALTH_BLOOD_PRESSURE
| 0x0904 | 表示血压健康设备。
|
| HEALTH_THERMOMETER
| 0x0908 | 表示温度计健康设备。
|
| HEALTH_WEIGHING
| 0x090C | 表示体重健康设备。
|
| HEALTH_GLUCOSE
| 0x0910 | 表示葡萄糖健康设备。
|
| HEALTH_PULSE_OXIMETER
| 0x0914 | 表示脉搏血氧仪健康设备。
|
| HEALTH_PULSE_RATE
| 0x0918 | 表示脉搏率健康设备。
|
| HEALTH_DATA_DISPLAY
| 0x091C | 表示数据显示健康设备。
|
| HEALTH_STEP_COUNTER
| 0x0920 | 表示阶梯计数器健康设备。
|
| HEALTH_BODY_COMPOSITION_ANALYZER
| 0x0924 | 表示身体成分分析仪健康设备。
|
| HEALTH_PEAK_FLOW_MOITOR
| 0x0928 | 表示湿度计健康设备。
|
| HEALTH_MEDICATION_MONITOR
| 0x092C | 表示药物监视仪健康设备。
|
| HEALTH_KNEE_PROSTHESIS
| 0x0930 | 表示膝盖假肢健康设备。
|
| HEALTH_ANKLE_PROSTHESIS
| 0x0934 | 表示脚踝假肢健康设备。
|
| HEALTH_GENERIC_HEALTH_MANAGER
| 0x0938 | 表示通用健康管理设备。
|
| HEALTH_PERSONAL_MOBILITY_DEVICE
| 0x093C | 表示个人移动健康设备。
|
## PlayingState<sup>8+</sup><a name="PlayingState"></a>
...
...
@@ -3430,9 +3428,9 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 默认值 | 说明
|
| ----------------- | ------ | -------
-------
|
| STATE_NOT_PLAYING | 0x0000 | 表示未播放。
|
| 名称
| 默认值 | 说明
|
| ----------------- | ------ | ------- |
| STATE_NOT_PLAYING | 0x0000 | 表示未播放。 |
| STATE_PLAYING | 0x0001 | 表示正在播放。 |
...
...
@@ -3442,7 +3440,7 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**
：SystemCapability.Communication.Bluetooth.Core。
| 名称
| 默认值 | 说明
|
| -------------------------------- | ------ | ---------------
---
|
| 名称
| 默认值 | 说明
|
| -------------------------------- | ------ | --------------- |
| PROFILE_A2DP_SOURCE | 0x0001 | 表示A2DP 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
...
...
@@ -23,10 +23,10 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>)
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| --------- | ---------------------
| ---- | -----
-------------- |
| parameter |
[
StartAbilityParameter
](
#startabilityparameter
)
| 是 | 表示被启动的Ability。 |
| callback | AsyncCallback
\<
number>
| 是 | 被指定的回调方法。
|
| 名称
| 类型 | 必填 | 描述
|
| --------- | ---------------------
------------------- | ---- |
-------------- |
| parameter |
[
StartAbilityParameter
](
#startabilityparameter
)
| 是
| 表示被启动的Ability。 |
| callback | AsyncCallback
\<
number>
| 是 | 被指定的回调方法。
|
**示例：**
...
...
@@ -62,9 +62,9 @@ startAbility(parameter: StartAbilityParameter): Promise\<number>
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| --------- | ----------------------------------------
------- | ---- | -------
-------------- |
| parameter |
[
StartAbilityParameter
](
#startabilityparameter
)
| 是 | 表示被启动的Ability。 |
| 名称
| 类型 | 必填 | 描述
|
| --------- | ----------------------------------------
| ---- |
-------------- |
| parameter |
[
StartAbilityParameter
](
#startabilityparameter
)
| 是
| 表示被启动的Ability。 |
**示例：**
...
...
@@ -100,14 +100,14 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ---- | ------ | ---- | ------------
------------
|
| uri | string | 是 | 指示要打开的文件的路径。 |
| 名称
| 类型 | 必填 | 描述
|
| ---- | ------ | ---- | ------------ |
| uri | string | 是
| 指示要打开的文件的路径。 |
**返回值：**
| 类型
| 说明
|
| ----------------- | -------------------------------
-------------
|
| 类型
| 说明
|
| ----------------- | ------------------------------- |
| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 |
**示例：**
...
...
@@ -129,10 +129,10 @@ startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| --------- | ----------------------------------------
------- | ---- | -------
-------------- |
| parameter |
[
StartAbilityParameter
](
#startabilityparameter
)
| 是 | 表示被启动的Ability。 |
| callback | AsyncCallback
\<
[
AbilityResult
](
#abilityresult
)
> | 是
| 被指定的回调方法。
|
| 名称
| 类型 | 必填 | 描述
|
| --------- | ----------------------------------------
| ---- |
-------------- |
| parameter |
[
StartAbilityParameter
](
#startabilityparameter
)
| 是
| 表示被启动的Ability。 |
| callback | AsyncCallback
\<
[
AbilityResult
](
#abilityresult
)
> | 是
| 被指定的回调方法。
|
**示例：**
...
...
@@ -166,14 +166,14 @@ startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| --------- | ----------------------------------------
------- | ---- | ------
------------- |
| parameter |
[
StartAbilityParameter
](
#startabilityparameter
)
| 是 | 表示被启动的Ability |
| 名称
| 类型 | 必填 | 描述
|
| --------- | ----------------------------------------
| ---- |
------------- |
| parameter |
[
StartAbilityParameter
](
#startabilityparameter
)
| 是
| 表示被启动的Ability |
**返回值：**
| 类型
| 说明
|
| ----------------------------------------
- | -------
------- |
| 类型
| 说明
|
| ----------------------------------------
|
------- |
| Promise
\<
[
AbilityResult
](
#abilityresult
)
> | 返回执行结果。 |
**示例：**
...
...
@@ -222,10 +222,10 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| --------- | -------------
| ---- | -----
-------------- |
| parameter |
[
AbilityResult
](
#abilityresult
)
| 是 | 表示被启动的Ability。 |
| callback | AsyncCallback
\<
void>
| 是 | 被指定的回调方法。
|
| 名称
| 类型 | 必填 | 描述
|
| --------- | -------------
------------------ | ---- |
-------------- |
| parameter |
[
AbilityResult
](
#abilityresult
)
| 是
| 表示被启动的Ability。 |
| callback | AsyncCallback
\<
void>
| 是 | 被指定的回调方法。
|
**示例：**
...
...
@@ -270,14 +270,14 @@ terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| --------- | ------------------------------- | ---- | -------------
------
|
| parameter |
[
AbilityResult
](
#abilityresult
)
| 是 | 表示被启动的Ability |
| 名称
| 类型 | 必填 | 描述
|
| --------- | ------------------------------- | ---- | ------------- |
| parameter |
[
AbilityResult
](
#abilityresult
)
| 是
| 表示被启动的Ability |
**返回值：**
| 类型
| 说明
|
| -------------- | ---------------
--------
|
| 类型
| 说明
|
| -------------- | --------------- |
| Promise
\<
void> | 以Promise形式返回结果。 |
**示例：**
...
...
@@ -327,9 +327,9 @@ hasWindowFocus(callback: AsyncCallback\<boolean>): void
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| -------- | ----------------------- | ---- | ----------------------------------------
--------------------
|
| callback | AsyncCallback
\<
boolean> | 是 | 被指定的回调方法。
<br>
如果此Ability当前具有视窗焦点，则返回true；否则返回false。 |
| 名称
| 类型 | 必填 | 描述
|
| -------- | ----------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback
\<
boolean> | 是
| 被指定的回调方法。
<br>
如果此Ability当前具有视窗焦点，则返回true；否则返回false。 |
**示例：**
...
...
@@ -350,8 +350,8 @@ hasWindowFocus(): Promise\<boolean>
**返回值：**
| 类型
| 说明
|
| ----------------- | -------------------------------------
---------------------
|
| 类型
| 说明
|
| ----------------- | ------------------------------------- |
| Promise
\<
boolean> | 如果此Ability当前具有视窗焦点，则返回true；否则返回false。 |
**示例：**
...
...
@@ -375,9 +375,9 @@ getWant(callback: AsyncCallback\<Want>): void
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| -------- | ----------------------------- | ---- | ---------
---------
|
| callback | AsyncCallback
\<
[
Want
](
#want
)
> | 是 | 被指定的回调方法。 |
| 名称
| 类型 | 必填 | 描述
|
| -------- | ----------------------------- | ---- | --------- |
| callback | AsyncCallback
\<
[
Want
](
#want
)
> | 是
| 被指定的回调方法。 |
**示例：**
...
...
@@ -398,8 +398,8 @@ getWant(): Promise\<Want>
**返回值：**
| 类型
| 说明
|
| ----------------------- | ----------------
---------
|
| 类型
| 说明
|
| ----------------------- | ---------------- |
| Promise
\<
[
Want
](
#want
)
> | 以Promise的形式返回结果。 |
**示例：**
...
...
@@ -421,8 +421,8 @@ getContext(): Context
**返回值：**
| 类型
| 说明
|
| ------- | ----------
----------
|
| 类型
| 说明
|
| ------- | ---------- |
| Context | 返回应用程序上下文。 |
**示例：**
...
...
@@ -445,9 +445,9 @@ terminateSelf(callback: AsyncCallback\<void>): void
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| -------- | -------------------- | ---- | --------
--------
|
| callback | AsyncCallback
\<
void> | 是 | 被指定的回调方法 |
| 名称
| 类型 | 必填 | 描述
|
| -------- | -------------------- | ---- | -------- |
| callback | AsyncCallback
\<
void> | 是
| 被指定的回调方法 |
**示例：**
...
...
@@ -468,8 +468,8 @@ terminateSelf(): Promise\<void>
**返回值：**
| 类型
| 说明
|
| -------------- | ----------------
---------
|
| 类型
| 说明
|
| -------------- | ---------------- |
| Promise
\<
void> | 以Promise的形式返回结果。 |
**示例：**
...
...
@@ -490,35 +490,35 @@ connectAbility(request: Want, options:ConnectOptions): number
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ------- | -------------- | ---- | ---------------------
-------
|
| request |
[
Want
](
#want
)
| 是
| 表示被连接的ServiceAbility。 |
| options | ConnectOptions | 是
| 被指定的回调方法。
|
| 名称
| 类型 | 必填 | 描述
|
| ------- | -------------- | ---- | --------------------- |
| request |
[
Want
](
#want
)
| 是
| 表示被连接的ServiceAbility。 |
| options | ConnectOptions | 是
| 被指定的回调方法。
|
**Want类型说明：**
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称
| 读写属性 | 类型 | 必填 | 描述
|
| -----------
- | -------- | -------- | ---- | ----------------------------------
|
| deviceId
| 只读 | string | 否
| 表示被连接的ServiceAbility的设备id，缺省表示连接本地的ServiceAbility。 |
| bundleName
| 只读 | string | 是 | 表示被连接的ServiceAbility的包名。
|
| abilityName
| 只读 | string | 是 | 表示被连接的ServiceAbility的类名。
|
| 名称
| 读写属性 | 类型 | 必填 | 描述
|
| -----------
| ---- | ------ | ---- | ----------------------------------------
|
| deviceId
| 只读 | string | 否
| 表示被连接的ServiceAbility的设备id，缺省表示连接本地的ServiceAbility。 |
| bundleName
| 只读 | string | 是 | 表示被连接的ServiceAbility的包名。
|
| abilityName
| 只读 | string | 是 | 表示被连接的ServiceAbility的类名。
|
**ConnectOptions类型说明：**
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称
| 读写属性 | 类型 | 必填 | 描述
|
| ------------ | ----
---- | -------- | ---- | ---------
------------------------- |
| onConnect | 只读
| function | 是
| 连接成功时的回调函数。 |
| onDisconnect | 只读
| function | 是
| 连接失败时的回调函数。 |
| onFailed | 只读
| function | 是
| ConnectAbility调用失败时的回调函数。 |
| 名称
| 读写属性 | 类型 | 必填 | 描述
|
| ------------ | ----
| -------- | ---- |
------------------------- |
| onConnect | 只读
| function | 是
| 连接成功时的回调函数。 |
| onDisconnect | 只读
| function | 是
| 连接失败时的回调函数。 |
| onFailed | 只读
| function | 是
| ConnectAbility调用失败时的回调函数。 |
**返回值：**
| 类型
| 说明
|
| ------ | --------------------
----
|
| 类型
| 说明
|
| ------ | -------------------- |
| number | 连接的ServiceAbilityID。 |
**示例：**
...
...
@@ -559,10 +559,10 @@ disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ---------- | -------------
| ---- | -------
----------------------- |
| connection | number
| 是
| 指定断开连接的ServiceAbilityID |
| callback | AsyncCallback
\<
void> | 是
| 被指定的回调方法
|
| 名称
| 类型 | 必填 | 描述
|
| ---------- | -------------
------- | ---- |
----------------------- |
| connection | number
| 是
| 指定断开连接的ServiceAbilityID |
| callback | AsyncCallback
\<
void> | 是
| 被指定的回调方法
|
**示例：**
...
...
@@ -606,14 +606,14 @@ disconnectAbility(connection: number): Promise\<void>
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ---------- | ------ | ---- | -----------------------
-------
|
| connection | number | 是 | 指定断开连接的ServiceAbilityID |
| 名称
| 类型 | 必填 | 描述
|
| ---------- | ------ | ---- | ----------------------- |
| connection | number | 是
| 指定断开连接的ServiceAbilityID |
**返回值：**
| 类型
| 说明
|
| -------------- | ---------------
--------
|
| 类型
| 说明
|
| -------------- | --------------- |
| Promise
\<
void> | 以Promise形式返回结果。 |
**示例：**
...
...
@@ -658,16 +658,14 @@ getWindow(callback: AsyncCallback\<window.Window>): void
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| -------- | -----------------------
| ---- | -----------------------------------------------
------------- |
| callback | AsyncCallback
\<
window.Window> | 是 | 返回与当前能力对应的窗口。 |
| 名称
| 类型 | 必填 | 描述
|
| -------- | -----------------------
------ | ---- |
------------- |
| callback | AsyncCallback
\<
window.Window> | 是
| 返回与当前能力对应的窗口。 |
**示例：**
```
javascript
GetWindow
(){
featureAbility
.
getWindow
()
}
featureAbility
.
getWindow
()
```
## featureAbility.getWindow<sup>7+</sup>
...
...
@@ -680,18 +678,16 @@ getWindow(): Promise\<window.Window>;
**返回值：**
| 类型
| 说明
|
| -----------------
| ---------------------------------------------
------------- |
| 类型
| 说明
|
| -----------------
------ |
------------- |
| Promise
\<
window.Window> | 返回与当前能力对应的窗口。 |
**示例：**
```
javascript
GetWindowPromise
(){
featureAbility
.
getWindow
().
then
((
data
)
=>
{
console
.
info
(
"
=============getWindowPromise==========
"
+
JSON
.
stringify
(
data
));
});
}
featureAbility
.
getWindow
().
then
((
data
)
=>
{
console
.
info
(
"
=============getWindowPromise==========
"
+
JSON
.
stringify
(
data
));
});
```
## ConnectOptions.onConnect<sup>7+</sup>
...
...
@@ -704,10 +700,10 @@ onConnect(elementName: ElementName, remote: rpc.IRemoteObject): void;
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| --------
| ----------------------- | ---- | ----------------------------------------------------
-------- |
| elementName | ElementName
| 是 | 元素名。
|
| remote
| rpc.IRemoteObject | 是
| rpc远程对象。 |
| 名称
| 类型 | 必填 | 描述
|
| --------
--- | ----------------- | ---- |
-------- |
| elementName | ElementName
| 是 | 元素名。
|
| remote
| rpc.IRemoteObject | 是
| rpc远程对象。 |
**示例：**
...
...
@@ -747,9 +743,9 @@ onDisconnect(elementName: ElementName): void;
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| --------
| ----------------------- | ---- | --------------------------------------------------------
---- |
| elementName | ElementName | 是 | 元素名。 |
| 名称
| 类型 | 必填 | 描述
|
| --------
--- | ----------- | ---- |
---- |
| elementName | ElementName | 是
| 元素名。 |
**示例：**
...
...
@@ -789,9 +785,9 @@ ConnectAbility调用失败时的回调函数。
**参数：**
| 名称
| 类型 | 必填 | 描述
|
| ----
---- | ----------------------- | ---- | ---------------------------------------------------
--------- |
| code | number | 是 | number类型。 |
| 名称
| 类型 | 必填 | 描述
|
| ----
| ------ | ---- |
--------- |
| code | number | 是
| number类型。 |
**示例：**
...
...
@@ -835,13 +831,13 @@ var connId = featureAbility.connectAbility(
featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED
```
| 名称
| 参数 | 描述
|
| ---------------------------
| ---- |
---------- |
| 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_UNDEFINED
<sup>
7+
</sup>
| 0 | 未定义。
<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_SECONDARY
<sup>
7+
</sup>
| 101 | 分屏次屏。
<br/>
**系统能力**
：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_FLOATING
<sup>
7+
</sup>
| 102 | 悬浮窗。
<br/>
**系统能力**
：SystemCapability.Ability.AbilityRuntime.FAModel
|
| WINDOW_MODE_FLOATING
<sup>
7+
</sup>
| 102 | 悬浮窗。
<br/>
**系统能力**
：SystemCapability.Ability.AbilityRuntime.FAModel |
## AbilityStartSetting
...
...
@@ -856,34 +852,34 @@ abilityStartSetting属性是一个定义为[key: string]: any的对象，key对
featureAbility.AbilityStartSetting.BOUNDS_KEY
```
| 名称
| 参数 | 描述
|
| ---------------
| --------------- |
-------------------------- |
| BOUNDS_KEY
<sup>
7+
</sup>
| "abilityBounds" | 窗口显示大小属性的名称。
<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 |
| 名称
| 参数 | 描述
|
| ---------------
------------- | --------------- | --------------
-------------------------- |
| BOUNDS_KEY
<sup>
7+
</sup>
| "abilityBounds" | 窗口显示大小属性的名称。
<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 |
## ErrorCode
获取错误代码。
| 变量
| 值 | 说明
|
| -----------------------------
| ---- | --------------------
---------------------------------------- |
| NO_ERROR
<sup>
7+
</sup>
| 0 | 没有错误。
<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 |
| PERMISSION_DENY
<sup>
7+
</sup>
| -3
| 拒绝许可。
<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 |
| ABILITY_NOT_FOUND
<sup>
7+
</sup>
| -2
| 找不到能力。
<br/>
**系统能力**
：SystemCapability.Ability.AbilityRuntime.FAModel |
| PERMISSION_DENY
<sup>
7+
</sup>
| -3
| 拒绝许可。
<br/>
**系统能力**
：SystemCapability.Ability.AbilityRuntime.FAModel |
## DataAbilityOperationType
指示数据的操作类型。
| 变量
| 值 | 说明
|
| ------------------------
----- | ---- | --------------------
---------------------------------------- |
| TYPE_INSERT
<sup>
7+
</sup>
| 1
| 插入类型。
<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_ASSERT
<sup>
7+
</sup>
| 4 | 声明类型。
<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_DELETE
<sup>
7+
</sup>
| 3 | 删除类型。
<br/>
**系统能力**
：SystemCapability.Ability.AbilityRuntime.FAModel |
| TYPE_ASSERT
<sup>
7+
</sup>
| 4 | 声明类型。
<br/>
**系统能力**
：SystemCapability.Ability.AbilityRuntime.FAModel |
...
...
@@ -891,59 +887,59 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称
| 读写属性 | 类型 | 必填 | 描述
|
| ----------
| -------- | --------------------- | ---- | -----------------------
------------------------------------- |
| resultCode
<sup>
7+
</sup>
| 只读
| number | 是
| 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持）。 |
| want
<sup>
7+
</sup>
| 只读
|
[
Want
](
#want
)
| 否
| 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
| 名称
| 读写属性 | 类型 | 必填 | 描述
|
| ----------
------------- | ---- | ------------- | ---- |
------------------------------------- |
| resultCode
<sup>
7+
</sup>
| 只读
| number | 是
| 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持）。 |
| want
<sup>
7+
</sup>
| 只读
|
[
Want
](
#want
)
| 否
| 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
## StartAbilityParameter
**系统能力**
：以下各项对应的系统能力均为SystemCapability.AbilityRuntime.FAModel
| 名称
| 读写属性 | 类型 | 必填 | 描述
|
| ------------------- | ----
---- | -------------------- | ---- | ----------------------
-------------------------------------- |
| want | 只读
|
[
Want
](
#want
)
| 是 | 表示需要包含有关目标启动能力的信息。
|
| abilityStartSetting | 只读
| {[key: string]: any} | 否
| 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 |
| 名称
| 读写属性 | 类型 | 必填 | 描述
|
| ------------------- | ----
| -------------------- | ---- |
-------------------------------------- |
| want | 只读
|
[
Want
](
#want
)
| 是 | 表示需要包含有关目标启动能力的信息。
|
| abilityStartSetting | 只读
| {[key: string]: any} | 否
| 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 |
## Want
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称
| 读写属性 | 类型 | 必填 | 描述
|
| -----------
| -------- | -------------------- | ---- | --------------------
---------------------------------------- |
| deviceId
| 只读 | string | 否 | 表示运行指定Ability的设备ID。
|
| bundleName
| 只读 | string | 否
| 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName
| 只读 | string | 否
| 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| uri
| 只读 | string | 否
| 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
| type
| 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/
*
"等。
|
| flags
| 只读 | number | 否
| 表示处理Want的方式。默认传数字，具体参考：
[
flags说明
](
#flags说明
)
。 |
| action
| 只读 | string | 否 | 表示action选项描述。
|
| parameters
| 只读 | {[key: string]: any} | 否 | 表示WantParams描述。
|
| entities
| 只读 | Array
\<
string> | 否 | 表示entities相关描述。
|
| extensionAbilityName
<sup>
9+
<sup>
| 只读 | string | 否 | Want中扩展能力名称的描述。
|
| extensionAbilityType
<sup>
9+
<sup>
| 只读 | number | 否 | 需求中扩展能力类型的描述。
|
| 名称
| 读写属性 | 类型 | 必填 | 描述
|
| -----------
--------------------- | ---- | -------------------- | ---- |
---------------------------------------- |
| deviceId
| 只读 | string | 否 | 表示运行指定Ability的设备ID。
|
| bundleName
| 只读 | string | 否
| 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName
| 只读 | string | 否
| 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| uri
| 只读 | string | 否
| 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
| type
| 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/
*
"等。
|
| flags
| 只读 | number | 否
| 表示处理Want的方式。默认传数字，具体参考：
[
flags说明
](
#flags说明
)
。 |
| action
| 只读 | string | 否 | 表示action选项描述。
|
| parameters
| 只读 | {[key: string]: any} | 否 | 表示WantParams描述。
|
| entities
| 只读 | Array
\<
string> | 否 | 表示entities相关描述。
|
| extensionAbilityName
<sup>
9+
<sup>
| 只读 | string | 否 | Want中扩展能力名称的描述。
|
| extensionAbilityType
<sup>
9+
<sup>
| 只读 | number | 否 | 需求中扩展能力类型的描述。
|
## flags说明
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称
| 参数 | 描述
|
| ------------------------------------ | ---------- | ----------------------------------------
--------------------
|
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。
|
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。
|
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力。
|
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。 |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。
|
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。
|
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。
|
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。
|
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。
|
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。 |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。
|
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。
|
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。
|
| 名称
| 参数 | 描述
|
| ------------------------------------ | ---------- | ---------------------------------------- |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力。 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。
|
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。 |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。 |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。 |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。
|
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 |
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给
**[ohos.app.Context](js-apis-ability-context.md)**
中
**startAbility**
方法的
**Want**
设置此标志，并且必须与
**flag_ABILITY_NEW_MISSION**
一起使用。 |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。
|
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
浏览文件 @
481ff40b
...
...
@@ -26,24 +26,26 @@ getDeviceIds(callback: AsyncCallback<Array<number>>): void
**参数：**
| 参数
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- | ---
----- |
| callback | AsyncCallback
<
Array
<
number
>>
| 是 | 回调函数。 |
| 参数
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------------- | ---- |
----- |
| callback | AsyncCallback
<
Array
<
number
>>
| 是
| 回调函数。 |
**示例：**
```
data: {
deviceIds: Array,
},
callback: function(ids) {
this.deviceIds = ids;
},
testGetDeviceIds: function () {
console.info("InputDeviceJsTest---start---testGetDeviceIds");
inputDevice.getDeviceIds(this.callback);
console.info("InputDeviceJsTest---end---testGetDeviceIds");
export default {
data: {
deviceIds: Array,
},
callback: function(ids) {
this.deviceIds = ids;
},
testGetDeviceIds: function () {
console.info("InputDeviceJsTest---start---testGetDeviceIds");
inputDevice.getDeviceIds(this.callback);
console.info("InputDeviceJsTest---end---testGetDeviceIds");
}
}
```
...
...
@@ -57,21 +59,23 @@ function getDeviceIds(): Promise<Array<number>>
**返回值：**
| 参数
| 说明
|
| --------
|
-------- |
| 参数
| 说明
|
| --------
-------------- | ----------
-------- |
| Promise
<Array
<
number
>
> | Promise实例，用于异步获取结果 |
**示例：**
```
testGetDeviceIds: function () {
console.info("InputDeviceJsTest---start---testGetDeviceIds");
let promise = inputDevice.getDeviceIds();
promise.then((data)=> {
console.info('GetDeviceIds successed, Data: ' + JSON.stringify(data))
}).catch((err)=>{
console.error('Failed GetDeviceIds. Cause: ' + JSON.stringify(err));
});
export default {
testGetDeviceIds: function () {
console.info("InputDeviceJsTest---start---testGetDeviceIds");
let promise = inputDevice.getDeviceIds();
promise.then((data)=> {
console.info('GetDeviceIds successed, Data: ' + JSON.stringify(data))
}).catch((err)=>{
console.error('Failed GetDeviceIds. Cause: ' + JSON.stringify(err));
});
}
}
```
...
...
@@ -89,28 +93,30 @@ getDevice(deviceId: number, callback: AsyncCallback<InputDeviceData>): voi
**参数：**
| 参数
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| deviceId | number
| 是 | 需要获取信息的设备id。
|
| callback | AsyncCallback
<
[InputDeviceData](#inputdevicedata)
>
| 是 | 回调函数，异步返回InputDeviceData对象。 |
| 参数
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------------- | ---- | -------------------
-------- |
| deviceId | number
| 是 | 需要获取信息的设备id。
|
| callback | AsyncCallback
<
[InputDeviceData](#inputdevicedata)
>
| 是
| 回调函数，异步返回InputDeviceData对象。 |
**示例：**
```
InputDeviceData {
deviceId : 0,
name : "NA",
sources : Array,
axisRanges : Array,
},
callback: function(deviceData) {
this.InputDeviceData = deviceData;
},
testGetDevice: function () {
// 示例获取设备id为1的设备信息。
console.info("InputDeviceJsTest---start---testGetDevice");
inputDevice.getDevice(1, this.callback);
console.info("InputDeviceJsTest---end---testGetDevice");
export default {
InputDeviceData {
deviceId : 0,
name : "NA",
sources : Array,
axisRanges : Array,
},
callback: function(deviceData) {
this.InputDeviceData = deviceData;
},
testGetDevice: function () {
// 示例获取设备id为1的设备信息。
console.info("InputDeviceJsTest---start---testGetDevice");
inputDevice.getDevice(1, this.callback);
console.info("InputDeviceJsTest---end---testGetDevice");
}
}
```
...
...
@@ -124,28 +130,30 @@ function getDevice(deviceId: number): Promise<InputDeviceData>
**返回值：**
| 参数
| 说明
|
| --------
|
-------- |
| 参数
| 说明
|
| --------
---------------- | ----------
-------- |
| Promise
<InputDeviceData>
| Promise实例，用于异步获取结果 |
**示例：**
```
InputDeviceData {
deviceId : 0,
name : "NA",
sources : Array,
axisRanges : Array,
},
testGetDevice: function () {
// 示例获取设备id为1的设备信息。
console.info("InputDeviceJsTest---start---testGetDevice");
let promise = inputDevice.getDevice(1);
promise.then((data)=> {
console.info('GetDeviceId successed, Data: ' + JSON.stringify(data))
}).catch((err)=>{
console.error('Failed GetDeviceId. Cause: ' + JSON.stringify(err));
});
export default {
InputDeviceData {
deviceId : 0,
name : "NA",
sources : Array,
axisRanges : Array,
},
testGetDevice: function () {
// 示例获取设备id为1的设备信息。
console.info("InputDeviceJsTest---start---testGetDevice");
let promise = inputDevice.getDevice(1);
promise.then((data)=> {
console.info('GetDeviceId successed, Data: ' + JSON.stringify(data))
}).catch((err)=>{
console.error('Failed GetDeviceId. Cause: ' + JSON.stringify(err));
});
}
}
```
...
...
@@ -157,10 +165,10 @@ testGetDevice: function () {
**系统能力：**
以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
| 名称
| 参数类型 | 说明
|
| -------
- | -------- |
-------- |
| id
| number | 输入设备的唯一标识，同一个物理设备反复插拔，其设备id会发生变化。
|
| name
| string | 输入设备的名字。
|
| 名称
| 参数类型 | 说明
|
| -------
| -------------------------------------- | --------------------------------
-------- |
| id
| number | 输入设备的唯一标识，同一个物理设备反复插拔，其设备id会发生变化。
|
| name
| string | 输入设备的名字。
|
| sources | Array
<
[SourceType](#sourcetype)
>
| 输入设备支持的源类型。比如有的键盘上附带触摸板，则此设备有keyboard和touchpad两种输入源。 |
## AxisType
...
...
@@ -173,12 +181,12 @@ testGetDevice: function () {
**系统能力：**
以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
| 名称
| 参数类型 | 说明
|
| ------ | ------------------------- | --------
--------
|
| 名称
| 参数类型 | 说明
|
| ------ | ------------------------- | -------- |
| source |
[
SourceType
](
#sourcetype
)
| 轴的输入源类型。 |
| axis |
[
AxisType
](
axistype
)
| 轴的类型
|
| max | number | 轴上报的最大值
|
| min | number | 轴上报的最小值
|
| axis |
[
AxisType
](
axistype
)
| 轴的类型 |
| max | number | 轴上报的最大值 |
| min | number | 轴上报的最小值 |
...
...
@@ -188,11 +196,11 @@ testGetDevice: function () {
**系统能力：**
以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
| 名称
| 参数类型 | 说明
|
| --------
| -------- |
-------- |
| keyboard
| string | 表示输入设备是键盘。
|
| 名称
| 参数类型 | 说明
|
| --------
--- | ------ | ---
-------- |
| keyboard
| string | 表示输入设备是键盘。
|
| touchscreen | string | 表示输入设备是触摸屏。 |
| mouse
| string | 表示输入设备是鼠标。
|
| trackball | string | 表示输入设备是轨迹球。 |
| touchpad | string | 表示输入设备是触摸板。 |
| joystick | string | 表示输入设备是操纵杆。 |
| mouse
| string | 表示输入设备是鼠标。
|
| trackball
| string | 表示输入设备是轨迹球。 |
| touchpad
| string | 表示输入设备是触摸板。 |
| joystick
| string | 表示输入设备是操纵杆。 |
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
浏览文件 @
481ff40b
...
...
@@ -3,7 +3,7 @@
>  **说明：**
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
>
> - 本模块接口均为系统接口，三方应用不支持调用。
...
...
@@ -31,30 +31,32 @@ on(type: "touch", receiver: TouchEventReceiver): void
**系统能力：**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| -------- | --------
| -------- |
-------- |
| type
| string | 是 | 监听输入事件类型，只支持“touch”。 |
| receiver |
[
TouchEventReceiver
](
#toucheventreceiver
)
| 是
| 触摸输入事件回调函数。 |
| 参数 | 类型 | 必填 | 说明 |
| -------- | --------
-------------------------------- | ---- | ------------
-------- |
| type
| string | 是 | 监听输入事件类型，只支持“touch”。 |
| receiver |
[
TouchEventReceiver
](
#toucheventreceiver
)
| 是
| 触摸输入事件回调函数。 |
**示例：**
```
callback: function (value) {
if (checkEvent(value)) {
//事件满足业务要求，事件被消费
return true;
} else {
//事件不满足业务要求，事件未被消费
return false;
export default {
callback: function (value) {
if (checkEvent(value)) {
//事件满足业务要求，事件被消费
return true;
} else {
//事件不满足业务要求，事件未被消费
return false;
}
},
testOn: function () {
console.info("InputMonitorJsTest---start---testOn");
inputMonitor.on(
"touch",
this.callback
);
console.info("InputMonitorJsTest---end---testOn");
}
},
testOn: function () {
console.info("InputMonitorJsTest---start---testOn");
inputMonitor.on(
"touch",
this.callback
);
console.info("InputMonitorJsTest---end---testOn");
}
```
...
...
@@ -70,31 +72,33 @@ off(type: "touch", receiver: TouchEventReceiver): void
**系统能力：**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| -------- | --------
| -------- |
-------- |
| type
| string | 是 | 监听输入事件类型，只支持“touch”。 |
| receiver |
[
TouchEventReceiver
](
#toucheventreceiver
)
| 否
| 触摸输入事件回调函数。 |
| 参数 | 类型 | 必填 | 说明 |
| -------- | --------
-------------------------------- | ---- | ------------
-------- |
| type
| string | 是 | 监听输入事件类型，只支持“touch”。 |
| receiver |
[
TouchEventReceiver
](
#toucheventreceiver
)
| 否
| 触摸输入事件回调函数。 |
**示例：**
```
callback: function (value) {
if (checkEvent(value)) {
//事件满足业务要求，事件被消费
return true;
} else {
//事件不满足业务要求，事件未被消费
return false;
export default {
callback: function (value) {
if (checkEvent(value)) {
//事件满足业务要求，事件被消费
return true;
} else {
//事件不满足业务要求，事件未被消费
return false;
}
},
testOff: function () {
console.info("InputMonitorJsTest---start---testOff");
inputMonitor.off(
"touch",
this.callback
);
console.info("InputMonitorJsTest---end---testOff");
}
},
testOff: function () {
console.info("InputMonitorJsTest---start---testOff");
inputMonitor.off(
"touch",
this.callback
);
console.info("InputMonitorJsTest---end---testOff");
}
}
```
...
...
@@ -110,33 +114,35 @@ testOff: function () {
**系统能力：**
SystemCapability.MultimodalInput.Input.InputMonitor
**参数：**
| 参数
| 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
| 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 方法的实现
if (checkEvent(value)) {
//事件满足业务要求，事件被消费
return true;
} else {
//事件不满足业务要求，事件未被消费
return false;
export default {
callback: function (value) { //此处为(touchEvent:TouchEvent): Boolean 方法的实现
if (checkEvent(value)) {
//事件满足业务要求，事件被消费
return true;
} else {
//事件不满足业务要求，事件未被消费
return false;
}
},
testOff: function () {
console.info("InputMonitorJsTest---start---testOff");
inputMonitor.off(
"touch",
this.callback
);
console.info("InputMonitorJsTest---end---testOff");
}
},
testOff: function () {
console.info("InputMonitorJsTest---start---testOff");
inputMonitor.off(
"touch",
this.callback
);
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);
## sensor.off(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED)
off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback
<
GyroscopeResponse
>
): void
off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback
<
Gyroscope
Uncalibrated
Response
>
): void
取消订阅传感器数据。
...
...
@@ -1909,7 +1909,7 @@ getGeomagneticDip(inclinationMatrix: Array<number>): Promise<number>
## sensor. getAngleModify
getAngleModify(currentRotationMatrix: Array
<
number
>
, preRotationMatrix: Array
<
number
>
，
callback: AsyncCallback
<
Array
<
number
>>
): void
getAngleModify(currentRotationMatrix: Array
<
number
>
, preRotationMatrix: Array
<
number
>
,
callback: AsyncCallback
<
Array
<
number
>>
): void
获取两个旋转矩阵之间的角度变化。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑！
取消
想要评论请
注册
或
登录
