Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 ba3112c1 编写于 作者: X xuchenghua09
浏览文件
操作

Update js-apis 

Signed-off-by: Nxuchenghua09 <xuchenghua09@huawei.com>
上级 0a6d3fe9
隐藏空白更改
内联 并排
Showing with 3794 addition and 3645 deletion
zh-cn/application-dev/reference/apis/js-apis-Context.md
浏览文件 @ ba3112c1
# Context模块(JS端SDK接口) # Context模块
#### 支持设备 ## 支持设备
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 | | API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ | | ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ |
| Context.getOrCreateLocalDir(callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getOrCreateLocalDir(callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getOrCreateLocalDir() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getOrCreateLocalDir() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.verifyPermission(permission: string, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.verifyPermission(permission: string, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.verifyPermission(permission: string, options?: PermissionOptions) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.verifyPermission(permission: string, options?: PermissionOptions) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, resultCallback: AsyncCallback\<PermissionRequestResult>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, resultCallback: AsyncCallback\<PermissionRequestResult>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getApplicationInfo() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getApplicationInfo() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getBundleName(callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getBundleName(callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getBundleName() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getBundleName() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getProcessInfo(callback: AsyncCallback\<ProcessInfo>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getProcessInfo(callback: AsyncCallback\<ProcessInfo>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getProcessInfo() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getProcessInfo() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getElementName(callback: AsyncCallback\<ElementName>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getElementName(callback: AsyncCallback\<ElementName>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getElementName() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getElementName() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getProcessName(callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getProcessName(callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getProcessName() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getProcessName() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getCallingBundle(callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getCallingBundle(callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| Context.getCallingBundle() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | Context.getCallingBundle() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
#### 权限列表 ## 导入模块
**ohos.permission.RUNNING_LOCK permission** ```js
import featureAbility from '@ohos.ability.featureAbility'
#### 导入模块 import bundle from '@ohos.bundle'
```
```
import featureAbility from '@ohos.ability.featureAbility' Context对象是在featureAbility中创建实例，并通过featureAbility的getContext()接口返回，因此在使用Context时，必须导入@ohos.ability.featureAbility库。示例如下：
import bundle from '@ohos.bundle'
``` ```js
import featureAbility from '@ohos.ability.featureAbility'
#### Context.getOrCreateLocalDir(callback: AsyncCallback\<string>) var context = featureAbility.getContext();
context.getOrCreateLocalDir()
- 接口说明 ```
获取应用程序的本地根目录。如果是第一次调用，将创建目录(callback形式) ## Context.getOrCreateLocalDir(callback: AsyncCallback<string>)
- getOrCreateLocalDir参数描述 - 接口说明
获取应用程序的本地根目录。如果是第一次调用，将创建目录(callback形式)
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ----------------------- | ---- | ---------------- | - getOrCreateLocalDir参数描述
| callback | 只读 | AsyncCallback\<string>) | 是 | 被指定的回调方法 |
- 返回值 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | ------------------------ |
根目录 | callback | 只读 | AsyncCallback\<string> | 是 | 返回应用程序的本地根目录 |
- 示例 - 返回值
```js void
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext(); - 示例
context.getOrCreateLocalDir()
``` ```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getOrCreateLocalDir((err, data)=>{
#### Context.getOrCreateLocalDir() console.info("data=" + data);
})
- 接口说明 ```
获取应用程序的本地根目录。如果是第一次调用，将创建目录(Promise形式)
- 返回值 ## Context.getOrCreateLocalDir()
根目录 - 接口说明
- 示例 获取应用程序的本地根目录。如果是第一次调用，将创建目录(Promise形式)
```js - 返回值
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext(); | 类型 | 说明 |
context.getOrCreateLocalDir().then((void) => { | --------------- | -------------------- |
console.info("==========================>getOrCreateLocalDirCallback=======================>"); | Promise<string> | 应用程序的本地根目录 |
});
``` - 示例
```js
import featureAbility from '@ohos.ability.featureAbility'
#### Context.verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback\<number>) var context = featureAbility.getContext();
context.getOrCreateLocalDir().then((void) => {
- 接口说明 console.info("==========================>getOrCreateLocalDirCallback=======================>");
});
验证系统中运行的特定pid和uid是否允许指定的权限(callback形式) ```
- verifyPermission参数描述 ## PermissionOptions类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | ---- | -------- | ------ | ---- | ------ |
| ---------- | -------- | ---------------------- | ---- | ---------------- | | pid | 只读 | number | 否 | 进程id |
| permission | 只读 | string | 是 | 指定权限的名称 | | uid | 只读 | number | 否 | 用户id |
| options | 只读 | PermissionOptions | 是 | 进程id |
| callback | 只读 | AsyncCallback\<number> | 是 | 被指定的回调方法 | ## Context.verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback<number>)
- PermissionOptions类型说明 - 接口说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | 验证系统中运行的特定pid和uid是否允许指定的权限(callback形式)
| ---- | -------- | ------ | ---- | ------ |
| pid | 只读 | number | 否 | 进程id | - 参数描述
| uid | 只读 | number | 否 | 用户id |
- 返回值 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ----------------------------------------------- | ---- | ----------------------------------- |
如果PID和UID具有权限，则使用{@code 0}进行异步回调；否则使用{@code-1}回调。 | permission | 只读 | string | 是 | 指定权限的名称 |
| options | 只读 | [PermissionOptions](#PermissionOptions类型说明) | 是 | 进程id |
- 示例 | callback | 只读 | AsyncCallback\<number> | 是 | 返回权限验证结果，0有权限，-1无权限 |
```js - 返回值
import featureAbility from '@ohos.ability.featureAbility'
import bundle from '@ohos.bundle' void
var context = featureAbility.getContext();
var datainfo = await bundle.getBundleInfo('com.context.test',1); - 示例
context.verifyPermission("com.example.permission",datainfo.uid,)
```js
``` import featureAbility from '@ohos.ability.featureAbility'
import bundle from '@ohos.bundle'
var context = featureAbility.getContext();
var datainfo = await bundle.getBundleInfo('com.context.test',1);
#### Context.verifyPermission(permission: string, callback: AsyncCallback\<number>) context.verifyPermission("com.example.permission",datainfo.uid)
- 接口说明 ```
验证系统中运行的特定pid和uid是否允许指定的权限(callback形式)
- 参数描述 ## Context.verifyPermission(permission: string, callback: AsyncCallback<number>)
- 接口说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ----------------------- | ---- | ---------------- | 验证系统中运行的特定pid和uid是否具有指定的权限(callback形式)
| permission | 只读 | string | 是 | 指定权限的名称 |
| callback | 只读 | AsyncCallback\<number>) | 是 | 被指定的回调方法 | - 参数描述
- 返回值
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
如果PID和UID具有权限，则使用{@code 0}进行异步回调；否则使用{@code-1}回调。 | ---------- | -------- | ---------------------- | ---- | ----------------------------------- |
| permission | 只读 | string | 是 | 指定权限的名称 |
- 示例 | callback | 只读 | AsyncCallback\<number> | 是 | 返回权限验证结果，0有权限，-1无权限 |
```js - 返回值
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext(); void
context.verifyPermission("com.example.permission")
``` - 示例
```js
import featureAbility from '@ohos.ability.featureAbility'
#### Context.verifyPermission(permission: string, options?: PermissionOptions) var context = featureAbility.getContext();
context.verifyPermission("com.example.permission")
- 接口说明 ```
验证系统中运行的特定pid和uid是否允许指定的权限(Promise形式)
- verifyPermission参数描述
## Context.verifyPermission(permission: string, options?: PermissionOptions)
| 名称 | 读写属性 | 类型 | 必填 | 描述 | - 接口说明
| ---------- | -------- | ----------------- | ---- | -------------- |
| permission | 只读 | string | 是 | 指定权限的名称 | 验证系统中运行的特定pid和uid是否具有指定的权限(Promise形式)
| options | 只读 | PermissionOptions | 否 | 进程id | - 参数描述
- PermissionOptions类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | ---------- | -------- | ----------------------------------------------- | ---- | -------------- |
| ---- | -------- | ------ | ---- | ------ | | permission | 只读 | string | 是 | 指定权限的名称 |
| pid | 只读 | number | 否 | 进程id | | options | 只读 | [PermissionOptions](#PermissionOptions类型说明) | 否 | 进程id |
| uid | 只读 | number | 否 | 用户id |
- 返回值
- 返回值
| 类型 | 说明 |
如果PID和UID具有权限，则使用{@code 0}进行异步回调；否则使用{@code-1}回调。 | --------------- | ------------------------------------------------------------ |
| Promise<number> | 如果pid和uid具有权限，则使用{@code 0}进行异步回调；否则使用{@code-1}回调。 |
- 示例
- 示例
```js
import featureAbility from '@ohos.ability.featureAbility' ```js
var context = featureAbility.getContext(); import featureAbility from '@ohos.ability.featureAbility'
var Permission = context.PermissionOptions(1,1); var context = featureAbility.getContext();
context.getOrCreateLocalDir('com.context.permission',Permission).then((void) => { var Permission = context.PermissionOptions(1,1);
console.info("==========================>verifyPermissionCallback=======================>"); context.getOrCreateLocalDir('com.context.permission',Permission).then((void) => {
}); console.info("==========================>verifyPermissionCallback=======================>");
``` });
```
## PermissionRequestResult类型说明
#### Context.requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, resultCallback: AsyncCallback\<PermissionRequestResult>)
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
- 接口说明 | ----------- | -------- | -------------- | ---- | ------------------ |
| requestCode | 只读 | number | 是 | 用户传入的请求代码 |
从系统请求某些权限(callback形式) | permissions | 只读 | Array\<string> | 是 | 用户传入的权限 |
| authResults | 只读 | Array\<number> | 是 | 求权限的结果 |
- requestPermissionsFromUser参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ## Context.requestPermissionsFromUser(permissions: Array<string>, requestCode: number, resultCallback: AsyncCallback<[PermissionRequestResult](#PermissionRequestResult类型说明)>)
| -------------- | -------- | ---------------------------------------- | ---- | --------------------------------------------- |
| permissions | 只读 | Array\<string> | 是 | 指示要请求的权限列表。此参数不能为null | - 接口说明
| requestCode | 只读 | number | 是 | 指示要传递给PermissionRequestResult的请求代码 |
| resultCallback | 只读 | AsyncCallback\<PermissionRequestResult>) | 是 | 被指定的回调方法 | 从系统请求某些权限(callback形式)
- PermissionRequestResult类型说明
- requestPermissionsFromUser参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------- | ---- | ------------------ |
| requestCode | 只读 | number | 是 | 用户传入的请求代码 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| permissions | 只读 | Array\<string> | 是 | 用户传入的权限 | | -------------- | -------- | ------------------------------------------------------------ | ---- | --------------------------------------------- |
| authResults | 只读 | Array\<number> | 是 | 求权限的结果 | | permissions | 只读 | Array\<string> | 是 | 指示要请求的权限列表。此参数不能为null |
| requestCode | 只读 | number | 是 | 指示要传递给PermissionRequestResult的请求代码 |
- 返回值 | resultCallback | 只读 | AsyncCallback\<[PermissionRequestResult](#PermissionRequestResult类型说明)> | 是 | 返回授权结果信息 |
- 返回值
void
void
- 示例
- 示例
```js
import featureAbility from '@ohos.ability.featureAbility' ```js
var context = featureAbility.getContext(); import featureAbility from '@ohos.ability.featureAbility'
context.getOrCreateLocalDir( var context = featureAbility.getContext();
["com.example.permission1", context.getOrCreateLocalDir(
"com.example.permission2", ["com.example.permission1",
"com.example.permission3", "com.example.permission2",
"com.example.permission4", "com.example.permission3",
"com.example.permission5"], "com.example.permission4",
1, "com.example.permission5"],
) 1,
``` )
```
#### Context.getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>)
## Context.getApplicationInfo(callback: AsyncCallback<ApplicationInfo>)
- 接口说明
- 接口说明
获取有关当前应用程序的信息（callback形式）
获取有关当前应用程序的信息（callback形式）
- 参数描述
- 参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------------- | ---- | -------------------- | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| callback | 只读 | AsyncCallback\<ApplicationInfo> | 是 | 表示被指定的回调方法 | | -------- | -------- | ------------------------------- | ---- | ---------------------- |
| callback | 只读 | AsyncCallback\<ApplicationInfo> | 是 | 返回当前应用程序的信息 |
- 返回值
- 返回值
void
void
- 示例
- 示例
```js
import featureAbility from '@ohos.ability.featureAbility' ```js
var context = featureAbility.getContext(); import featureAbility from '@ohos.ability.featureAbility'
context.getApplicationInfo() var context = featureAbility.getContext();
``` context.getApplicationInfo()
```
#### Context.getApplicationInfo()
## Context.getApplicationInfo
- 接口说明
- 接口说明
获取有关当前应用程序的信息（Promise形式)
获取有关当前应用程序的信息（Promise形式)
- 参数描述
- 参数描述
Null
无
- 返回值
- 返回值
void
| 类型 | 说明 |
- 示例 | ------------------------ | ------------------ |
| Promise<ApplicationInfo> | 当前应用程序的信息 |
```js
import featureAbility from '@ohos.ability.featureAbility' - 示例
var context = featureAbility.getContext();
context.getApplicationInfo().then((void) => { ```js
console.info("==========================>getApplicationInfoCallback=======================>"); import featureAbility from '@ohos.ability.featureAbility'
}); var context = featureAbility.getContext();
``` context.getApplicationInfo().then((void) => {
console.info("==========================>getApplicationInfoCallback=======================>");
});
```
#### Context.getBundleName(callback: AsyncCallback\<string>)
- 接口说明
## Context.getBundleName(callback: AsyncCallback<string>)
获取当前ability的捆绑包名称（callback形式）
- 接口说明
- 参数描述
获取当前ability的捆绑包名称（callback形式）
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | -------------------- | - 参数描述
| callback | 只读 | AsyncCallback\<string> | 是 | 表示被指定的回调方法 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
- 返回值 | -------- | -------- | ---------------------- | ---- | --------------------------- |
| callback | 只读 | AsyncCallback\<string> | 是 | 返回当前ability的捆绑包名称 |
void
- 返回值
- 示例
void
```js
import featureAbility from '@ohos.ability.featureAbility' - 示例
var context = featureAbility.getContext();
context.getBundleName() ```js
``` import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getBundleName()
```
#### Context.getBundleName()
- 接口说明
## Context.getBundleName
获取当前ability的捆绑包名称（Promise形式)
- 接口说明
- 参数描述
获取当前ability的捆绑包名称（Promise形式)
Null
- 参数描述
- 返回值
无
void
- 返回值
- 示例
| 类型 | 说明 |
```js | --------------- | ----------------------- |
import featureAbility from '@ohos.ability.featureAbility' | Promise<string> | 当前ability的捆绑包名称 |
var context = featureAbility.getContext();
context.getBundleName().then((void) => { - 示例
console.info("==========================>getBundleNameCallback=======================>");
}); ```js
``` import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getBundleName().then((void) => {
console.info("==========================>getBundleNameCallback=======================>");
#### Context.getProcessInfo(callback: AsyncCallback\<ProcessInfo>) });
```
- 接口说明
获取有关当前进程的信息，包括进程ID和名称（callback形式）
## Context.getProcessInfo(callback: AsyncCallback<ProcessInfo>)
- 参数描述
- 接口说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------------- | ---- | -------------------- | 获取有关当前进程的信息，包括进程ID和名称（callback形式）
| callback | 只读 | AsyncCallback\<ProcessInfo> | 是 | 表示被指定的回调方法 |
- 参数描述
- 返回值
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
void | -------- | -------- | --------------------------- | ---- | ------------------ |
| callback | 只读 | AsyncCallback\<ProcessInfo> | 是 | 返回当前进程的信息 |
- 示例
- 返回值
```js
import featureAbility from '@ohos.ability.featureAbility' void
var context = featureAbility.getContext();
context.getProcessInfo() - 示例
```
```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
#### Context.getProcessInfo() context.getProcessInfo()
```
- 接口说明
获取有关当前进程的信息，包括进程ID和名称（Promise形式)
## Context.getProcessInfo
- 参数描述
- 接口说明
Null
获取有关当前进程的信息，包括进程id和名称（Promise形式)
- 返回值
- 参数描述
void
无
- 示例
- 返回值
```js
import featureAbility from '@ohos.ability.featureAbility' | 类型 | 说明 |
var context = featureAbility.getContext(); | -------------------- | -------------- |
context.getProcessInfo().then((void) => { | Promise<ProcessInfo> | 当前进程的信息 |
console.info("==========================>getProcessInfoCallback=======================>");
}); - 示例
```
```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
#### Context.getElementName(callback: AsyncCallback\<ElementName>) context.getProcessInfo().then((void) => {
console.info("==========================>getProcessInfoCallback=======================>");
- 接口说明 });
```
获取当前能力的ohos.bundle.ElementName对象。此方法仅适用于页面功能(callback形式）
- 参数描述
## Context.getElementName(callback: AsyncCallback<ElementName>)
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------------- | ---- | -------------------- | - 接口说明
| callback | 只读 | AsyncCallback\<ElementName> | 是 | 表示被指定的回调方法 |
获取当前ability的ohos.bundle.ElementName对象。此方法仅适用于页面功能(callback形式）
- 返回值
- 参数描述
void
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
- 示例 | -------- | -------- | --------------------------- | ---- | -------------------------------------------- |
| callback | 只读 | AsyncCallback\<ElementName> | 是 | 返回当前ability的ohos.bundle.ElementName对象 |
```js
import featureAbility from '@ohos.ability.featureAbility' - 返回值
var context = featureAbility.getContext();
context.getElementName() void
```
- 示例
```js
#### Context.getElementName() import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
- 接口说明 context.getElementName()
```
获取当前能力的ohos.bundle.ElementName对象。此方法仅适用于页面功能(Promise形式)
- 参数描述
## Context.getElementName
Null
- 接口说明
- 返回值
获取当前能力的ohos.bundle.ElementName对象。此方法仅适用于页面功能(Promise形式)
void
- 参数描述
- 示例
无
```js
import featureAbility from '@ohos.ability.featureAbility' - 返回值
var context = featureAbility.getContext();
context.getElementName().then((void) => { | 类型 | 说明 |
console.info("==========================>getElementNameCallback=======================>"); | -------------------- | ---------------------------------------- |
}); | Promise<ElementName> | 当前ability的ohos.bundle.ElementName对象 |
```
- 示例
####
```js
#### Context.getProcessName(callback: AsyncCallback\<string>) import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
- 接口说明 context.getElementName().then((void) => {
console.info("==========================>getElementNameCallback=======================>");
获取当前进程的名称(callback形式） });
```
- 参数描述
## **Context.getProcessName(callback: AsyncCallback<string>)**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | -------------------- | - 接口说明
| callback | 只读 | AsyncCallback\<string> | 是 | 表示被指定的回调方法 |
获取当前进程的名称(callback形式）
- 返回值
- 参数描述
void
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
- 示例 | -------- | -------- | ---------------------- | ---- | ------------------ |
| callback | 只读 | AsyncCallback\<string> | 是 | 返回当前进程的名称 |
```js
import featureAbility from '@ohos.ability.featureAbility' - 返回值
var context = featureAbility.getContext();
context.getProcessName() void
```
- 示例
```js
#### Context.getProcessName() import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
- 接口说明 context.getProcessName()
```
获取当前进程的名称(Promise形式)
- 参数描述
## Context.getProcessName
Null
- 接口说明
- 返回值
获取当前进程的名称(Promise形式)
void
- 参数描述
- 示例
无
```js
import featureAbility from '@ohos.ability.featureAbility' - 返回值
var context = featureAbility.getContext();
context.getProcessName().then((void) => { | 类型 | 说明 |
console.info("==========================>getProcessNameCallback=======================>"); | --------------- | -------------- |
}); | Promise<string> | 当前进程的名称 |
```
- 示例
```js
#### Context.getCallingBundle(callback: AsyncCallback\<string>) import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
- 接口说明 context.getProcessName().then((void) => {
console.info("==========================>getProcessNameCallback=======================>");
获取调用当前能力的能力的捆绑包名称(callback形式） });
```
- 参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | -------------------- | ## Context.getCallingBundle(callback: AsyncCallback<string>)
| callback | 只读 | AsyncCallback\<string> | 是 | 表示被指定的回调方法 |
- 接口说明
- 返回值
获取调用当前ability捆绑包名称(callback形式）
void
- 参数描述
- 示例
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
```js | -------- | -------- | ---------------------- | ---- | ------------------------- |
import featureAbility from '@ohos.ability.featureAbility' | callback | 只读 | AsyncCallback\<string> | 是 | 返回当前ability捆绑包名称 |
var context = featureAbility.getContext();
context.getCallingBundle() - 返回值
```
void
- 示例
#### Context.getCallingBundle()
```js
- 接口说明 import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
获取调用当前能力的能力的捆绑包名称(Promise形式) context.getCallingBundle()
```
- 参数描述
Null
## Context.getCallingBundle
- 返回值
- 接口说明
void
获取调用当前ability捆绑包名称(Promise形式)
- 示例
- 参数描述
```js
import featureAbility from '@ohos.ability.featureAbility' 无
var context = featureAbility.getContext();
context.getCallingBundle().then((void) => { - 返回值
console.info("==========================>getCallingBundleCallback=======================>");
}); | 类型 | 说明 |
``` | --------------- | ------------------------- |
| Promise<string> | 调用当前ability捆绑包名称 |
- 示例
```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getCallingBundle().then((void) => {
console.info("==========================>getCallingBundleCallback=======================>");
});
```
zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md
浏览文件 @ ba3112c1
### DataUriUtils模块(JS端SDK接口) # DataUriUtils模块
#### 权限列表 ## 导入模块
ohos.permission.RUNNING_LOCK permission ```js
import dataUriUtils from '@ohos.ability.dataUriUtils';
#### 导入模块 ```
```js ## DataUriUtils.getId
import notify from '@ohos.ability.dataUriUtils';
``` - 接口说明
#### DataUriUtils.getId(uri: string) 获取附加到给定uri的路径组件末尾的ID
- 接口说明 - 参数描述
获取附加到给定uri的路径组件末尾的ID
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
- 参数描述 | ---- | -------- | ------ | ---- | ------------------------- |
| uri | 只读 | string | 是 | 指示要从中获取ID的uri对象 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | - 返回值
| ---- | -------- | ------ | ---- | ------------------------- |
| uri | 只读 | string | 是 | 指示要从中获取ID的uri对象 | 附加到路径组件末尾的ID
- 返回值 - 示例
附加到路径组件末尾的ID ```js
import dataUriUtils from '@ohos.ability.datauriutils'
- 示例 dataUriUtils.getIdSync("com.example.dataUriUtils/1221")
```
```js
import dataUriUtils from '@ohos.ability.datauriutils'
dataUriUtils.getIdSync("com.example.dataUriUtils/1221")
``` ## DataUriUtils.attachId
- 接口说明
#### DataUriUtils.attachId(uri: string, id: number) 将给定ID附加到给定uri的路径组件的末尾
- 接口说明 - 参数描述
将给定ID附加到给定uri的路径组件的末尾
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
- 参数描述 | ---- | -------- | ------ | ---- | ------------------------- |
| uri | 只读 | string | 是 | 指示要从中获取ID的uri对象 |
| id | 只读 | number | 是 | 指示要附加的ID |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------------------------- | - 返回值
| uri | 只读 | string | 是 | 指示要从中获取ID的uri对象 |
| id | 只读 | number | 是 | 指示要附加的ID | 附加给定ID的uri对象
- 返回值 - 示例
附加给定ID的uri对象 ```js
import dataUriUtils from '@ohos.ability.datauriutils'
- 示例 var idint = 1122;
dataUriUtils.attachId(
```js "com.example.dataUriUtils"
import dataUriUtils from '@ohos.ability.datauriutils' idint,
var idint = 1122; )
dataUriUtils.attachId( ```
"com.example.dataUriUtils"
idint,
)
``` ## DataUriUtils.deleteId
- 接口说明
#### DataUriUtils.deleteId(uri: string) 从给定uri的路径组件的末尾删除ID
- 接口说明 - 参数描述
从给定uri的路径组件的末尾删除ID | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------------------------- |
- 参数描述 | uri | 只读 | string | 是 | 指示要从中删除ID的uri对象 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | - 返回值
| ---- | -------- | ------ | ---- | ------------------------- |
| uri | 只读 | string | 是 | 指示要从中删除ID的uri对象 | ID已删除的uri对象
- 返回值 - 示例
ID已删除的uri对象 ```js
import dataUriUtils from '@ohos.ability.datauriutils'
- 示例 dataUriUtils.deleteId("com.example.dataUriUtils/1221")
```
```js
import dataUriUtils from '@ohos.ability.datauriutils'
dataUriUtils.deleteId("com.example.dataUriUtils/1221")
``` ## DataUriUtils.updateId
- 接口说明
#### DataUriUtils.updateId(uri: string, id: number) 更新指定uri中的ID
- 接口说明 - updateId参数描述
更新指定uri中的ID | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------------------- |
- updateId参数描述 | uri | 只读 | string | 是 | 指示要更新的uri对象 |
| id | 只读 | number | 是 | 指示新ID |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------------------- | - 返回值
| uri | 只读 | string | 是 | 指示要更新的uri对象 |
| id | 只读 | number | 是 | 指示新ID | 更新的uri对象
- 返回值 - 示例
更新的uri对象 ```js
import dataUriUtils from '@ohos.ability.datauriutils'
- 示例 var idint = 1122;
dataUriUtils.updateId(
```js "com.example.dataUriUtils"
import dataUriUtils from '@ohos.ability.datauriutils' idint,
var idint = 1122; )
dataUriUtils.updateId( ```
"com.example.dataUriUtils"
idint,
)
```
zh-cn/application-dev/reference/apis/js-apis-commonEvent.md
浏览文件 @ ba3112c1
# CommonEvent模块(JS端SDK接口) # 公共事件模块
#### 支持设备 **说明：**
本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ## 支持设备
| CommonEvent.publish(event: string, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 |
| CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | | API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 |
| CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback<CommonEventSubscriber>) | 支持 | 支持 | 支持 | 支持 | 不支持 | | ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- |
| CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo) | 支持 | 支持 | 支持 | 支持 | 不支持 | | CommonEvent.publish(event: string, callback: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 |
| CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback<CommonEventData>) | 支持 | 支持 | 支持 | 支持 | 不支持 | | CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 |
| CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | | CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\<CommonEventSubscriber>) | 支持 | 支持 | 支持 | 支持 | 不支持 |
| CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo) | 支持 | 支持 | 支持 | 支持 | 不支持 |
#### 权限列表 | CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEventData>) | 支持 | 支持 | 支持 | 支持 | 不支持 |
| CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 |
| 系统公共事件宏 | 系统公共事件名称 | 订阅者所需权限 |
| ------------------------------------------------------------ | ----------------------------------------------------------- | ------------------------------------------------------------ | ## 权限列表
| COMMON_EVENT_BOOT_COMPLETED | usual.event.BOOT_COMPLETED | ohos.permission.RECEIVER_STARTUP_COMPLETED |
| COMMON_EVENT_LOCKED_BOOT_COMPLETED | usual.event.LOCKED_BOOT_COMPLETED | ohos.permission.RECEIVER_STARTUP_COMPLETED | | 系统公共事件宏 | 系统公共事件名称 | 订阅者所需权限 |
| COMMON_EVENT_SHUTDOWN | usual.event.SHUTDOWN | 无 | | ------------------------------------------------------------ | ----------------------------------------------------------- | ------------------------------------------------------------ |
| COMMON_EVENT_BATTERY_CHANGED | usual.event.BATTERY_CHANGED | 无 | | COMMON_EVENT_BOOT_COMPLETED | usual.event.BOOT_COMPLETED | ohos.permission.RECEIVER_STARTUP_COMPLETED |
| COMMON_EVENT_BATTERY_LOW | usual.event.BATTERY_LOW | 无 | | COMMON_EVENT_LOCKED_BOOT_COMPLETED | usual.event.LOCKED_BOOT_COMPLETED | ohos.permission.RECEIVER_STARTUP_COMPLETED |
| COMMON_EVENT_BATTERY_OKAY | usual.event.BATTERY_OKAY | 无 | | COMMON_EVENT_SHUTDOWN | usual.event.SHUTDOWN | 无 |
| COMMON_EVENT_POWER_CONNECTED | usual.event.POWER_CONNECTED | 无 | | COMMON_EVENT_BATTERY_CHANGED | usual.event.BATTERY_CHANGED | 无 |
| COMMON_EVENT_POWER_DISCONNECTED | usual.event.POWER_DISCONNECTED | 无 | | COMMON_EVENT_BATTERY_LOW | usual.event.BATTERY_LOW | 无 |
| COMMON_EVENT_SCREEN_OFF | usual.event.SCREEN_OFF | 无 | | COMMON_EVENT_BATTERY_OKAY | usual.event.BATTERY_OKAY | 无 |
| COMMON_EVENT_SCREEN_ON | usual.event.SCREEN_ON | 无 | | COMMON_EVENT_POWER_CONNECTED | usual.event.POWER_CONNECTED | 无 |
| COMMON_EVENT_USER_PRESENT | usual.event.USER_PRESENT | 无 | | COMMON_EVENT_POWER_DISCONNECTED | usual.event.POWER_DISCONNECTED | 无 |
| COMMON_EVENT_TIME_TICK | usual.event.TIME_TICK | 无 | | COMMON_EVENT_SCREEN_OFF | usual.event.SCREEN_OFF | 无 |
| COMMON_EVENT_TIME_CHANGED | usual.event.TIME_CHANGED | 无 | | COMMON_EVENT_SCREEN_ON | usual.event.SCREEN_ON | 无 |
| COMMON_EVENT_DATE_CHANGED | usual.event.DATE_CHANGED | 无 | | COMMON_EVENT_USER_PRESENT | usual.event.USER_PRESENT | 无 |
| COMMON_EVENT_TIMEZONE_CHANGED | usual.event.TIMEZONE_CHANGED | 无 | | COMMON_EVENT_TIME_TICK | usual.event.TIME_TICK | 无 |
| COMMON_EVENT_CLOSE_SYSTEM_DIALOGS | usual.event.CLOSE_SYSTEM_DIALOGS | 无 | | COMMON_EVENT_TIME_CHANGED | usual.event.TIME_CHANGED | 无 |
| COMMON_EVENT_PACKAGE_ADDED | usual.event.PACKAGE_ADDED | 无 | | COMMON_EVENT_DATE_CHANGED | usual.event.DATE_CHANGED | 无 |
| COMMON_EVENT_PACKAGE_REPLACED | usual.event.PACKAGE_REPLACED | 无 | | COMMON_EVENT_TIMEZONE_CHANGED | usual.event.TIMEZONE_CHANGED | 无 |
| COMMON_EVENT_MY_PACKAGE_REPLACED | usual.event.MY_PACKAGE_REPLACED | 无 | | COMMON_EVENT_CLOSE_SYSTEM_DIALOGS | usual.event.CLOSE_SYSTEM_DIALOGS | 无 |
| COMMON_EVENT_PACKAGE_REMOVED | usual.event.PACKAGE_REMOVED | 无 | | COMMON_EVENT_PACKAGE_ADDED | usual.event.PACKAGE_ADDED | 无 |
| COMMON_EVENT_PACKAGE_FULLY_REMOVED | usual.event.PACKAGE_FULLY_REMOVED | 无 | | COMMON_EVENT_PACKAGE_REPLACED | usual.event.PACKAGE_REPLACED | 无 |
| COMMON_EVENT_PACKAGE_CHANGED | usual.event.PACKAGE_CHANGED | 无 | | COMMON_EVENT_MY_PACKAGE_REPLACED | usual.event.MY_PACKAGE_REPLACED | 无 |
| COMMON_EVENT_PACKAGE_RESTARTED | usual.event.PACKAGE_RESTARTED | 无 | | COMMON_EVENT_PACKAGE_REMOVED | usual.event.PACKAGE_REMOVED | 无 |
| COMMON_EVENT_PACKAGE_DATA_CLEARED | usual.event.PACKAGE_DATA_CLEARED | 无 | | COMMON_EVENT_PACKAGE_FULLY_REMOVED | usual.event.PACKAGE_FULLY_REMOVED | 无 |
| COMMON_EVENT_PACKAGES_SUSPENDED | usual.event.PACKAGES_SUSPENDED | 无 | | COMMON_EVENT_PACKAGE_CHANGED | usual.event.PACKAGE_CHANGED | 无 |
| COMMON_EVENT_PACKAGES_UNSUSPENDED | usual.event.PACKAGES_UNSUSPENDED | 无 | | COMMON_EVENT_PACKAGE_RESTARTED | usual.event.PACKAGE_RESTARTED | 无 |
| COMMON_EVENT_MY_PACKAGE_SUSPENDED | usual.event.MY_PACKAGE_SUSPENDED | 无 | | COMMON_EVENT_PACKAGE_DATA_CLEARED | usual.event.PACKAGE_DATA_CLEARED | 无 |
| COMMON_EVENT_MY_PACKAGE_UNSUSPENDED | usual.event.MY_PACKAGE_UNSUSPENDED | 无 | | COMMON_EVENT_PACKAGES_SUSPENDED | usual.event.PACKAGES_SUSPENDED | 无 |
| COMMON_EVENT_UID_REMOVED | usual.event.UID_REMOVED | 无 | | COMMON_EVENT_PACKAGES_UNSUSPENDED | usual.event.PACKAGES_UNSUSPENDED | 无 |
| COMMON_EVENT_PACKAGE_FIRST_LAUNCH | usual.event.PACKAGE_FIRST_LAUNCH | 无 | | COMMON_EVENT_MY_PACKAGE_SUSPENDED | usual.event.MY_PACKAGE_SUSPENDED | 无 |
| COMMON_EVENT_PACKAGE_NEEDS_VERIFICATION | usual.event.PACKAGE_NEEDS_VERIFICATION | 无 | | COMMON_EVENT_MY_PACKAGE_UNSUSPENDED | usual.event.MY_PACKAGE_UNSUSPENDED | 无 |
| COMMON_EVENT_PACKAGE_VERIFIED | usual.event.PACKAGE_VERIFIED | 无 | | COMMON_EVENT_UID_REMOVED | usual.event.UID_REMOVED | 无 |
| COMMON_EVENT_EXTERNAL_APPLICATIONS_AVAILABLE | usual.event.EXTERNAL_APPLICATIONS_AVAILABLE | 无 | | COMMON_EVENT_PACKAGE_FIRST_LAUNCH | usual.event.PACKAGE_FIRST_LAUNCH | 无 |
| COMMON_EVENT_EXTERNAL_APPLICATIONS_UNAVAILABLE | usual.event.EXTERNAL_APPLICATIONS_UNAVAILABLE | 无 | | COMMON_EVENT_PACKAGE_NEEDS_VERIFICATION | usual.event.PACKAGE_NEEDS_VERIFICATION | 无 |
| COMMON_EVENT_CONFIGURATION_CHANGED | usual.event.CONFIGURATION_CHANGED | 无 | | COMMON_EVENT_PACKAGE_VERIFIED | usual.event.PACKAGE_VERIFIED | 无 |
| COMMON_EVENT_LOCALE_CHANGED | usual.event.LOCALE_CHANGED | 无 | | COMMON_EVENT_EXTERNAL_APPLICATIONS_AVAILABLE | usual.event.EXTERNAL_APPLICATIONS_AVAILABLE | 无 |
| COMMON_EVENT_MANAGE_PACKAGE_STORAGE | usual.event.MANAGE_PACKAGE_STORAGE | 无 | | COMMON_EVENT_EXTERNAL_APPLICATIONS_UNAVAILABLE | usual.event.EXTERNAL_APPLICATIONS_UNAVAILABLE | 无 |
| COMMON_EVENT_DRIVE_MODE | common.event.DRIVE_MODE | 无 | | COMMON_EVENT_CONFIGURATION_CHANGED | usual.event.CONFIGURATION_CHANGED | 无 |
| COMMON_EVENT_HOME_MODE | common.event.HOME_MODE | 无 | | COMMON_EVENT_LOCALE_CHANGED | usual.event.LOCALE_CHANGED | 无 |
| COMMON_EVENT_OFFICE_MODE | common.event.OFFICE_MODE | 无 | | COMMON_EVENT_MANAGE_PACKAGE_STORAGE | usual.event.MANAGE_PACKAGE_STORAGE | 无 |
| COMMON_EVENT_USER_STARTED | usual.event.USER_STARTED | 无 | | COMMON_EVENT_DRIVE_MODE | common.event.DRIVE_MODE | 无 |
| COMMON_EVENT_USER_BACKGROUND | usual.event.USER_BACKGROUND | 无 | | COMMON_EVENT_HOME_MODE | common.event.HOME_MODE | 无 |
| COMMON_EVENT_USER_FOREGROUND | usual.event.USER_FOREGROUND | 无 | | COMMON_EVENT_OFFICE_MODE | common.event.OFFICE_MODE | 无 |
| COMMON_EVENT_USER_SWITCHED | usual.event.USER_SWITCHED | ohos.permission.MANAGE_USERS | | COMMON_EVENT_USER_STARTED | usual.event.USER_STARTED | 无 |
| COMMON_EVENT_USER_STARTING | usual.event.USER_STARTING | ohos.permission.INTERACT_ACROSS_USERS | | COMMON_EVENT_USER_BACKGROUND | usual.event.USER_BACKGROUND | 无 |
| COMMON_EVENT_USER_UNLOCKED | usual.event.USER_UNLOCKED | 无 | | COMMON_EVENT_USER_FOREGROUND | usual.event.USER_FOREGROUND | 无 |
| COMMON_EVENT_USER_STOPPING | usual.event.USER_STOPPING | ohos.permission.INTERACT_ACROSS_USERS | | COMMON_EVENT_USER_SWITCHED | usual.event.USER_SWITCHED | ohos.permission.MANAGE_USERS |
| COMMON_EVENT_USER_STOPPED | usual.event.USER_STOPPED | 无 | | COMMON_EVENT_USER_STARTING | usual.event.USER_STARTING | ohos.permission.INTERACT_ACROSS_USERS |
| COMMON_EVENT_HWID_LOGIN | common.event.HWID_LOGIN | 无 | | COMMON_EVENT_USER_UNLOCKED | usual.event.USER_UNLOCKED | 无 |
| COMMON_EVENT_HWID_LOGOUT | common.event.HWID_LOGOUT | 无 | | COMMON_EVENT_USER_STOPPING | usual.event.USER_STOPPING | ohos.permission.INTERACT_ACROSS_USERS |
| COMMON_EVENT_HWID_TOKEN_INVALID | common.event.HWID_TOKEN_INVALID | 无 | | COMMON_EVENT_USER_STOPPED | usual.event.USER_STOPPED | 无 |
| COMMON_EVENT_HWID_LOGOFF | common.event.HWID_LOGOFF | 无 | | COMMON_EVENT_HWID_LOGIN | common.event.HWID_LOGIN | 无 |
| COMMON_EVENT_WIFI_POWER_STATE | usual.event.wifi.POWER_STATE | 无 | | COMMON_EVENT_HWID_LOGOUT | common.event.HWID_LOGOUT | 无 |
| COMMON_EVENT_WIFI_SCAN_FINISHED | usual.event.wifi.SCAN_FINISHED | ohos.permission.LOCATION | | COMMON_EVENT_HWID_TOKEN_INVALID | common.event.HWID_TOKEN_INVALID | 无 |
| COMMON_EVENT_WIFI_RSSI_VALUE | usual.event.wifi.RSSI_VALUE | ohos.permission.GET_WIFI_INFO | | COMMON_EVENT_HWID_LOGOFF | common.event.HWID_LOGOFF | 无 |
| COMMON_EVENT_WIFI_CONN_STATE | usual.event.wifi.CONN_STATE | 无 | | COMMON_EVENT_WIFI_POWER_STATE | usual.event.wifi.POWER_STATE | 无 |
| COMMON_EVENT_WIFI_HOTSPOT_STATE | usual.event.wifi.HOTSPOT_STATE | 无 | | COMMON_EVENT_WIFI_SCAN_FINISHED | usual.event.wifi.SCAN_FINISHED | ohos.permission.LOCATION |
| COMMON_EVENT_WIFI_AP_STA_JOIN | usual.event.wifi.WIFI_HS_STA_JOIN | ohos.permission.GET_WIFI_INFO | | COMMON_EVENT_WIFI_RSSI_VALUE | usual.event.wifi.RSSI_VALUE | ohos.permission.GET_WIFI_INFO |
| COMMON_EVENT_WIFI_AP_STA_LEAVE | usual.event.wifi.WIFI_HS_STA_LEAVE | ohos.permission.GET_WIFI_INFO | | COMMON_EVENT_WIFI_CONN_STATE | usual.event.wifi.CONN_STATE | 无 |
| COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE | usual.event.wifi.mplink.STATE_CHANGE | ohos.permission.MPLINK_CHANGE_STATE | | COMMON_EVENT_WIFI_HOTSPOT_STATE | usual.event.wifi.HOTSPOT_STATE | 无 |
| COMMON_EVENT_WIFI_P2P_CONN_STATE | usual.event.wifi.p2p.CONN_STATE_CHANGE | ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION | | COMMON_EVENT_WIFI_AP_STA_JOIN | usual.event.wifi.WIFI_HS_STA_JOIN | ohos.permission.GET_WIFI_INFO |
| COMMON_EVENT_WIFI_P2P_STATE_CHANGED | usual.event.wifi.p2p.STATE_CHANGE | ohos.permission.GET_WIFI_INFO | | COMMON_EVENT_WIFI_AP_STA_LEAVE | usual.event.wifi.WIFI_HS_STA_LEAVE | ohos.permission.GET_WIFI_INFO |
| COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED | usual.event.wifi.p2p.DEVICES_CHANGE | ohos.permission.GET_WIFI_INFO | | COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE | usual.event.wifi.mplink.STATE_CHANGE | ohos.permission.MPLINK_CHANGE_STATE |
| COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED | usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE | ohos.permission.GET_WIFI_INFO | | COMMON_EVENT_WIFI_P2P_CONN_STATE | usual.event.wifi.p2p.CONN_STATE_CHANGE | ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION |
| COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED | usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE | ohos.permission.GET_WIFI_INFO | | COMMON_EVENT_WIFI_P2P_STATE_CHANGED | usual.event.wifi.p2p.STATE_CHANGE | ohos.permission.GET_WIFI_INFO |
| COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED | usual.event.wifi.p2p.GROUP_STATE_CHANGED | ohos.permission.GET_WIFI_INFO | | COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED | usual.event.wifi.p2p.DEVICES_CHANGE | ohos.permission.GET_WIFI_INFO |
| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CONNECT_STATE_UPDATE | usual.event.bluetooth.handsfree.ag.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED | usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE | ohos.permission.GET_WIFI_INFO |
| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CURRENT_DEVICE_UPDATE | usual.event.bluetooth.handsfree.ag.CURRENT_DEVICE_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED | usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE | ohos.permission.GET_WIFI_INFO |
| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_AUDIO_STATE_UPDATE | usual.event.bluetooth.handsfree.ag.AUDIO_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED | usual.event.wifi.p2p.GROUP_STATE_CHANGED | ohos.permission.GET_WIFI_INFO |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CONNECT_STATE_UPDATE | usual.event.bluetooth.handsfree.ag.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CURRENT_DEVICE_UPDATE | usual.event.bluetooth.a2dpsource.CURRENT_DEVICE_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CURRENT_DEVICE_UPDATE | usual.event.bluetooth.handsfree.ag.CURRENT_DEVICE_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_PLAYING_STATE_UPDATE | usual.event.bluetooth.a2dpsource.PLAYING_STATE_UPDATE" | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_AUDIO_STATE_UPDATE | usual.event.bluetooth.handsfree.ag.AUDIO_STATE_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_AVRCP_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.AVRCP_CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CODEC_VALUE_UPDATE | usual.event.bluetooth.a2dpsource.CODEC_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CURRENT_DEVICE_UPDATE | usual.event.bluetooth.a2dpsource.CURRENT_DEVICE_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_DISCOVERED | usual.event.bluetooth.remotedevice.DISCOVERED | ohos.permission.USE_BLUETOOTH and ohos.permission.LOCATION | | COMMON_EVENT_BLUETOOTH_A2DPSOURCE_PLAYING_STATE_UPDATE | usual.event.bluetooth.a2dpsource.PLAYING_STATE_UPDATE" | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CLASS_VALUE_UPDATE | usual.event.bluetooth.remotedevice.CLASS_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_A2DPSOURCE_AVRCP_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.AVRCP_CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_CONNECTED | usual.event.bluetooth.remotedevice.ACL_CONNECTED | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CODEC_VALUE_UPDATE | usual.event.bluetooth.a2dpsource.CODEC_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_DISCONNECTED | usual.event.bluetooth.remotedevice.ACL_DISCONNECTED | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_DISCOVERED | usual.event.bluetooth.remotedevice.DISCOVERED | ohos.permission.USE_BLUETOOTH and ohos.permission.LOCATION |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_NAME_UPDATE | usual.event.bluetooth.remotedevice.NAME_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CLASS_VALUE_UPDATE | usual.event.bluetooth.remotedevice.CLASS_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIR_STATE | usual.event.bluetooth.remotedevice.PAIR_STATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_CONNECTED | usual.event.bluetooth.remotedevice.ACL_CONNECTED | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_BATTERY_VALUE_UPDATE | usual.event.bluetooth.remotedevice.BATTERY_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_DISCONNECTED | usual.event.bluetooth.remotedevice.ACL_DISCONNECTED | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_SDP_RESULT | usual.event.bluetooth.remotedevice.SDP_RESULT | 无 | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_NAME_UPDATE | usual.event.bluetooth.remotedevice.NAME_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_UUID_VALUE | usual.event.bluetooth.remotedevice.UUID_VALUE | ohos.permission.DISCOVER_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIR_STATE | usual.event.bluetooth.remotedevice.PAIR_STATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_REQ | usual.event.bluetooth.remotedevice.PAIRING_REQ | ohos.permission.DISCOVER_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_BATTERY_VALUE_UPDATE | usual.event.bluetooth.remotedevice.BATTERY_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_CANCEL | usual.event.bluetooth.remotedevice.PAIRING_CANCEL | 无 | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_SDP_RESULT | usual.event.bluetooth.remotedevice.SDP_RESULT | 无 |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REQ | usual.event.bluetooth.remotedevice.CONNECT_REQ | 无 | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_UUID_VALUE | usual.event.bluetooth.remotedevice.UUID_VALUE | ohos.permission.DISCOVER_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REPLY | usual.event.bluetooth.remotedevice.CONNECT_REPLY | 无 | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_REQ | usual.event.bluetooth.remotedevice.PAIRING_REQ | ohos.permission.DISCOVER_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_CANCEL | usual.event.bluetooth.remotedevice.CONNECT_CANCEL | 无 | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_CANCEL | usual.event.bluetooth.remotedevice.PAIRING_CANCEL | 无 |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_CONNECT_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.CONNECT_STATE_UPDATE | 无 | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REQ | usual.event.bluetooth.remotedevice.CONNECT_REQ | 无 |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AUDIO_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.AUDIO_STATE_UPDATE | 无 | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REPLY | usual.event.bluetooth.remotedevice.CONNECT_REPLY | 无 |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_COMMON_EVENT | usual.event.bluetooth.handsfreeunit.AG_COMMON_EVENT | 无 | | COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_CANCEL | usual.event.bluetooth.remotedevice.CONNECT_CANCEL | 无 |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_CALL_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.AG_CALL_STATE_UPDATE | 无 | | COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_CONNECT_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.CONNECT_STATE_UPDATE | 无 |
| COMMON_EVENT_BLUETOOTH_HOST_STATE_UPDATE | usual.event.bluetooth.host.STATE_UPDATE | 无 | | COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AUDIO_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.AUDIO_STATE_UPDATE | 无 |
| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISCOVERABLE | usual.event.bluetooth.host.REQ_DISCOVERABLE | 无 | | COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_COMMON_EVENT | usual.event.bluetooth.handsfreeunit.AG_COMMON_EVENT | 无 |
| COMMON_EVENT_BLUETOOTH_HOST_REQ_ENABLE | usual.event.bluetooth.host.REQ_ENABLE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_CALL_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.AG_CALL_STATE_UPDATE | 无 |
| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISABLE | usual.event.bluetooth.host.REQ_DISABLE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_HOST_STATE_UPDATE | usual.event.bluetooth.host.STATE_UPDATE | 无 |
| COMMON_EVENT_BLUETOOTH_HOST_SCAN_MODE_UPDATE | usual.event.bluetooth.host.SCAN_MODE_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_HOST_REQ_DISCOVERABLE | usual.event.bluetooth.host.REQ_DISCOVERABLE | 无 |
| COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_STARTED | usual.event.bluetooth.host.DISCOVERY_STARTED | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_HOST_REQ_ENABLE | usual.event.bluetooth.host.REQ_ENABLE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_FINISHED | usual.event.bluetooth.host.DISCOVERY_FINISHED | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_HOST_REQ_DISABLE | usual.event.bluetooth.host.REQ_DISABLE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_HOST_NAME_UPDATE | usual.event.bluetooth.host.NAME_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_HOST_SCAN_MODE_UPDATE | usual.event.bluetooth.host.SCAN_MODE_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_A2DPSINK_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsink.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_STARTED | usual.event.bluetooth.host.DISCOVERY_STARTED | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_A2DPSINK_PLAYING_STATE_UPDATE | usual.event.bluetooth.a2dpsink.PLAYING_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_FINISHED | usual.event.bluetooth.host.DISCOVERY_FINISHED | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_A2DPSINK_AUDIO_STATE_UPDATE | usual.event.bluetooth.a2dpsink.AUDIO_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | | COMMON_EVENT_BLUETOOTH_HOST_NAME_UPDATE | usual.event.bluetooth.host.NAME_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED | usual.event.nfc.action.ADAPTER_STATE_CHANGED | 无 | | COMMON_EVENT_BLUETOOTH_A2DPSINK_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsink.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED | usual.event.nfc.action.RF_FIELD_ON_DETECTED | ohos.permission.MANAGE_SECURE_SETTINGS | | COMMON_EVENT_BLUETOOTH_A2DPSINK_PLAYING_STATE_UPDATE | usual.event.bluetooth.a2dpsink.PLAYING_STATE_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED | usual.event.nfc.action.RF_FIELD_OFF_DETECTED | ohos.permission.MANAGE_SECURE_SETTINGS | | COMMON_EVENT_BLUETOOTH_A2DPSINK_AUDIO_STATE_UPDATE | usual.event.bluetooth.a2dpsink.AUDIO_STATE_UPDATE | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_DISCHARGING | usual.event.DISCHARGING | 无 | | COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED | usual.event.nfc.action.ADAPTER_STATE_CHANGED | 无 |
| COMMON_EVENT_CHARGING | usual.event.CHARGING | 无 | | COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED | usual.event.nfc.action.RF_FIELD_ON_DETECTED | ohos.permission.MANAGE_SECURE_SETTINGS |
| COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED | usual.event.DEVICE_IDLE_MODE_CHANGED | 无 | | COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED | usual.event.nfc.action.RF_FIELD_OFF_DETECTED | ohos.permission.MANAGE_SECURE_SETTINGS |
| COMMON_EVENT_POWER_SAVE_MODE_CHANGED | usual.event.POWER_SAVE_MODE_CHANGED | 无 | | COMMON_EVENT_DISCHARGING | usual.event.DISCHARGING | 无 |
| COMMON_EVENT_USER_ADDED | usual.event.USER_ADDED | ohos.permission.MANAGE_USERS | | COMMON_EVENT_CHARGING | usual.event.CHARGING | 无 |
| COMMON_EVENT_USER_REMOVED | usual.event.USER_REMOVED | ohos.permission.MANAGE_USERS | | COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED | usual.event.DEVICE_IDLE_MODE_CHANGED | 无 |
| COMMON_EVENT_ABILITY_ADDED | common.event.ABILITY_ADDED | ohos.permission.LISTEN_BUNDLE_CHANGE | | COMMON_EVENT_POWER_SAVE_MODE_CHANGED | usual.event.POWER_SAVE_MODE_CHANGED | 无 |
| COMMON_EVENT_ABILITY_REMOVED | common.event.ABILITY_REMOVED | ohos.permission.LISTEN_BUNDLE_CHANGE | | COMMON_EVENT_USER_ADDED | usual.event.USER_ADDED | ohos.permission.MANAGE_USERS |
| COMMON_EVENT_ABILITY_UPDATED | common.event.ABILITY_UPDATED | ohos.permission.LISTEN_BUNDLE_CHANGE | | COMMON_EVENT_USER_REMOVED | usual.event.USER_REMOVED | ohos.permission.MANAGE_USERS |
| COMMON_EVENT_LOCATION_MODE_STATE_CHANGED | usual.event.location.MODE_STATE_CHANGED | 无 | | COMMON_EVENT_ABILITY_ADDED | common.event.ABILITY_ADDED | ohos.permission.LISTEN_BUNDLE_CHANGE |
| COMMON_EVENT_IVI_SLEEP | common.event.IVI_SLEEP | 无 | | COMMON_EVENT_ABILITY_REMOVED | common.event.ABILITY_REMOVED | ohos.permission.LISTEN_BUNDLE_CHANGE |
| COMMON_EVENT_IVI_PAUSE | common.event.IVI_PAUSE | 无 | | COMMON_EVENT_ABILITY_UPDATED | common.event.ABILITY_UPDATED | ohos.permission.LISTEN_BUNDLE_CHANGE |
| COMMON_EVENT_IVI_STANDBY | common.event.IVI_STANDBY | 无 | | COMMON_EVENT_LOCATION_MODE_STATE_CHANGED | usual.event.location.MODE_STATE_CHANGED | 无 |
| COMMON_EVENT_IVI_LASTMODE_SAVE | common.event.IVI_LASTMODE_SAVE | 无 | | COMMON_EVENT_IVI_SLEEP | common.event.IVI_SLEEP | 无 |
| COMMON_EVENT_IVI_VOLTAGE_ABNORMAL | common.event.IVI_VOLTAGE_ABNORMAL | 无 | | COMMON_EVENT_IVI_PAUSE | common.event.IVI_PAUSE | 无 |
| COMMON_EVENT_IVI_HIGH_TEMPERATURE | common.event.IVI_HIGH_TEMPERATURE | 无 | | COMMON_EVENT_IVI_STANDBY | common.event.IVI_STANDBY | 无 |
| COMMON_EVENT_IVI_EXTREME_TEMPERATURE | common.event.IVI_EXTREME_TEMPERATURE | 无 | | COMMON_EVENT_IVI_LASTMODE_SAVE | common.event.IVI_LASTMODE_SAVE | 无 |
| COMMON_EVENT_IVI_TEMPERATURE_ABNORMAL | common.event.IVI_TEMPERATURE_ABNORMAL | 无 | | COMMON_EVENT_IVI_VOLTAGE_ABNORMAL | common.event.IVI_VOLTAGE_ABNORMAL | 无 |
| COMMON_EVENT_IVI_VOLTAGE_RECOVERY | common.event.IVI_VOLTAGE_RECOVERY | 无 | | COMMON_EVENT_IVI_HIGH_TEMPERATURE | common.event.IVI_HIGH_TEMPERATURE | 无 |
| COMMON_EVENT_IVI_TEMPERATURE_RECOVERY | common.event.IVI_TEMPERATURE_RECOVERY | 无 | | COMMON_EVENT_IVI_EXTREME_TEMPERATURE | common.event.IVI_EXTREME_TEMPERATURE | 无 |
| COMMON_EVENT_IVI_ACTIVE | common.event.IVI_ACTIVE | 无 | | COMMON_EVENT_IVI_TEMPERATURE_ABNORMAL | common.event.IVI_TEMPERATURE_ABNORMAL | 无 |
| COMMON_EVENT_USB_DEVICE_ATTACHED | usual.event.hardware.usb.action.USB_DEVICE_ATTACHED | 无 | | COMMON_EVENT_IVI_VOLTAGE_RECOVERY | common.event.IVI_VOLTAGE_RECOVERY | 无 |
| COMMON_EVENT_USB_DEVICE_DETACHED | usual.event.hardware.usb.action.USB_DEVICE_DETACHED | 无 | | COMMON_EVENT_IVI_TEMPERATURE_RECOVERY | common.event.IVI_TEMPERATURE_RECOVERY | 无 |
| COMMON_EVENT_USB_ACCESSORY_ATTACHED | usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED | 无 | | COMMON_EVENT_IVI_ACTIVE | common.event.IVI_ACTIVE | 无 |
| COMMON_EVENT_USB_ACCESSORY_DETACHED | usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED | 无 | | COMMON_EVENT_USB_DEVICE_ATTACHED | usual.event.hardware.usb.action.USB_DEVICE_ATTACHED | 无 |
| COMMON_EVENT_DISK_REMOVED | usual.event.data.DISK_REMOVED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE | | COMMON_EVENT_USB_DEVICE_DETACHED | usual.event.hardware.usb.action.USB_DEVICE_DETACHED | 无 |
| COMMON_EVENT_DISK_UNMOUNTED | usual.event.data.DISK_UNMOUNTED | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE | | COMMON_EVENT_USB_ACCESSORY_ATTACHED | usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED | 无 |
| COMMON_EVENT_DISK_MOUNTED | usual.event.data.DISK_MOUNTED | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE | | COMMON_EVENT_USB_ACCESSORY_DETACHED | usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED | 无 |
| COMMON_EVENT_DISK_BAD_REMOVAL | usual.event.data.DISK_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE | | COMMON_EVENT_DISK_REMOVED | usual.event.data.DISK_REMOVED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_UNMOUNTABLE | usual.event.data.DISK_UNMOUNTABLE | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE | | COMMON_EVENT_DISK_UNMOUNTED | usual.event.data.DISK_UNMOUNTED | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_EJECT | usual.event.data.DISK_EJECT | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE | | COMMON_EVENT_DISK_MOUNTED | usual.event.data.DISK_MOUNTED | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_VISIBLE_ACCOUNTS_UPDATED | usual.event.data.VISIBLE_ACCOUNTS_UPDATED | ohos.permission.GET_APP_ACCOUNTS | | COMMON_EVENT_DISK_BAD_REMOVAL | usual.event.data.DISK_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_ACCOUNT_DELETED | usual.event.data.ACCOUNT_DELETED | ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS | | COMMON_EVENT_DISK_UNMOUNTABLE | usual.event.data.DISK_UNMOUNTABLE | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_FOUNDATION_READY | common.event.FOUNDATION_READY | ohos.permission.RECEIVER_STARTUP_COMPLETED | | COMMON_EVENT_DISK_EJECT | usual.event.data.DISK_EJECT | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_AIRPLANE_MODE_CHANGED | usual.event.AIRPLANE_MODE | 无 | | COMMON_EVENT_VISIBLE_ACCOUNTS_UPDATED | usual.event.data.VISIBLE_ACCOUNTS_UPDATED | ohos.permission.GET_APP_ACCOUNTS |
| COMMON_EVENT_ACCOUNT_DELETED | usual.event.data.ACCOUNT_DELETED | ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS |
#### 导入模块 | COMMON_EVENT_FOUNDATION_READY | common.event.FOUNDATION_READY | ohos.permission.RECEIVER_STARTUP_COMPLETED |
| COMMON_EVENT_AIRPLANE_MODE_CHANGED | usual.event.AIRPLANE_MODE | 无 |
```js
import CommonEvent from '@ohos.commonevent'; ## 导入模块
```
```js
import CommonEvent from '@ohos.commonevent';
```
#### CommonEvent.publish(event: string, callback: AsyncCallback<void>)
- 接口说明
## CommonEvent.publish(event: string, callback: AsyncCallback\<void>): void
发布公共事件（callback形式）
- 接口说明
* publish参数描述
发布公共事件（callback形式）
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------- | ---- | -------------------- | * publish参数描述
| event | 只读 | string | 是 | 表示要发送的公共事件 |
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | -------------------- | ---- | -------------------- |
* 返回值 | event | 只读 | string | 是 | 表示要发送的公共事件 |
| callback | 只读 | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
void
* 示例
* 示例
```js
```js //发布公共事件回调
//发布公共事件回调 function PublishCallBack(err) {
function PublishCallBack(err) { console.info("==========================>PublishCallBack=======================>");
console.info("==========================>PublishCallBack=======================>"); console.info("==========================>err:=======================>", err.code);
console.info("==========================>err:=======================>", err.code); }
} //发布公共事件
//发布公共事件 CommonEvent.publish("publish_event", PublishCallBack);
CommonEvent.publish("publish_event", PublishCallBack); ```
```
## CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\<void>): void
#### CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback<void>)
- 接口说明
- 接口说明
发布公共事件指定发布信息（callback形式）
发布公共事件指定发布信息（callback形式）
- publish参数描述
- publish参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | -------- | -------- | ---------------------- | ---- | ---------------------- |
| -------- | -------- | ---------------------- | ---- | ---------------------- | | event | 只读 | string | 是 | 表示要发布的公共事件 |
| event | 只读 | string | 是 | 表示要发布的公共事件 | | options | 只读 | [CommonEventPublishData](#publishData) | 是 | 表示发布公共事件的属性 |
| options | 只读 | CommonEventPublishData | 是 | 表示发布公共事件的属性 | | callback | 只读 | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 |
- 示例
- CommonEventPublishData类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ```js
| --------------------- | -------- | -------------------- | ---- | ---------------------------- | //公共事件相关信息
| bundleName | 只读 | string | 否 | 表示包名称 | var options = {
| code | 只读 | int | 否 | 表示公共事件的结果代码 | code: 0; //公共事件的初始代码
| data | 只读 | string | 否 | 表示公共事件的自定义结果数据 | data: "initial data";//公共事件的初始数据
| subscriberPermissions | 只读 | Array<string> | 否 | 表示订阅者的权限 | isOrdered: true; //有序公共事件
| isOrdered | 只读 | bool | 否 | 表示是否是有序事件 | }
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 | //发布公共事件回调
function PublishCallBack(err) {
- 返回值 console.info("==========================>PublishCallBack=======================>");
}
void //发布公共事件
CommonEvent.publish("publish_event", options, PublishCallBack);
- 示例 ```
```js
//公共事件相关信息
var options = { ## CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\<CommonEventSubscriber>): void
code: 0; //公共事件的初始代码
data: "initial data";//公共事件的初始数据 - 接口说明
isOrdered: true; //有序公共事件
} 创建订阅者（callback形式）
//发布公共事件回调
function PublishCallBack(err) { - createSubscriber参数描述
console.info("==========================>PublishCallBack=======================>");
} | 名称 | 读写属性 | 类型 | 必填 | 描述 |
//发布公共事件 | ------------- | -------- | ---------------------------------------------------- | ---- | ------------------------ |
CommonEvent.publish("publish_event", options, PublishCallBack); | subscribeInfo | 只读 | [CommonEventSubscribeInfo](#SubscribeInfo) | 是 | 表示订阅信息 |
``` | callback | 只读 | AsyncCallback\<[CommonEventSubscriber](#Subscriber)> | 是 | 表示创建订阅者的回调方法 |
- 示例
#### CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback<CommonEventSubscriber>)
```js
- 接口说明 var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息
创建订阅者（callback形式） var subscribeInfo = {
events: ["event"]
- createSubscriber参数描述 };
//创建订阅者回调
| 名称 | 读写属性 | 类型 | 必填 | 描述 | function CreateSubscriberCallBack(err, data) {
| ------------- | -------- | ------------------------------------ | ---- | ------------------------ | console.info("==========================>CreateSubscriberCallBack=======================>");
| subscribeInfo | 只读 | CommonEventSubscribeInfo | 是 | 表示订阅信息 | subscriber = data;
| callback | 只读 | AsyncCallback<CommonEventSubscriber> | 是 | 表示创建订阅者的回调方法 | }
//创建订阅者
- CommonEventSubscriber 类说明 CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
```
| 名称 | 参数 | 返回值 | 描述 |
| --------------------- | --------------------------------------------------------- | --------------------------------- | ------------------------------------------------------------ |
| getCode | callback: AsyncCallback<number> | void | 获取公共事件的结果代码（callback形式） |
| getCode | void | Promise<number> | 获取公共事件的结果代码（Promise形式） | ## CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\<CommonEventSubscriber>
| setCode | code: number, callback: AsyncCallback<void> | void | 设置公共事件的结果代码（callback形式） |
| setCode | code: number | Promise<void> | 设置公共事件的结果代码（Promise形式） | - 接口说明
| getData | callback: AsyncCallback<string> | void | 获取公共事件的结果数据（callback形式） |
| getData | void | Promise<string> | 获取公共事件的结果数据（Promise形式） | 创建订阅者（Promise形式）
| setData | data: string, callback: AsyncCallback<void> | void | 设置公共事件的结果数据（callback形式） |
| setData | data: string | Promise<void> | 设置公共事件的结果数据（Promise形式） | - createSubscriber参数描述
| setCodeAndData | code: number, data: string, callback: AsyncCallback<void> | void | 设置公共事件的结果代码和结果数据（callback形式） |
| setCodeAndData | code: number, data: string | Promise<void> | 设置公共事件的结果代码和结果数据（Promise形式） | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| isOrderedCommonEvent | callback: AsyncCallback<boolean> | void | 查询当前公共事件的是否为有序公共事件，返回true代表是有序公共事件，false代表不是有序公共事件（callback形式） | | ------------- | -------- | ------------------------------------------ | ---- | ------------ |
| isOrderedCommonEvent | void | Promise<bool> | 查询当前公共事件的是否为有序公共事件，返回true代表是有序公共事件，false代表不是有序公共事件（Promise形式） | | subscribeInfo | 只读 | [CommonEventSubscribeInfo](#SubscribeInfo) | 是 | 表示订阅信息 |
| abortCommonEvent | callback: AsyncCallback<void> | void | 取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（callback形式） |
| abortCommonEvent | void | Promise<void> | 取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（Promise形式） | - 返回值
| clearAbortCommonEvent | callback: AsyncCallback<void> | void | 清除当前有序公共事件abort状态（callback形式） |
| clearAbortCommonEvent | void | Promise<void> | 清除当前有序公共事件abort状态（Promise形式） | Promise\<[CommonEventSubscriber](#Subscriber)>
| getAbortCommonEvent | callback: AsyncCallback<boolean> | void | 获取当前有序公共事件是否取消的状态（callback形式） |
| getAbortCommonEvent | void | Promise<boolean> | 获取当前有序公共事件是否取消的状态Promise形式） | 订阅者对象
| getSubscribeInfo | callback: AsyncCallback<CommonEventSubscribeInfo> | void | 获取订阅者的订阅信息（callback形式） |
| getSubscribeInfo | void | Promise<CommonEventSubscribeInfo> | 获取订阅者的订阅信息（Promise形式） | - 示例
- CommonEventSubscribeInfo类型说明 ```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
| 名称 | 读写属性 | 类型 | 必填 | 描述 | //订阅者信息
| ------------------- | -------- | ------------- | ---- | ------------------------------------------------------------ | var subscribeInfo = {
| events | 只读 | Array<string> | 是 | 表示要订阅的公共事件 | events: ["event"]
| publisherPermission | 只读 | string | 否 | 表示发布者的权限 | };
| publisherDeviceId | 只读 | int | 否 | 表示设备ID，该值必须是同一ohos网络上的现有设备ID | //创建订阅者
| userId | 只读 | int | 否 | 表示用户ID。此参数是可选的，默认值当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。 | CommonEvent.createSubscriber(subscribeInfo).then((data) => {
| priority | 只读 | int | 否 | 表示订阅者的优先级，范围为-100~1000。 | console.info("==========================>createSubscriberPromise=======================>");
subscriber = data;
- 返回值 });
```
void
- 示例
## CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEventData>): void
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 - 接口说明
//订阅者信息
var subscribeInfo = { 订阅公共事件（callback形式）
events: ["event"]
}; - subscribe参数描述
//创建订阅者回调
function CreateSubscriberCallBack(err, data) { | 名称 | 读写属性 | 类型 | 必填 | 描述 |
console.info("==========================>CreateSubscriberCallBack=======================>"); | ---------- | -------- | --------------------------------------------------- | ---- | ------------------------------ |
subscriber = data; | subscriber | 只读 | [CommonEventSubscriber](#Subscriber) | 是 | 表示订阅者对象 |
} | callback | 只读 | AsyncCallback\<[CommonEventData](#CommonEventData)> | 是 | 表示接收公共事件数据的回调函数 |
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack); - 示例
```
无序事件：
#### CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo) ```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
- 接口说明 //订阅者信息
var subscribeInfo = {
创建订阅者（Promise形式） events: ["event"]
};
- createSubscriber参数描述 //订阅公共事件回调
function SubscribeCallBack(err, data) {
| 名称 | 读写属性 | 类型 | 必填 | 描述 | console.info("==========================>SubscribeCallBack=======================>");
| ------------- | -------- | ------------------------ | ---- | ------------ | }
| subscribeInfo | 只读 | CommonEventSubscribeInfo | 是 | 表示订阅信息 | //创建订阅者回调
function CreateSubscriberCallBack(err, data) {
- CommonEventSubscribeInfo类型说明 console.info("==========================>CreateSubscriberCallBack=======================>");
subscriber = data;
| 名称 | 读写属性 | 类型 | 必填 | 描述 | //订阅公共事件
| ------------------- | -------- | ------------- | ---- | ------------------------------------------------------------ | CommonEvent.subscribe(subscriber, SubscribeCallBack);
| events | 只读 | Array<string> | 是 | 表示要发送的公共事件 | }
| publisherPermission | 只读 | string | 否 | 表示发布者的权限 | //创建订阅者
| publisherDeviceId | 只读 | int | 否 | 表示设备ID，该值必须是同一ohos网络上的现有设备ID | CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
| userId | 只读 | int | 否 | 表示用户ID。此参数是可选的，默认值当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。 | ```
| priority | 只读 | int | 否 | 表示订阅者的优先级。值的范围是-100到1000 |
​ 有序事件：
- 返回值
```js
Promise<CommonEventSubscriber> var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息
- 示例 var subscribeInfo = {
events: ["event"]
```js };
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息 //设置有序公共事件的结果代码回调
var subscribeInfo = { function SetCodeCallBack(err) {
events: ["event"] console.info("==========================>SetCodeCallBack=======================>");
}; }
//创建订阅者 //设置有序公共事件的结果数据回调
CommonEvent.createSubscriber(subscribeInfo).then((data) => { function SetDataCallBack(err) {
console.info("==========================>createSubscriberPromise=======================>"); console.info("==========================>SetDataCallBack=======================>");
subscriber = data; }
}); //完成本次有序公共事件处理回调
``` function FinishCommonEventCallBack(err) {
console.info("==========================>FinishCommonEventCallBack=======================>");
}
//订阅公共事件回调
#### CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback<CommonEventData>) function SubscribeCallBack(err, data) {
console.info("==========================>SubscribeCallBack=======================>");
- 接口说明 //设置有序公共事件的结果代码
subscriber.setCode(0, SetCodeCallBack);
订阅公共事件（callback形式） //设置有序公共事件的结果数据
subscriber.setData("publish_data_changed", SetDataCallBack);
- subscribe参数描述 //完成本次有序公共事件处理
subscriber.finishCommonEvent(FinishCommonEventCallBack)
| 名称 | 读写属性 | 类型 | 必填 | 描述 | }
| ---------- | -------- | ------------------------------ | ---- | ------------------------------ |
| subscriber | 只读 | CommonEventSubscriber | 是 | 表示订阅者对象 | //创建订阅者回调
| callback | 只读 | AsyncCallback<CommonEventData> | 是 | 表示接收公共事件数据的回调函数 | function CreateSubscriberCallBack(err, data) {
console.info("==========================>CreateSubscriberCallBack=======================>");
- CommonEventData类型说明 subscriber = data;
//订阅公共事件
| 名称 | 读写属性 | 类型 | 必填 | 描述 | CommonEvent.subscribe(subscriber, SubscribeCallBack);
| ---------- | -------- | -------------------- | ---- | ------------------------------------------------------- | }
| event | 只读 | string | 是 | 表示当前接收的公共事件名称 |
| bundleName | 只读 | string | 否 | 表示包名称 | //创建订阅者
| code | 只读 | int | 否 | 表示公共事件的结果代码，用于传递int类型的数据 | CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
| data | 只读 | string | 否 | 表示公共事件的自定义结果数据，用于传递string 类型的数据 | ```
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 |
​
- 返回值
## CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>): void
void
- 接口说明
- 示例
取消订阅公共事件（callback形式）
* 无序事件：
- unsubscribe参数描述
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
//订阅者信息 | ---------- | -------- | --------------------- | ---- | ---------------------- |
var subscribeInfo = { | subscriber | 只读 | CommonEventSubscriber | 是 | 表示订阅者对象 |
events: ["event"] | callback | 只读 | AsyncCallback\<void> | 是 | 表示取消订阅的回调方法 |
};
//订阅公共事件回调 - 示例
function SubscribeCallBack(err, data) {
console.info("==========================>SubscribeCallBack=======================>"); ```js
} var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//创建订阅者回调 //订阅者信息
function CreateSubscriberCallBack(err, data) { var subscribeInfo = {
console.info("==========================>CreateSubscriberCallBack=======================>"); events: ["event"]
subscriber = data; };
//订阅公共事件 //订阅公共事件回调
CommonEvent.subscribe(subscriber, SubscribeCallBack); function SubscribeCallBack(err, data) {
} console.info("==========================>SubscribeCallBack=======================>");
//创建订阅者 }
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack); //创建订阅者回调
``` function CreateSubscriberCallBack(err, data) {
console.info("==========================>CreateSubscriberCallBack=======================>");
* 有序事件 subscriber = data;
//订阅公共事件
```js CommonEvent.subscribe(subscriber, SubscribeCallBack);
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 }
//订阅者信息 //取消订阅公共事件回调
var subscribeInfo = { function UnsubscribeCallBack(err) {
events: ["event"] console.info("==========================>UnsubscribeCallBack=======================>");
}; }
//创建订阅者
//设置有序公共事件的结果代码回调 CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
function SetCodeCallBack(err) { //取消订阅公共事件
console.info("==========================>SetCodeCallBack=======================>"); CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);
} ```
//设置有序公共事件的结果数据回调
function SetDataCallBack(err) { ## <span id = "publishData">CommonEventPublishData</span>
console.info("==========================>SetDataCallBack=======================>");
} | 名称 | 读写属性 | 类型 | 必填 | 描述 |
//完成本次有序公共事件处理回调 | --------------------- | -------- | -------------------- | ---- | ---------------------------- |
function FinishCommonEventCallBack(err) { | bundleName | 只读 | string | 否 | 表示包名称 |
console.info("==========================>FinishCommonEventCallBack=======================>"); | code | 只读 | number | 否 | 表示公共事件的结果代码 |
} | data | 只读 | string | 否 | 表示公共事件的自定义结果数据 |
//订阅公共事件回调 | subscriberPermissions | 只读 | Array\<string> | 否 | 表示订阅者的权限 |
function SubscribeCallBack(err, data) { | isOrdered | 只读 | boolean | 否 | 表示是否是有序事件 |
console.info("==========================>SubscribeCallBack=======================>"); | parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 |
//设置有序公共事件的结果代码
subscriber.setCode(0, SetCodeCallBack); ## <span id = "SubscribeInfo">CommonEventSubscribeInfo</span>
//设置有序公共事件的结果数据
subscriber.setData("publish_data_changed", SetDataCallBack); | 名称 | 读写属性 | 类型 | 必填 | 描述 |
//完成本次有序公共事件处理 | ------------------- | -------- | -------------- | ---- | ------------------------------------------------------------ |
subscriber.finishCommonEvent(FinishCommonEventCallBack) | events | 只读 | Array\<string> | 是 | 表示要发送的公共事件 |
} | publisherPermission | 只读 | string | 否 | 表示发布者的权限 |
| publisherDeviceId | 只读 | string | 否 | 表示设备ID，该值必须是同一ohos网络上的现有设备ID |
//创建订阅者回调 | userId | 只读 | number | 否 | 表示用户ID。此参数是可选的，默认值当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。 |
function CreateSubscriberCallBack(err, data) { | priority | 只读 | number | 否 | 表示订阅者的优先级。值的范围是-100到1000 |
console.info("==========================>CreateSubscriberCallBack=======================>");
subscriber = data; ## <span id = "CommonEventData">CommonEventData</span>
//订阅公共事件
CommonEvent.subscribe(subscriber, SubscribeCallBack); | 名称 | 读写属性 | 类型 | 必填 | 描述 |
} | ---------- | -------- | -------------------- | ---- | ------------------------------------------------------ |
| event | 只读 | string | 是 | 表示当前接收的公共事件名称 |
//创建订阅者 | bundleName | 只读 | string | 否 | 表示包名称 |
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack); | code | 只读 | number | 否 | 表示公共事件的结果代码，用于传递int类型的数据 |
``` | data | 只读 | string | 否 | 表示公共事件的自定义结果数据，用于传递string类型的数据 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 |
## <span id = "Subscriber">CommonEventSubscriber</span>
#### CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback<void>)
### getCode（callback形式）
- 接口说明
- 方法说明
取消订阅公共事件（callback形式）
获取公共事件的结果代码（callback形式）
- unsubscribe参数描述
- 参数
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------- | ---- | ---------------------- | | 参数名 | 类型 | 必填 | 描述 |
| subscriber | 只读 | CommonEventSubscriber | 是 | 表示订阅者对象 | | -------- | ---------------------- | ---- | ------------------ |
| callback | 只读 | AsyncCallback<void> | 是 | 表示取消订阅的回调方法 | | callback | AsyncCallback\<number> | 是 | 公共事件的结果代码 |
- 返回值 - 示例
void ```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
- 示例 //设置有序公共事件的结果数据回调
function getCodeCallback(err, data) {
```js console.info("==========================>getCodeCallback=======================>");
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 console.info("==========================>err:=======================>", err.code);
//订阅者信息 console.info("==========================>code:=======================>", data);
var subscribeInfo = { }
events: ["event"] subscriber.getCode(getCodeCallback);
}; ```
//订阅公共事件回调
function SubscribeCallBack(err, data) { ### getCode（Promise形式）
console.info("==========================>SubscribeCallBack=======================>");
} - 方法说明
//创建订阅者回调
function CreateSubscriberCallBack(err, data) { 获取公共事件的结果代码（Promise形式）
console.info("==========================>CreateSubscriberCallBack=======================>");
subscriber = data; - 返回值
//订阅公共事件
CommonEvent.subscribe(subscriber, SubscribeCallBack); | 类型 | 说明 |
} | ---------------- | ------------------ |
//取消订阅公共事件回调 | Promise\<number> | 公共事件的结果代码 |
function UnsubscribeCallBack(err) {
console.info("==========================>UnsubscribeCallBack=======================>"); - 示例
}
//创建订阅者 ```js
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack); var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//取消订阅公共事件 subscriber.getCode().then((data) => {
CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack); console.info("==========================>getCodePromise=======================>");
``` console.info("==========================>code:=======================>", data);
});
```
### setCode（callback形式）
- 方法说明
设置公共事件的结果代码（callback形式）
- 参数
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| code | number | 是 | 公共事件的结果代码 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function setCodeCallback(err) {
console.info("==========================>setCodeCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.setCode(1, setCodeCallback);
```
### setCode（Promise形式）
- 方法说明
设置公共事件的结果代码（Promise形式）
- 参数
| 参数名 | 类型 | 必填 | 描述 |
| ------ | ------ | ---- | ------------------ |
| code | number | 是 | 公共事件的结果代码 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
subscriber.setCode(1).then(() => {
console.info("==========================>setCodePromise=======================>");
});
```
### getData（callback形式）
- 方法说明
获取公共事件的结果数据（callback形式）
- 参数
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<string> | 是 | 公共事件的结果数据 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getDataCallback(err, data) {
console.info("==========================>getDataCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>data:=======================>", data);
}
subscriber.getData(getDataCallback);
```
### getData（Promise形式）
- 方法说明
获取公共事件的结果数据（Promise形式）
- 返回值
| 类型 | 说明 |
| ---------------- | ------------------ |
| Promise\<string> | 公共事件的结果数据 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
subscriber.getData().then((data) => {
console.info("==========================>getDataPromise=======================>");
console.info("==========================>data:=======================>", data);
});
```
### setData（callback形式）
- 方法说明
设置公共事件的结果数据（callback形式）
- 参数
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| data | string | 是 | 公共事件的结果数据 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function setDataCallback(err) {
console.info("==========================>setDataCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.setData("publish_data_changed", setDataCallback);
```
### setData（Promise形式）
- 方法说明
设置公共事件的结果数据（Promise形式）
- 参数
| 参数名 | 类型 | 必填 | 描述 |
| ------ | ------ | ---- | ------------------ |
| data | string | 是 | 公共事件的结果数据 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
subscriber.setData("publish_data_changed").then(() => {
console.info("==========================>setDataPromise=======================>");
});
```
### setCodeAndData（callback形式）
- 方法说明
设置公共事件的结果代码和结果数据（callback形式）
- 参数
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| code | number | 是 | 公共事件的结果代码 |
| data | string | 是 | 公共事件的结果数据 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function setCodeDataCallback(err) {
console.info("==========================>setCodeDataCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCallback);
```
### setCodeAndData（Promise形式）
- 方法说明
设置公共事件的结果代码和结果数据（Promise形式）
- 参数
| 参数名 | 类型 | 必填 | 描述 |
| ------ | ------ | ---- | ------------------ |
| code | number | 是 | 公共事件的结果代码 |
| data | string | 是 | 公共事件的结果数据 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
console.info("==========================>setCodeAndData=======================>");
});
```
### isOrderedCommonEvent（callback形式）
- 方法说明
查询当前公共事件的是否为有序公共事件，返回true代表是有序公共事件，false代表不是有序公共事件（callback形式）
- 参数
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | -------------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 当前公共事件的是否为有序公共事件 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function isOrderedCallback(err, data) {
console.info("==========================>isOrderedCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>isOrdered:=======================>", data);
}
subscriber.isOrderedCommonEvent(isOrderedCallback);
```
### isOrderedCommonEvent（Promise形式）
- 方法说明
查询当前公共事件的是否为有序公共事件，返回true代表是有序公共事件，false代表不是有序公共事件（Promise形式）
- 返回值
| 类型 | 说明 |
| ----------------- | -------------------------------- |
| Promise\<boolean> | 当前公共事件的是否为有序公共事件 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
subscriber.isOrderedCommonEvent().then((data) => {
console.info("==========================>isOrdered:=======================>", data);
});
```
### abortCommonEvent（callback形式）
- 方法说明
取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（callback形式）
- 参数
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ------------------ |
| callback | AsyncCallback\<boolean> | 是 | 取消当前的公共事件 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function abortCallback(err) {
console.info("==========================>abortCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.abortCommonEvent(abortCallback);
```
### abortCommonEvent（Promise形式）
- 方法说明
取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（Promise形式）
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
subscriber.abortCommonEvent().then(() => {
console.info("==========================>abortCommonEvent:=======================>");
});
```
### clearAbortCommonEvent（callback形式）
- 方法说明
取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（callback形式）
- 参数
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function clearAbortCallback(err) {
console.info("==========================>clearAbortCallback=======================>");
console.info("==========================>err:=======================>", err.code);
}
subscriber.clearAbortCommonEvent(clearAbortCallback);
```
### clearAbortCommonEvent（Promise形式）
- 方法说明
取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（Promise形式）
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
subscriber.clearAbortCommonEvent().then(() => {
console.info("==========================>clearAbortCommonEvent:=======================>");
});
```
### getAbortCommonEvent（callback形式）
- 方法说明
获取当前有序公共事件是否取消的状态（callback形式）
- 参数
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 表示当前有序公共事件是否取消的状态 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getAbortCallback(err, data) {
console.info("==========================>getAbortCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>abort:=======================>", data);
}
subscriber.getAbortCommonEvent(getAbortCallback);
```
### getAbortCommonEvent（Promise形式）
- 方法说明
获取当前有序公共事件是否取消的状态（Promise形式）
- 返回值
| 类型 | 说明 |
| ----------------- | ---------------------------------- |
| Promise\<boolean> | 表示当前有序公共事件是否取消的状态 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
subscriber.getAbortCommonEvent().then((data) => {
console.info("==========================>getAbortCommonEvent:=======================>");
console.info("==========================>abort:=======================>", data);
});
```
### getSubscribeInfo（callback形式）
- 方法说明
获取订阅者的订阅信息（callback形式）
- 参数
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------------------------- | ---- | -------------------- |
| callback | AsyncCallback\<CommonEventSubscribeInfo> | 是 | 表示订阅者的订阅信息 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//设置有序公共事件的结果数据回调
function getSubscribeInfoCallback(err, data) {
console.info("==========================>getSubscribeInfoCallback=======================>");
console.info("==========================>err:=======================>", err.code);
console.info("==========================>priority:=======================>", data.priority);
}
subscriber.getSubscribeInfo(getSubscribeInfoCallback);
```
### getSubscribeInfo（Promise形式）
- 方法说明
获取订阅者的订阅信息（Promise形式）
- 返回值
| 类型 | 说明 |
| ---------------------------------- | -------------------- |
| Promise\<CommonEventSubscribeInfo> | 表示订阅者的订阅信息 |
- 示例
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
subscriber.getSubscribeInfo().then((data) => {
console.info("==========================>getSubscribeInfo:=======================>");
console.info("==========================>priority:=======================>", data.priority);
});
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md
浏览文件 @ ba3112c1
### DataAbilityHelper模块(JS端SDK接口) ### DataAbilityHelper模块(JS端SDK接口)
#### 支持设备 #### 支持设备
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 | | API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ | | ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ |
| DataAbilityHelper.openFile(uri: string, mode: string, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.openFile(uri: string, mode: string, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.openFile(uri: string, mode: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.openFile(uri: string, mode: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.getType(uri: string, callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.getType(uri: string, callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.getType(uri: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.getType(uri: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.normalizeUri(uri: string, callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.normalizeUri(uri: string, callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.normalizeUri(uri: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.normalizeUri(uri: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.denormalizeUri(uri: string, callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.denormalizeUri(uri: string, callback: AsyncCallback\<string>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.denormalizeUri(uri: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.denormalizeUri(uri: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.notifyChange(uri: string, callback: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.notifyChange(uri: string, callback: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.notifyChange(uri: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.notifyChange(uri: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.insert(uri: string, valuesBucket: rdb.ValuesBucket) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.insert(uri: string, valuesBucket: rdb.ValuesBucket) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.delete(uri: string, predicates: dataAbility.DataAbilityPredicates) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.delete(uri: string, predicates: dataAbility.DataAbilityPredicates) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<ResultSet>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<ResultSet>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| DataAbilityHelper.query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | DataAbilityHelper.query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
#### 权限列表 #### 导入模块
ohos.permission.RUNNING_LOCK permission ```
import featureAbility from '@ohos.ability.featureAbility'
#### 导入模块 import ohos_data_ability from '@ohos.data.dataability'
import ohos_data_rdb from '@ohos.data.rdb'
``` ```
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability' #### DataAbilityHelper.openFile(uri: string, mode: string, callback: AsyncCallback\<number>)
import ohos_data_rdb from '@ohos.data.rdb'
``` - 接口说明
#### DataAbilityHelper.openFile(uri: string, mode: string, callback: AsyncCallback\<number>) 在指定的远程路径中打开文件(callback形式)
- 接口说明
* 参数描述
在指定的远程路径中打开文件(callback形式)
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | -------------------- | ---- | ------------------------ |
* 参数描述 | uri | 只读 | string | 是 | 指示要打开的文件的路径。 |
| mode | 只读 | string | 是 | 指示文件打开模式‘rwt’。 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
| -------- | -------- | -------------------- | ---- | ------------------------ |
| uri | 只读 | string | 是 | 指示要打开的文件的路径。 | * 返回值
| mode | 只读 | string | 是 | 指示文件打开模式‘rwt’。 |
| callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 | 返回文件描述符。
* 返回值 * 示例
返回文件描述符。 ```javascript
import featureAbility from '@ohos.ability.featureAbility'
* 示例 var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
```javascript );
import featureAbility from '@ohos.ability.featureAbility' var mode = "rwt";
var DAHelper = await featureAbility.getDataAbilityHelper( DAHelper.openFile(
"dataability:///com.example.DataAbility" "dataability:///com.example.DataAbility",
); mode,
var mode = "rwt"; (err) => {
DAHelper.openFile( console.info("==========================>Called=======================>");
"dataability:///com.example.DataAbility", });
mode, ```
)
``` #### DataAbilityHelper.openFile(uri: string, mode: string)
#### DataAbilityHelper.openFile(uri: string, mode: string) - 接口说明
- 接口说明 在指定的远程路径中打开文件(Promise形式)
在指定的远程路径中打开文件(Promise形式) * 参数描述
* 参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------------------------ |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | uri | 只读 | string | 是 | 指示要打开的文件的路径。 |
| ---- | -------- | ------ | ---- | ------------------------ | | mode | 只读 | string | 是 | 指示文件打开模式‘rwt’。 |
| uri | 只读 | string | 是 | 指示要打开的文件的路径。 |
| mode | 只读 | string | 是 | 指示文件打开模式‘rwt’。 | * 返回值
* 返回值 返回文件描述符。
返回文件描述符。 * 示例
* 示例 ```javascript
import featureAbility from '@ohos.ability.featureAbility'
```javascript var DAHelper = featureAbility.acquireDataAbilityHelper(
import featureAbility from '@ohos.ability.featureAbility' "dataability:///com.example.DataAbility"
var DAHelper = await featureAbility.getDataAbilityHelper( );
"dataability:///com.example.DataAbility" var mode = "rwt";
); DAHelper.openFile(
var mode = "rwt"; "dataability:///com.example.DataAbility"，
DAHelper.openFile( mode).then((void) => {
"dataability:///com.example.DataAbility"， console.info("==========================>openFileCallback=======================>");
mode).then((void) => { });
console.info("==========================>openFileCallback=======================>"); ```
});
``` #### DataAbilityHelper.on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>)
#### DataAbilityHelper.on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>) - 接口说明
- 接口说明 注册观察者以观察给定uri指定的数据(callback形式)
注册观察者以观察给定uri指定的数据(callback形式) - 参数描述
- 参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | -------------------- | ---- | ------------------------ |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | type | 只读 | string | 是 | 数据更改。 |
| -------- | -------- | -------------------- | ---- | ------------------------ | | uri | 只读 | string | 是 | 指示要操作的数据的路径。 |
| type | 只读 | string | 是 | 数据更改。 | | callback | 只读 | AsyncCallback\<void> | 是 | 指示数据更改时的回调。 |
| uri | 只读 | string | 是 | 指示要操作的数据的路径。 |
| callback | 只读 | AsyncCallback\<void> | 是 | 指示数据更改时的回调。 | - 返回值
- 返回值 void
void - 示例
- 示例 ```js
import featureAbility from '@ohos.ability.featureAbility'
```js var helper = featureAbility.acquireDataAbilityHelper(
import featureAbility from '@ohos.ability.featureAbility' "dataability:///com.example.DataAbility"
var helper = await featureAbility.getDataAbilityHelper( );
"dataability:///com.example.DataAbility" function onChangeNotify() {
); console.info("==========================>onChangeNotify=======================>");
helper.on( };
"dataChange", helper.on(
"dataability:///com.example.DataAbility", "dataChange",
) "dataability:///com.example.DataAbility",
``` onChangeNotify
)
#### DataAbilityHelper.off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>) ```
- 接口说明 #### DataAbilityHelper.off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>)
注册观察者以观察给定uri指定的数据(callback形式) - 接口说明
- 参数描述 注册观察者以观察给定uri指定的数据(callback形式)
| 名称 | 读写属性 | 类型 | 必填 | 描述 | - 参数描述
| -------- | -------- | -------------------- | ---- | ------------------------ |
| type | 只读 | string | 是 | 数据更改。 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| uri | 只读 | string | 是 | 指示要操作的数据的路径。 | | -------- | -------- | -------------------- | ---- | ------------------------ |
| callback | 只读 | AsyncCallback\<void> | 否 | 指示已注册的回调。 | | type | 只读 | string | 是 | 数据更改。 |
| uri | 只读 | string | 是 | 指示要操作的数据的路径。 |
- 返回值 | callback | 只读 | AsyncCallback\<void> | 否 | 指示已注册的回调。 |
void - 返回值
- 示例 void
```js - 示例
import featureAbility from '@ohos.ability.featureAbility'
var helper = await featureAbility.getDataAbilityHelper( ```js
"dataability:///com.example.DataAbility" import featureAbility from '@ohos.ability.featureAbility'
); var helper = featureAbility.acquireDataAbilityHelper(
helper.off( "dataability:///com.example.DataAbility"
"dataChange", );
"dataability:///com.example.DataAbility", function onChangeNotify() {
) console.info("==========================>onChangeNotify=======================>");
``` };
helper.off(
#### DataAbilityHelper.getType(uri: string, callback: AsyncCallback\<string>) "dataChange",
"dataability:///com.example.DataAbility",
- 接口说明 )
helper.off(
获取给定URI指定的日期的MIME类型(callback形式) "dataChange",
"dataability:///com.example.DataAbility",
- 参数描述 onChangeNotify
)
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ```
| -------- | -------- | ---------------------- | ---- | ------------------------ |
| uri | 只读 | string | 是 | 指示要操作的数据的路径。 | #### DataAbilityHelper.getType(uri: string, callback: AsyncCallback\<string>)
| callback | 只读 | AsyncCallback\<string> | 是 | 回调方法 |
- 接口说明
- 返回值
获取给定URI指定的日期的MIME类型(callback形式)
返回与uri指定的数据匹配的MIME类型。
- 参数描述
- 示例
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
```js | -------- | -------- | ---------------------- | ---- | ------------------------ |
import featureAbility from '@ohos.ability.featureAbility' | uri | 只读 | string | 是 | 指示要操作的数据的路径。 |
var DAHelper = await featureAbility.getDataAbilityHelper( | callback | 只读 | AsyncCallback\<string> | 是 | 回调方法 |
"dataability:///com.example.DataAbility"
); - 返回值
DAHelper.getType(
"dataability:///com.example.DataAbility" 返回与uri指定的数据匹配的MIME类型。
)
``` - 示例
#### DataAbilityHelper.getType(uri: string) ```js
import featureAbility from '@ohos.ability.featureAbility'
- 接口说明 var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
获取给定URI指定的日期的MIME类型(Promise形式) );
DAHelper.getType(
- 参数描述 "dataability:///com.example.DataAbility",
(err, data) => {
| 名称 | 读写属性 | 类型 | 必填 | 描述 | console.info("==========================>Called=======================>");
| ---- | -------- | ------ | ---- | ------------------------ | });
| uri | 只读 | string | 是 | 指示要操作的数据的路径。 | ```
- 返回值 #### DataAbilityHelper.getType(uri: string)
返回与uri指定的数据匹配的MIME类型。 - 接口说明
- 示例 获取给定URI指定的日期的MIME类型(Promise形式)
```js - 参数描述
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper( | 名称 | 读写属性 | 类型 | 必填 | 描述 |
"dataability:///com.example.DataAbility" | ---- | -------- | ------ | ---- | ------------------------ |
); | uri | 只读 | string | 是 | 指示要操作的数据的路径。 |
DAHelper.getType(
"dataability:///com.example.DataAbility" - 返回值
).then((void) => {
console.info("==========================>getTypeCallback=======================>"); 返回与uri指定的数据匹配的MIME类型。
});
``` - 示例
#### DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>) ```js
import featureAbility from '@ohos.ability.featureAbility'
- 接口说明 var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
获取支持的文件的MIME类型(callback形式) );
DAHelper.getType(
- 参数描述 "dataability:///com.example.DataAbility"
).then((data) => {
| 名称 | 读写属性 | 类型 | 必填 | 描述 | console.info("==========================>getTypeCallback=======================>");
| -------------- | -------- | ---------------------- | ---- | ---------------------------- | });
| uri | 只读 | string | 是 | 指示要获取的文件的路径。 | ```
| mimeTypeFilter | 只读 | string | 是 | 指示要获取的文件的MIME类型。 |
| callback | 只读 | AsyncCallback\<string> | 是 | 回调方法 | #### DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>)
- 返回值 - 接口说明
返回匹配的MIME类型数组。 获取支持的文件的MIME类型(callback形式)
- 示例 - 参数描述
```js | 名称 | 读写属性 | 类型 | 必填 | 描述 |
import featureAbility from '@ohos.ability.featureAbility' | -------------- | -------- | ------------------------------ | ---- | ---------------------------- |
var DAHelper = await featureAbility.getDataAbilityHelper( | uri | 只读 | string | 是 | 指示要获取的文件的路径。 |
"dataability:///com.example.DataAbility" | mimeTypeFilter | 只读 | string | 是 | 指示要获取的文件的MIME类型。 |
); | callback | 只读 | AsyncCallback\<Array\<string>> | 是 | 回调方法 |
DAHelper.getFileTypes(
"dataability:///com.example.DataAbility", - 返回值
"image/*"
) 返回匹配的MIME类型数组。
```
- 示例
#### DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string)
```js
- 接口说明 import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
获取支持的文件的MIME类型(Promise形式) "dataability:///com.example.DataAbility"
);
- 参数描述 DAHelper.getFileTypes(
"dataability:///com.example.DataAbility",
| 名称 | 读写属性 | 类型 | 必填 | 描述 | "image/*",
| -------------- | -------- | ------ | ---- | ---------------------------- | (err, data) => {
| uri | 只读 | string | 是 | 指示要获取的文件的路径。 | console.info("==========================>Called=======================>");
| mimeTypeFilter | 只读 | string | 是 | 指示要获取的文件的MIME类型。 | });
```
- 返回值
#### DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string)
返回匹配的MIME类型数组。
- 接口说明
- 示例
获取支持的文件的MIME类型(Promise形式)
```js
import featureAbility from '@ohos.ability.featureAbility' - 参数描述
var DAHelper = await featureAbility.getDataAbilityHelper(
"dataability:///com.example.DataAbility" | 名称 | 读写属性 | 类型 | 必填 | 描述 |
); | -------------- | -------- | ------ | ---- | ---------------------------- |
DAHelper.getFileTypes( | uri | 只读 | string | 是 | 指示要获取的文件的路径。 |
"dataability:///com.example.DataAbility", | mimeTypeFilter | 只读 | string | 是 | 指示要获取的文件的MIME类型。 |
"image/*"
).then((void) => { - 返回值
console.info("==========================>getFileTypesCallback=======================>");
}); 返回匹配的MIME类型数组。
```
- 示例
#### DataAbilityHelper.normalizeUri(uri: string, callback: AsyncCallback\<string>)
```js
- 接口说明 import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
将引用数据功能的给定uri转换为规范化uri(callback形式) "dataability:///com.example.DataAbility"
);
- 参数描述 DAHelper.getFileTypes(
"dataability:///com.example.DataAbility",
| 名称 | 读写属性 | 类型 | 必填 | 描述 | "image/*"
| -------- | -------- | ---------------------- | ---- | ----------------------- | ).then((data) => {
| uri | 只读 | string | 是 | 指示要规范化的uri对象。 | console.info("==========================>getFileTypesCallback=======================>");
| callback | 只读 | AsyncCallback\<string> | 是 | 回调方法 | });
```
- 返回值
#### DataAbilityHelper.normalizeUri(uri: string, callback: AsyncCallback\<string>)
如果数据功能支持uri规范化或null，则返回规范化uri对象。
- 接口说明
- 示例
将引用数据功能的给定uri转换为规范化uri(callback形式)
```js
import featureAbility from '@ohos.ability.featureAbility' - 参数描述
var DAHelper = await featureAbility.getDataAbilityHelper(
"dataability:///com.example.DataAbility" | 名称 | 读写属性 | 类型 | 必填 | 描述 |
); | -------- | -------- | ---------------------- | ---- | ----------------------- |
DAHelper.normalizeUri( | uri | 只读 | string | 是 | 指示要规范化的uri对象。 |
"dataability:///com.example.DataAbility", | callback | 只读 | AsyncCallback\<string> | 是 | 回调方法 |
)
``` - 返回值
#### DataAbilityHelper.normalizeUri(uri: string) 如果数据功能支持uri规范化或null，则返回规范化uri对象。
- 接口说明 - 示例
将引用数据功能的给定uri转换为规范化uri(Promise形式) ```js
import featureAbility from '@ohos.ability.featureAbility'
- 参数描述 var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
| 名称 | 读写属性 | 类型 | 必填 | 描述 | );
| ---- | -------- | ------ | ---- | ----------------------- | DAHelper.normalizeUri(
| uri | 只读 | string | 是 | 指示要规范化的uri对象。 | "dataability:///com.example.DataAbility",
(err, data) => {
- 返回值 console.info("==========================>Called=======================>");
});
如果数据功能支持uri规范化或null，则返回规范化uri对象。 ```
- 示例 #### DataAbilityHelper.normalizeUri(uri: string)
```js - 接口说明
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper( 将引用数据功能的给定uri转换为规范化uri(Promise形式)
"dataability:///com.example.DataAbility"
); - 参数描述
DAHelper.normalizeUri(
"dataability:///com.example.DataAbility", | 名称 | 读写属性 | 类型 | 必填 | 描述 |
).then((void) => { | ---- | -------- | ------ | ---- | ----------------------- |
console.info("==========================>normalizeUriCallback=======================>"); | uri | 只读 | string | 是 | 指示要规范化的uri对象。 |
});
``` - 返回值
#### DataAbilityHelper.denormalizeUri(uri: string, callback: AsyncCallback\<string>) 如果数据功能支持uri规范化或null，则返回规范化uri对象。
- 接口说明 - 示例
将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri(callback形式) ```js
import featureAbility from '@ohos.ability.featureAbility'
- 参数描述 var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
| 名称 | 读写属性 | 类型 | 必填 | 描述 | );
| -------- | -------- | ---------------------- | ---- | ----------------------- | DAHelper.normalizeUri(
| uri | 只读 | string | 是 | 指示要规范化的uri对象。 | "dataability:///com.example.DataAbility",
| callback | 只读 | AsyncCallback\<string> | 是 | 回调方法 | ).then((data) => {
console.info("==========================>normalizeUriCallback=======================>");
- 返回值 });
```
如果反规范化成功，则返回反规范化uri对象。
#### DataAbilityHelper.denormalizeUri(uri: string, callback: AsyncCallback\<string>)
- 示例
- 接口说明
```js
import featureAbility from '@ohos.ability.featureAbility' 将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri(callback形式)
var DAHelper = await featureAbility.getDataAbilityHelper(
"dataability:///com.example.DataAbility" - 参数描述
);
DAHelper.denormalizeUri( | 名称 | 读写属性 | 类型 | 必填 | 描述 |
"dataability:///com.example.DataAbility", | -------- | -------- | ---------------------- | ---- | ----------------------- |
) | uri | 只读 | string | 是 | 指示要规范化的uri对象。 |
``` | callback | 只读 | AsyncCallback\<string> | 是 | 回调方法 |
#### DataAbilityHelper.denormalizeUri(uri: string) - 返回值
- 接口说明 如果反规范化成功，则返回反规范化uri对象。
将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri(Promise形式) - 示例
- 参数描述 ```js
import featureAbility from '@ohos.ability.featureAbility'
| 名称 | 读写属性 | 类型 | 必填 | 描述 | var DAHelper = featureAbility.acquireDataAbilityHelper(
| ---- | -------- | ------ | ---- | ----------------------- | "dataability:///com.example.DataAbility"
| uri | 只读 | string | 是 | 指示要规范化的uri对象。 | );
DAHelper.denormalizeUri(
- 返回值 "dataability:///com.example.DataAbility",,
(err, data) => {
如果反规范化成功，则返回反规范化uri对象。 console.info("==========================>Called=======================>");
});
- 示例 ```
```js #### DataAbilityHelper.denormalizeUri(uri: string)
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper( - 接口说明
"dataability:///com.example.DataAbility"
); 将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri(Promise形式)
DAHelper.denormalizeUri(
"dataability:///com.example.DataAbility", - 参数描述
).then((void) => {
console.info("==========================>denormalizeUriCallback=======================>"); | 名称 | 读写属性 | 类型 | 必填 | 描述 |
}); | ---- | -------- | ------ | ---- | ----------------------- |
``` | uri | 只读 | string | 是 | 指示要规范化的uri对象。 |
#### DataAbilityHelper.notifyChange(uri: string, callback: AsyncCallback\<void>) - 返回值
- 接口说明 如果反规范化成功，则返回反规范化uri对象。
通知已注册的观察者uri指定的数据资源的更改(callback形式) - 示例
- 参数描述 ```js
import featureAbility from '@ohos.ability.featureAbility'
| 名称 | 读写属性 | 类型 | 必填 | 描述 | var DAHelper = featureAbility.acquireDataAbilityHelper(
| -------- | -------- | -------------------- | ---- | ------------------------ | "dataability:///com.example.DataAbility"
| uri | 只读 | string | 是 | 指示要操作的数据的路径。 | );
| callback | 只读 | AsyncCallback\<void> | 是 | 回调方法 | DAHelper.denormalizeUri(
"dataability:///com.example.DataAbility",
- 返回值 ).then((data) => {
console.info("==========================>denormalizeUriCallback=======================>");
void });
```
- 示例
#### DataAbilityHelper.notifyChange(uri: string, callback: AsyncCallback\<void>)
```js
import featureAbility from '@ohos.ability.featureAbility' - 接口说明
var helper = await featureAbility.getDataAbilityHelper(
"dataability:///com.example.DataAbility" 通知已注册的观察者uri指定的数据资源的更改(callback形式)
);
helper.notifyChange( - 参数描述
"dataability:///com.example.DataAbility",
) | 名称 | 读写属性 | 类型 | 必填 | 描述 |
``` | -------- | -------- | -------------------- | ---- | ------------------------ |
| uri | 只读 | string | 是 | 指示要操作的数据的路径。 |
#### DataAbilityHelper.notifyChange(uri: string) | callback | 只读 | AsyncCallback\<void> | 是 | 回调方法 |
- 接口说明 - 返回值
通知已注册的观察者uri指定的数据资源的更改(Promise形式) void
- 参数描述 - 示例
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ```js
| ---- | -------- | ------ | ---- | ------------------------ | import featureAbility from '@ohos.ability.featureAbility'
| uri | 只读 | string | 是 | 指示要操作的数据的路径。 | var helper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
- 返回值 );
helper.notifyChange(
void "dataability:///com.example.DataAbility",,
(err) => {
- 示例 console.info("==========================>Called=======================>");
});
```js ```
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper( #### DataAbilityHelper.notifyChange(uri: string)
"dataability:///com.example.DataAbility"
); - 接口说明
DAHelper.notifyChange(
"dataability:///com.example.DataAbility", 通知已注册的观察者uri指定的数据资源的更改(Promise形式)
).then((void) => {
console.info("==========================>notifyChangeCallback=======================>"); - 参数描述
});
``` | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------------------------ |
#### DataAbilityHelper.insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<number>) | uri | 只读 | string | 是 | 指示要操作的数据的路径。 |
- 接口说明 - 返回值
将单个数据记录插入数据库(callback形式) void
- 参数描述 - 示例
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ```js
| ------------ | -------- | ---------------------- | ---- | ------------------------------------------------------ | import featureAbility from '@ohos.ability.featureAbility'
| uri | 只读 | string | 是 | 指示要插入的数据的路径。 | var DAHelper = featureAbility.acquireDataAbilityHelper(
| valuesBucket | 只读 | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 | "dataability:///com.example.DataAbility"
| callback | 只读 | AsyncCallback\<number> | 是 | 回调方法 | );
DAHelper.notifyChange(
- 返回值 "dataability:///com.example.DataAbility",
).then((void) => {
返回插入数据记录的索引。 console.info("==========================>notifyChangeCallback=======================>");
});
- 示例 ```
```js #### DataAbilityHelper.insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<number>)
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper( - 接口说明
"dataability:///com.example.DataAbility"
); 将单个数据记录插入数据库(callback形式)
const valueBucket = {
"name": "rose", - 参数描述
"age": 22,
"salary": 200.5, | 名称 | 读写属性 | 类型 | 必填 | 描述 |
"blobType": u8, | ------------ | -------- | ---------------------- | ---- | ------------------------------------------------------ |
} | uri | 只读 | string | 是 | 指示要插入的数据的路径。 |
DAHelper.insert( | valuesBucket | 只读 | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 |
"dataability:///com.example.DataAbility", | callback | 只读 | AsyncCallback\<number> | 是 | 回调方法 |
valueBucket
) - 返回值
```
返回插入数据记录的索引。
#### DataAbilityHelper.insert(uri: string, valuesBucket: rdb.ValuesBucket)
- 示例
- 接口说明
```js
将单个数据记录插入数据库(Promise形式) import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
- 参数描述 "dataability:///com.example.DataAbility"
);
| 名称 | 读写属性 | 类型 | 必填 | 描述 | const valueBucket = {
| ------------ | -------- | ---------------- | ---- | ------------------------------------------------------ | "name": "rose",
| uri | 只读 | string | 是 | 指示要插入的数据的路径。 | "age": 22,
| valuesBucket | 只读 | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 | "salary": 200.5,
"blobType": u8,
- 返回值 }
DAHelper.insert(
返回插入数据记录的索引。 "dataability:///com.example.DataAbility",
valueBucket,
- 示例 (err, data) => {
console.info("==========================>Called=======================>");
```js });
import featureAbility from '@ohos.ability.featureAbility' ```
var DAHelper = await featureAbility.getDataAbilityHelper(
"dataability:///com.example.DataAbility" #### DataAbilityHelper.insert(uri: string, valuesBucket: rdb.ValuesBucket)
);
const valueBucket = { - 接口说明
"name": "rose1",
"age": 221, 将单个数据记录插入数据库(Promise形式)
"salary": 20.5,
"blobType": u8, - 参数描述
}
DAHelper.insert( | 名称 | 读写属性 | 类型 | 必填 | 描述 |
"dataability:///com.example.DataAbility", | ------------ | -------- | ---------------- | ---- | ------------------------------------------------------ |
valueBucket | uri | 只读 | string | 是 | 指示要插入的数据的路径。 |
).then((void) => { | valuesBucket | 只读 | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 |
console.info("==========================>insertCallback=======================>");
}); - 返回值
```
返回插入数据记录的索引。
#### DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>, callback: AsyncCallback\<number>)
- 示例
- 接口说明
```js
将多个数据记录插入数据库(callback形式) import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
- 参数描述 "dataability:///com.example.DataAbility"
);
| 名称 | 读写属性 | 类型 | 必填 | 描述 | const valueBucket = {
| ------------ | -------- | ----------------------- | ---- | ------------------------ | "name": "rose1",
| uri | 只读 | string | 是 | 指示要插入的数据的路径。 | "age": 221,
| valuesBucket | 只读 | Array<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 | "salary": 20.5,
| callback | 只读 | AsyncCallback\<number> | 是 | 回调方法 | "blobType": u8,
}
- 返回值 DAHelper.insert(
"dataability:///com.example.DataAbility",
返回插入的数据记录数。 valueBucket
).then((data) => {
- 示例 console.info("==========================>insertCallback=======================>");
});
```js ```
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper( #### DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>, callback: AsyncCallback\<number>)
"dataability:///com.example.DataAbility"
); - 接口说明
var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": u8,},
{"name": "roe12", "age": 21, "salary": 20.5, "blobType": u8,}, 将多个数据记录插入数据库(callback形式)
{"name": "roe13", "age": 21, "salary": 20.5, "blobType": u8,})
DAHelper.batchInsert( - 参数描述
"dataability:///com.example.DataAbility",
cars | 名称 | 读写属性 | 类型 | 必填 | 描述 |
) | ------------ | -------- | ----------------------- | ---- | ------------------------ |
``` | uri | 只读 | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | 只读 | Array<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 |
#### DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>) | callback | 只读 | AsyncCallback\<number> | 是 | 回调方法 |
- 接口说明 - 返回值
将多个数据记录插入数据库(Promise形式) 返回插入的数据记录数。
- 参数描述 - 示例
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ```js
| ------------ | -------- | ----------------------- | ---- | ------------------------ | import featureAbility from '@ohos.ability.featureAbility'
| uri | 只读 | string | 是 | 指示要插入的数据的路径。 | var DAHelper = featureAbility.acquireDataAbilityHelper(
| valuesBucket | 只读 | Array<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 | "dataability:///com.example.DataAbility"
);
- 返回值 var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": u8,},
{"name": "roe12", "age": 21, "salary": 20.5, "blobType": u8,},
返回插入的数据记录数。 {"name": "roe13", "age": 21, "salary": 20.5, "blobType": u8,})
DAHelper.batchInsert(
- 示例 "dataability:///com.example.DataAbility",
cars,
```js (err, data) => {
import featureAbility from '@ohos.ability.featureAbility' console.info("==========================>Called=======================>");
var DAHelper = await featureAbility.getDataAbilityHelper( });
"dataability:///com.example.DataAbility" ```
);
var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": u8,}, #### DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>)
{"name": "roe12", "age": 21, "salary": 20.5, "blobType": u8,},
{"name": "roe13", "age": 21, "salary": 20.5, "blobType": u8,}) - 接口说明
DAHelper.batchInsert(
"dataability:///com.example.DataAbility", 将多个数据记录插入数据库(Promise形式)
cars
).then((void) => { - 参数描述
console.info("==========================>batchInsertCallback=======================>");
}); | 名称 | 读写属性 | 类型 | 必填 | 描述 |
``` | ------------ | -------- | ----------------------- | ---- | ------------------------ |
| uri | 只读 | string | 是 | 指示要插入的数据的路径。 |
#### DataAbilityHelper.delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>) | valuesBucket | 只读 | Array<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 |
- 接口说明 - 返回值
从数据库中删除一个或多个数据记录(callback形式) 返回插入的数据记录数。
- 参数描述 - 示例
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ```js
| ------------ | -------- | --------------------------------- | ---- | ------------------------------------------------ | import featureAbility from '@ohos.ability.featureAbility'
| uri | 只读 | string | 是 | 指示要删除的数据的路径。 | var DAHelper = featureAbility.acquireDataAbilityHelper(
| valuesBucket | 只读 | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | "dataability:///com.example.DataAbility"
| callback | 只读 | AsyncCallback\<number> | 是 | 回调方法 | );
var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": u8,},
- 返回值 {"name": "roe12", "age": 21, "salary": 20.5, "blobType": u8,},
{"name": "roe13", "age": 21, "salary": 20.5, "blobType": u8,})
返回已删除的数据记录数。 DAHelper.batchInsert(
"dataability:///com.example.DataAbility",
- 示例 cars
).then((data) => {
```js console.info("==========================>batchInsertCallback=======================>");
import featureAbility from '@ohos.ability.featureAbility' });
import ohos_data_ability from '@ohos.data.dataability' ```
var DAHelper = await featureAbility.getDataAbilityHelper(
"dataability:///com.example.DataAbility" #### DataAbilityHelper.delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>)
);
let da = new ohos_data_ability.DataAbilityPredicates() - 接口说明
DAHelper.delete(
"dataability:///com.example.DataAbility", 从数据库中删除一个或多个数据记录(callback形式)
da
) - 参数描述
```
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
#### DataAbilityHelper.delete(uri: string, predicates: dataAbility.DataAbilityPredicates) | ------------ | -------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | 只读 | string | 是 | 指示要删除的数据的路径。 |
- 接口说明 | valuesBucket | 只读 | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
| callback | 只读 | AsyncCallback\<number> | 是 | 回调方法 |
从数据库中删除一个或多个数据记录(Promise形式)
- 返回值
- 参数描述
返回已删除的数据记录数。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------ | -------- | --------------------------------- | ---- | ------------------------------------------------ | - 示例
| uri | 只读 | string | 是 | 指示要删除的数据的路径。 |
| valuesBucket | 只读 | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | ```js
import featureAbility from '@ohos.ability.featureAbility'
- 返回值 import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = featureAbility.acquireDataAbilityHelper(
返回已删除的数据记录数。 "dataability:///com.example.DataAbility"
);
- 示例 let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.delete(
```js "dataability:///com.example.DataAbility",
import featureAbility from '@ohos.ability.featureAbility' da,
var DAHelper = await featureAbility.getDataAbilityHelper( (err, data) => {
"dataability:///com.example.DataAbility" console.info("==========================>Called=======================>");
); });
let da = new ohos_data_ability.DataAbilityPredicates() ```
DAHelper.delete(
"dataability:///com.example.DataAbility", #### DataAbilityHelper.delete(uri: string, predicates: dataAbility.DataAbilityPredicates)
da
).then((void) => { - 接口说明
console.info("==========================>deleteCallback=======================>");
}); 从数据库中删除一个或多个数据记录(Promise形式)
```
- 参数描述
#### DataAbilityHelper.update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>)
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
- 接口说明 | ------------ | -------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | 只读 | string | 是 | 指示要删除的数据的路径。 |
更新数据库中的数据记录(callback形式) | valuesBucket | 只读 | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
- 参数描述 - 返回值
| 名称 | 读写属性 | 类型 | 必填 | 描述 | 返回已删除的数据记录数。
| ------------ | -------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | 只读 | string | 是 | 指示要更新的数据的路径。 | - 示例
| valuesBucket | 只读 | rdb.ValuesBucket | 是 | 指示要更新的数据。 |
| predicates | 只读 | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | ```js
| callback | 只读 | AsyncCallback\<number> | 是 | 回调方法 | import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
- 返回值 "dataability:///com.example.DataAbility"
);
返回更新的数据记录数。 let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.delete(
- 示例 "dataability:///com.example.DataAbility",
da
```js ).then((data) => {
import featureAbility from '@ohos.ability.featureAbility' console.info("==========================>deleteCallback=======================>");
import ohos_data_ability from '@ohos.data.dataability' });
var DAHelper = await featureAbility.getDataAbilityHelper( ```
"dataability:///com.example.DataAbility"
); #### DataAbilityHelper.update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>)
const va = {
"name": "roe1", - 接口说明
"age": 21,
"salary": 20.5, 更新数据库中的数据记录(callback形式)
"blobType": u8,
} - 参数描述
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.update( | 名称 | 读写属性 | 类型 | 必填 | 描述 |
"dataability:///com.example.DataAbility", | ------------ | -------- | --------------------------------- | ---- | ------------------------------------------------ |
va, | uri | 只读 | string | 是 | 指示要更新的数据的路径。 |
da | valuesBucket | 只读 | rdb.ValuesBucket | 是 | 指示要更新的数据。 |
) | predicates | 只读 | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
``` | callback | 只读 | AsyncCallback\<number> | 是 | 回调方法 |
#### DataAbilityHelper.update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates) - 返回值
- 接口说明 返回更新的数据记录数。
更新数据库中的数据记录(Promise形式) - 示例
- 参数描述 ```js
import featureAbility from '@ohos.ability.featureAbility'
| 名称 | 读写属性 | 类型 | 必填 | 描述 | import ohos_data_ability from '@ohos.data.dataability'
| ------------ | -------- | --------------------------------- | ---- | ------------------------------------------------ | var DAHelper = featureAbility.acquireDataAbilityHelper(
| uri | 只读 | string | 是 | 指示要更新的数据的路径。 | "dataability:///com.example.DataAbility"
| valuesBucket | 只读 | rdb.ValuesBucket | 是 | 指示要更新的数据。 | );
| predicates | 只读 | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | const va = {
"name": "roe1",
- 返回值 "age": 21,
"salary": 20.5,
返回更新的数据记录数。 "blobType": u8,
}
- 示例 let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.update(
```js "dataability:///com.example.DataAbility",
import featureAbility from '@ohos.ability.featureAbility' va,
import ohos_data_ability from '@ohos.data.dataability' da,
var DAHelper = await featureAbility.getDataAbilityHelper( (err, data) => {
"dataability:///com.example.DataAbility" console.info("==========================>Called=======================>");
); });
const va = { ```
"name": "roe1",
"age": 21, #### DataAbilityHelper.update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates)
"salary": 20.5,
"blobType": u8, - 接口说明
}
let da = new ohos_data_ability.DataAbilityPredicates() 更新数据库中的数据记录(Promise形式)
DAHelper.update(
"dataability:///com.example.DataAbility", - 参数描述
va,
da | 名称 | 读写属性 | 类型 | 必填 | 描述 |
).then((void) => { | ------------ | -------- | --------------------------------- | ---- | ------------------------------------------------ |
console.info("==========================>updateCallback=======================>"); | uri | 只读 | string | 是 | 指示要更新的数据的路径。 |
}); | valuesBucket | 只读 | rdb.ValuesBucket | 是 | 指示要更新的数据。 |
``` | predicates | 只读 | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
#### DataAbilityHelper.query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<ResultSet>) - 返回值
- 接口说明 返回更新的数据记录数。
查询数据库中的数据(callback形式) - 示例
- 参数描述 ```js
import featureAbility from '@ohos.ability.featureAbility'
| 名称 | 读写属性 | 类型 | 必填 | 描述 | import ohos_data_ability from '@ohos.data.dataability'
| ---------- | -------- | --------------------------------- | ---- | ------------------------------------------------ | var DAHelper = featureAbility.acquireDataAbilityHelper(
| uri | 只读 | string | 是 | 指示要查询的数据的路径。 | "dataability:///com.example.DataAbility"
| columns | 只读 | rdb.ValuesBucket | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 | );
| predicates | 只读 | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | const va = {
| callback | 只读 | AsyncCallback\<ResultSet> | 是 | 回调方法 | "name": "roe1",
"age": 21,
- 返回值 "salary": 20.5,
"blobType": u8,
返回查询结果 }
let da = new ohos_data_ability.DataAbilityPredicates()
- 示例 DAHelper.update(
"dataability:///com.example.DataAbility",
```js va,
import featureAbility from '@ohos.ability.featureAbility' da
import ohos_data_ability from '@ohos.data.dataability' ).then((data) => {
var DAHelper = await featureAbility.getDataAbilityHelper( console.info("==========================>updateCallback=======================>");
"dataability:///com.example.DataAbility" });
); ```
var cars=new Array({"value1"}, {"value2"}, {"value3"}, {"value4"});
let da = new ohos_data_ability.DataAbilityPredicates() #### DataAbilityHelper.query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<ResultSet>)
DAHelper.query(
"dataability:///com.example.DataAbility", - 接口说明
cars,
da 查询数据库中的数据(callback形式)
)
``` - 参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------------------- | ---- | ------------------------------------------------ |
#### DataAbilityHelper.query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates) | uri | 只读 | string | 是 | 指示要查询的数据的路径。 |
| columns | 只读 | rdb.ValuesBucket | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 |
- 接口说明 | predicates | 只读 | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
| callback | 只读 | AsyncCallback\<ResultSet> | 是 | 回调方法 |
查询数据库中的数据(Promise形式)
- 返回值
- 参数描述
返回查询结果
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------------------- | ---- | ------------------------------------------------ | - 示例
| uri | 读写 | string | 是 | 指示要查询的数据的路径。 |
| columns | 读写 | rdb.ValuesBucket | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 | ```js
| predicates | 读写 | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
- 返回值 var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
返回查询结果 );
var cars=new Array({"value1"}, {"value2"}, {"value3"}, {"value4"});
- 示例 let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.query(
```js "dataability:///com.example.DataAbility",
import featureAbility from '@ohos.ability.featureAbility' cars,
import ohos_data_ability from '@ohos.data.dataability' da,
var DAHelper = await featureAbility.getDataAbilityHelper( (err, data) => {
"dataability:///com.example.DataAbility" console.info("==========================>Called=======================>");
); });
var cars=new Array({"value1"}, {"value2"}, {"value3"}, {"value4"}); ```
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.query(
"dataability:///com.example.DataAbility",
cars, #### DataAbilityHelper.query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates)
da
).then((void) => { - 接口说明
console.info("==========================>queryCallback=======================>");
}); 查询数据库中的数据(Promise形式)
```
- 参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | 读写 | string | 是 | 指示要查询的数据的路径。 |
| columns | 读写 | rdb.ValuesBucket | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 |
| predicates | 读写 | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
- 返回值
返回查询结果
- 示例
```js
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
);
var cars=new Array({"value1"}, {"value2"}, {"value3"}, {"value4"});
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.query(
"dataability:///com.example.DataAbility",
cars,
da
).then((data) => {
console.info("==========================>queryCallback=======================>");
});
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md
浏览文件 @ ba3112c1
# FeatureAbility模块(JS端SDK接口) # FeatureAbility模块
#### 支持设备 ## 支持设备
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 | | API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ | | ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ |
| FeatureAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.startAbility(parameter: StartAbilityParameter) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.startAbility(parameter: StartAbilityParameter): Promise\<number> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.acquireDataAbilityHelper(uri: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.acquireDataAbilityHelper(uri: string): DataAbilityHelper | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.terminateSelfWithResult(parameter: AbilityResult) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.terminateSelfWithResult(parameter: AbilityResult): Promise\<void> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.hasWindowFocus(callback: AsyncCallback\<boolean>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.hasWindowFocus(callback: AsyncCallback\<boolean>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.hasWindowFocus() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.hasWindowFocus(): Promise\<boolean> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.getWant(callback: AsyncCallback\<Want>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.getWant(callback: AsyncCallback\<Want>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.getWant() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.getWant(): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.getContext() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.getContext(): Context | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.terminateSelf(callback: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.terminateSelf(callback: AsyncCallback\<void>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.terminateSelf() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.terminateSelf(): Promise\<void> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.continueAbility(options: ContinueAbilityOptions, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | FeatureAbility.connectAbility(request: Want, options:ConnectOptions): number | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| FeatureAbility.disconnectAbility(connection: number, callback:AsyncCallback\<void>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
#### 权限列表 | FeatureAbility.disconnectAbility(connection: number): Promise\<void> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
ohos.permission.RUNNING_LOCK permission ## 使用限制
#### 使用限制 FeatureAbility模块的接口只能在Page类型的Ability调用
FeatureAbility模块的接口只能在Page类型的Ability调用 ## 导入模块
#### 导入模块 ```
import featureAbility from '@ohos.ability.featureAbility'
``` ```
import featureAbility from '@ohos.ability.featureAbility'
``` ## FeatureAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>): void
#### FeatureAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>) * 接口说明
* 接口说明 启动新的ability(callback形式)
启动新的ability(callback形式) * startAbility参数描述
* startAbility参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | --------------------- | ---- | ------------------- |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability |
| --------- | -------- | --------------------- | ---- | ------------------- | | callback | 只读 | AsyncCallback\<number> | 是 | 被指定的回调方法 |
| parameter | 只读 | StartAbilityParameter | 是 | 表示被启动的Ability |
| callback | 只读 | AsyncCallback | 是 | 被指定的回调方法 | - 返回值
- StartAbilityParameter类型说明 - 示例
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ```javascript
| ------------------- | -------- | ------ | ---- | ---------------------------------- | import featureAbility from '@ohos.ability.featureAbility'
| want | 只读 | want | 是 | 表示需要包含有关目标启动能力的信息 | featureAbility.startAbility(
| abilityStartSetting | 只读 | string | 否 | 指示启动能力中使用的特殊启动设置 | {
want:
- want类型说明 {
action: "",
| 名称 | 读写属性 | 类型 | 必填 | 描述 | entities: [""],
| ----------- | -------- | ------ | ---- | -------------------------- | type: "",
| deviceId | 只读 | string | 否 | 设备id | flags: FLAG_AUTH_READ_URI_PERMISSION,
| bundleName | 只读 | string | 否 | 捆绑包名称 | deviceId: "",
| abilityName | 只读 | string | 否 | ability 名字 | bundleName: "com.example.startability",
| uri | 只读 | string | 否 | 请求中URI的描述 | abilityName: "com.example.startability.MainAbility",
| type | 只读 | string | 否 | 此文件中类型的说明 | uri: ""
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 | },
| action | 只读 | string | 否 | 需求中对操作的描述 | },
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 | );
| entities | 只读 | string | 否 | 对象中实体的描述 | )
```
* flags类型说明
| 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ | ## FeatureAbility.startAbility(parameter: StartAbilityParameter): Promise\<number>
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 | * 接口说明
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源异能 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 | 启动新的ability(Promise形式)
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否不属于OHOS |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 | * startAbility参数描述
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动 | | --------- | -------- | ------------------------------------------------------- | ---- | ------------------- |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能 | | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示延续是可逆的。 |
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能 | - 返回值
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，请使用后台模式安装指定的DI功能。 |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Intent}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用 | - 示例
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 | ```javascript
import featureAbility from '@ohos.ability.featureAbility'
* 返回值 featureAbility.startAbility(
{
void want:
{
* 示例 entities: ["entity.system.home"],
type: "MIMETYPE",
```javascript flags: FLAG_AUTH_READ_URI_PERMISSION,
import featureAbility from '@ohos.ability.featureAbility' deviceId: deviceId,
featureAbility.startAbility( bundleName: "com.example.startability",
{ abilityName: "com.example.startability.MainAbility",
want: uri: ""
{ },
action: "", }
entities: [""], ).then((void) => {
type: "", console.info("==========================>startAbility=======================>");
flags: FLAG_AUTH_READ_URI_PERMISSION, });
deviceId: "", ```
bundleName: "com.example.startability",
abilityName: "com.example.startability.MainAbility",
uri: ""
}, ## FeatureAbility.acquireDataAbilityHelper(uri: string): DataAbilityHelper
},
); * 接口说明
)
``` 获取dataAbilityHelper
* 参数描述
#### FeatureAbility.startAbility(parameter: StartAbilityParameter) | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ---------------------- |
* 接口说明 | uri | 只读 | string | 是 | 指示要打开的文件的路径 |
启动新的ability(Promise形式) * 返回值
* startAbility参数描述 | 类型 | 说明 |
| ----------------- | ------------------------------------------ |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类 |
| --------- | -------- | --------------------- | ---- | ------------------- |
| parameter | 只读 | StartAbilityParameter | 是 | 表示被启动的Ability | * 示例
- StartAbilityParameter类型说明 ```javascript
import featureAbility from '@ohos.ability.featureAbility'
| 名称 | 读写属性 | 类型 | 必填 | 描述 | featureAbility.acquireDataAbilityHelper(
| ------------------- | -------- | ------ | ---- | ---------------------------------- | "dataability:///com.exmaple.DataAbility"
| want | 只读 | want | 是 | 表示需要包含有关目标启动能力的信息 | )
| abilityStartSetting | 只读 | string | 否 | 指示启动能力中使用的特殊启动设置 | ```
- want类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ## FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void
| ----------- | -------- | ------ | ---- | -------------------------- |
| deviceId | 只读 | string | 否 | 表示被启动的PageAbility的设备id，缺省表示启动本地的PageAbility | * 接口说明
| bundleName | 只读 | string | 否 | 捆绑包名称 |
| abilityName | 只读 | string | 否 | ability 名字 | 启动一个ability，并在该ability被销毁时返回执行结果(callback形式)
| uri | 只读 | string | 否 | 请求中URI的描述 |
| type | 只读 | string | 否 | 此文件中类型的说明 | * startAbility参数描述
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 |
| action | 只读 | string | 否 | 需求中对操作的描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 | | --------- | -------- | ---------------------- | ---- | ------------------- |
| entities | 只读 | string | 否 | 对象中实体的描述 | | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability |
| callback | 只读 | AsyncCallback\<[AbilityResult](#AbilityResult类型说明)> | 是 | 被指定的回调方法 |
* flags类型说明
* 返回值
| 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ | [AbilityResult](#AbilityResult类型说明)
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 | * 示例
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源异能 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 | ```javascript
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否不属于OHOS | import featureAbility from '@ohos.ability.featureability';
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 | featureAbility.startAbilityForResult(
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 | {
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 | want:
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动 | {
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能 | action: "action.system.home",
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示延续是可逆的。 | entities: ["entity.system.home"],
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能 | type: "MIMETYPE",
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，请使用后台模式安装指定的DI功能。 | flags: FLAG_AUTH_READ_URI_PERMISSION,
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Intent}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用 | deviceId: "",
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 | bundleName: "com.example.featureabilitytest",
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 | abilityName: "com.example.featureabilitytest.MainAbility",
uri:""
* 返回值 },
},
void )
```
* 示例
```javascript
import featureAbility from '@ohos.ability.featureAbility' ## FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
featureAbility.startAbility(
{ * 接口说明
want:
{ 启动一个ability，并在该ability被销毁时返回执行结果(Promise形式)
action: "action.system.home",
entities: ["entity.system.home"], * startAbility参数描述
type: "MIMETYPE",
flags: FLAG_AUTH_READ_URI_PERMISSION, | 名称 | 读写属性 | 类型 | 必填 | 描述 |
deviceId: deviceId, | --------- | -------- | ------------------------------------------------------- | ---- | ------------------- |
bundleName: "com.example.startability", | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability |
abilityName: "com.example.startability.MainAbility",
uri: "" * 返回值
},
} [AbilityResult](#AbilityResult类型说明)
).then((void) => {
console.info("==========================>startAbility=======================>"); * 示例
});
``` ```javascript
import featureAbility from '@ohos.ability.featureability';
featureAbility.startAbilityForResult(
{
#### FeatureAbility.acquireDataAbilityHelper(uri: string) want:
{
* 接口说明 action: "action.system.home",
entities: ["entity.system.home"],
获取dataAbilityHelper type: "MIMETYPE",
flags: FLAG_AUTH_READ_URI_PERMISSION,
* 参数描述 deviceId: "",
bundleName: "com.example.featureabilitytest",
| 名称 | 读写属性 | 类型 | 必填 | 描述 | abilityName: "com.example.featureabilitytest.MainAbility",
| ---- | -------- | ------ | ---- | ---------------------- | uri:"",
| uri | 只读 | string | 是 | 指示要打开的文件的路径 | parameters:
{
* 返回值 mykey0: 1111,
mykey1: [1, 2, 3],
返回dataAbilityHelper mykey2: "[1, 2, 3]",
mykey3: "xxxxxxxxxxxxxxxxxxxxxx",
* 示例 mykey4: [1, 15],
mykey5: [false, true, false],
```javascript mykey6: ["aaaaaa", "bbbbb", "ccccccccccc"],
import featureAbility from '@ohos.ability.featureAbility' mykey7: true,
featureAbility.acquireDataAbilityHelper( },
"dataability:///com.exmaple.DataAbility" },
) requestCode: 2,
``` },
).then((void) => {
console.info("==========================>startAbilityForResult=======================>");
});
#### FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>) ```
* 接口说明
启动一个ability，并在该ability被销毁时返回执行结果(callback形式) ## FeatureAbility.terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>): void
* startAbility参数描述 * 接口说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | 设置此page ability将返回给调用者的结果代码和数据并破坏此page ability(callback形式)
| --------- | -------- | ---------------------- | ---- | ------------------- |
| parameter | 只读 | StartAbilityParameter | 是 | 表示被启动的Ability |
| callback | 只读 | AsyncCallback\<number> | 是 | 被指定的回调方法 | * startAbility参数描述
- StartAbilityParameter类型说明 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ------------- | ---- | ------------------- |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | parameter | 只读 | [AbilityResult](#AbilityResult类型说明) | 是 | 表示被启动的Ability |
| ------------------- | -------- | ------ | ---- | ---------------------------------- | | callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
| want | 只读 | want | 是 | 表示需要包含有关目标启动能力的信息 |
| abilityStartSetting | 只读 | string | 否 | 指示启动能力中使用的特殊启动设置 | * 返回值
- want类型说明 * 示例
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ```javascript
| ----------- | -------- | ------ | ---- | -------------------------- | import featureAbility from '@ohos.ability.featureAbility'
| deviceId | 只读 | string | 否 | 设备id | featureAbility.terminateSelfWithResult(
| bundleName | 只读 | string | 否 | 捆绑包名称 | {
| abilityName | 只读 | string | 否 | ability 名字 | resultCode: 1,
| uri | 只读 | string | 否 | 请求中URI的描述 | want:
| type | 只读 | string | 否 | 此文件中类型的说明 | {
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 | action: "action.system.home",
| action | 只读 | string | 否 | 需求中对操作的描述 | entities: ["entity.system.home"],
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 | type: "MIMETYPE",
| entities | 只读 | string | 否 | 对象中实体的描述 | flags: FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "",
* flags类型说明 bundleName: "com.example.featureabilitytest",
abilityName: "com.example.featureabilitytest.MainAbility",
| 名称 | 参数 | 描述 | uri:"",
| ------------------------------------ | ---------- | ------------------------------------------------------------ | parameters: {
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 | mykey0: 2222,
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 | mykey1: [1, 2, 3],
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源异能 | mykey2: "[1, 2, 3]",
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 | mykey3: "ssssssssssssssssssssssssss",
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否不属于OHOS | mykey4: [1, 15],
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 | mykey5: [false, true, false],
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 | mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 | mykey7: true,
| 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 | 如果未安装，请使用后台模式安装指定的DI功能。 | ```
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Intent}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用 |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
## FeatureAbility.terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
* 返回值
* 接口说明
返回{@link AbilityResult}
设置此page ability将返回给调用者的结果代码和数据并破坏此page ability(Promise形式)
* 示例
* startAbility参数描述
```javascript
import featureAbility from '@ohos.ability.featureability'; | 名称 | 读写属性 | 类型 | 必填 | 描述 |
featureAbility.startAbilityForResult( | --------- | -------- | --------------------------------------- | ---- | ------------------- |
{ | parameter | 只读 | [AbilityResult](#AbilityResult类型说明) | 是 | 表示被启动的Ability |
want:
{ * 返回值
action: "action.system.home",
entities: ["entity.system.home"], * 示例
type: "MIMETYPE",
flags: FLAG_AUTH_READ_URI_PERMISSION, ```javascript
deviceId: "", import featureAbility from '@ohos.ability.featureability';
bundleName: "com.example.featureabilitytest", featureAbility.terminateSelfWithResult(
abilityName: "com.example.startabilityforresulttest1.MainAbility", {
uri:"" resultCode: 1,
}, want:
}, {
) action: "action.system.home",
``` entities: ["entity.system.home"],
type: "MIMETYPE",
flags: FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "",
#### FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter) bundleName: "com.example.featureabilitytest",
abilityName: "com.example.featureabilitytest.MainAbility",
* 接口说明 uri:"",
parameters: {
启动一个ability，并在该ability被销毁时返回执行结果(Promise形式) mykey0: 2222,
mykey1: [1, 2, 3],
* startAbility参数描述 mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
| 名称 | 读写属性 | 类型 | 必填 | 描述 | mykey4: [1, 15],
| --------- | -------- | --------------------- | ---- | ------------------- | mykey5: [false, true, false],
| parameter | 只读 | StartAbilityParameter | 是 | 表示被启动的Ability | mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey7: true,
- StartAbilityParameter类型说明 }
},
| 名称 | 读写属性 | 类型 | 必填 | 描述 | }
| ------------------- | -------- | ------ | ---- | ---------------------------------- | ).then((void) => {
| want | 只读 | want | 是 | 表示需要包含有关目标启动能力的信息 | console.info("==========================>terminateSelfWithResult=======================>");
| abilityStartSetting | 只读 | string | 否 | 指示启动能力中使用的特殊启动设置 | });
```
- want类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | -------------------------- | ## FeatureAbility.hasWindowFocus(callback: AsyncCallback\<boolean>): void
| deviceId | 只读 | string | 否 | 设备id |
| bundleName | 只读 | string | 否 | 捆绑包名称 | * 接口说明
| abilityName | 只读 | string | 否 | ability 名字 |
| uri | 只读 | string | 否 | 请求中URI的描述 | 检查ability的主窗口是否具有窗口焦点(callback形式)
| type | 只读 | string | 否 | 此文件中类型的说明 |
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 | * 参数描述
| action | 只读 | string | 否 | 需求中对操作的描述 |
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| entities | 只读 | string | 否 | 对象中实体的描述 | | -------- | -------- | ----------------------- | ---- | ---------------- |
| callback | 只读 | AsyncCallback\<boolean> | 是 | 被指定的回调方法 |
* flags类型说明
* 返回值
| 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ | 如果此异能当前具有视窗焦点，则返回{@code true}；否则返回{@code false}
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 | * 示例
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源异能 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 | ```javascript
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否不属于OHOS | import featureAbility from '@ohos.ability.featureability';
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 | featureAbility.hasWindowFocus()
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 | ```
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动 |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能 |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示延续是可逆的。 | ## FeatureAbility.hasWindowFocus(): Promise\<boolean>
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能 |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，请使用后台模式安装指定的DI功能。 | * 接口说明
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Intent}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用 |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 | 检查ability的主窗口是否具有窗口焦点(Promise形式)
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
* 参数描述
* 返回值
无
返回{@link AbilityResult}
* 返回值
* 示例
如果此异能当前具有视窗焦点，则返回{@code true}；否则返回{@code false}
```javascript
import featureAbility from '@ohos.ability.featureability'; * 示例
featureAbility.startAbilityForResult(
{ ```javascript
want: import featureAbility from '@ohos.ability.featureability';
{ featureAbility.hasWindowFocus().then((void) => {
action: "action.system.home", console.info("==========================>hasWindowFocus=======================>");
entities: ["entity.system.home"], });
type: "MIMETYPE", ```
flags: FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "",
bundleName: "com.example.featureabilitytest",
abilityName: "com.example.startabilityforresulttest2.MainAbility", ## FeatureAbility.getWant(callback: AsyncCallback\<Want>)
uri:"",
parameters: * 接口说明
{
mykey0: 1111, 获取从ability发送的want(callback形式)
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", * 参数描述
mykey3: "xxxxxxxxxxxxxxxxxxxxxx",
mykey4: [1, 15], | 名称 | 读写属性 | 类型 | 必填 | 描述 |
mykey5: [false, true, false], | -------- | -------- | -------------------- | ---- | ---------------- |
mykey6: ["aaaaaa", "bbbbb", "ccccccccccc"], | callback | 只读 | AsyncCallback\<Want> | 是 | 被指定的回调方法 |
mykey7: true,
}, * 返回值
},
requestCode: 2, * 示例
},
).then((void) => { ```javascript
console.info("==========================>startAbilityForResult=======================>"); import featureAbility from '@ohos.ability.featureability';
}); featureAbility.getWant()
``` ```
#### FeatureAbility.terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>) ## FeatureAbility.getWant(): void
* 接口说明 * 接口说明
设置此page ability将返回给调用者的结果代码和数据并破坏此page ability(callback形式) 获取从ability发送的want(Promise形式)
* 参数描述
* startAbility参数描述
无
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ------------- | ---- | ------------------- | * 返回值
| parameter | 只读 | AbilityResult | 是 | 表示被启动的Ability |
| callback | 只读 | AsyncCallback | 是 | 被指定的回调方法 | * 示例
```javascript
* AbilityResult类型说明 import featureAbility from '@ohos.ability.featureability';
featureAbility.getWant().then((void) => {
| 名称 | 读写属性 | 类型 | 必填 | 描述 | console.info("==========================>getWantCallBack=======================>");
| ---------- | -------- | ------ | ---- | ------------------------------------------------------------ | });
| resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持） | ```
| want | 只读 | Want | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
- want类型说明
## FeatureAbility.getContext(): Context
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | -------------------------- | * 接口说明
| deviceId | 只读 | string | 否 | 设备id |
| bundleName | 只读 | string | 否 | 捆绑包名称 | 获取应用程序上下文
| abilityName | 只读 | string | 否 | ability 名字 |
| uri | 只读 | string | 否 | 请求中URI的描述 | * 返回值
| type | 只读 | string | 否 | 此文件中类型的说明 |
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 | 返回应用程序上下文
| action | 只读 | string | 否 | 需求中对操作的描述 |
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 | * 示例
| entities | 只读 | string | 否 | 对象中实体的描述 |
```javascript
* flags类型说明 import featureAbility from '@ohos.ability.featureability';
var context = featureAbility.getContext()
| 名称 | 参数 | 描述 | context.getBundleName()
| ------------------------------------ | ---------- | ------------------------------------------------------------ | ```
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源异能 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 | ## FeatureAbility.terminateSelf(callback: AsyncCallback\<void>): void
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否不属于OHOS |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 | * 接口说明
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 | 设置page ability返回给被调用方的结果代码和数据，并销毁此page ability(callback形式)
| 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 | 如果未安装，请使用后台模式安装指定的DI功能。 | | -------- | -------- | -------------------- | ---- | ---------------- |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Intent}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用 | | callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 | * 返回值
* 返回值 * 示例
void ```javascript
import featureAbility from '@ohos.ability.featureability';
* 示例 featureAbility.terminateSelf()
```
```javascript
import featureAbility from '@ohos.ability.featureAbility'
featureAbility.terminateSelfWithResult(
{ ## FeatureAbility.terminateSelf(): Promise\<void>
resultCode: 1,
want: * 接口说明
{
action: "action.system.home", 设置page ability返回给被调用方的结果代码和数据，并销毁此page ability(Promise形式)
entities: ["entity.system.home"],
type: "MIMETYPE", * 参数描述
flags: FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", Null
bundleName: "com.example.featureabilitytest",
abilityName: "com.example.finishwithresulttest1.MainAbility", * 返回值
uri:"",
parameters: { * 示例
mykey0: 2222,
mykey1: [1, 2, 3], ```javascript
mykey2: "[1, 2, 3]", import featureAbility from '@ohos.ability.featureability';
mykey3: "ssssssssssssssssssssssssss", featureAbility.terminateSelf().then((void) => { console.info("==========================>terminateSelfCallBack=======================>");
mykey4: [1, 15], });
mykey5: [false, true, false], ```
mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey7: true, ## FeatureAbility.connectAbility(request: Want, options:ConnectOptions): number
}
}, * 接口说明
},
); 将当前ability连接到指定ServiceAbility(callback形式)
```
* connectAbility参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
#### FeatureAbility.terminateSelfWithResult(parameter: AbilityResult) | ------- | -------- | -------------- | ---- | -------------------------- |
| request | 只读 | Want | 是 | 表示被连接的ServiceAbility |
* 接口说明 | options | 只读 | ConnectOptions | 是 | 被指定的回调方法 |
设置此page ability将返回给调用者的结果代码和数据并破坏此page ability(Promise形式) - ConnectOptions类型说明
* startAbility参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------ | -------- | -------- | ---- | ---------------------------------- |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | onConnect | 只读 | function | 是 | 连接成功时的回调函数 |
| --------- | -------- | ------------- | ---- | ------------------- | | onDisconnect | 只读 | function | 是 | 连接失败时的回调函数 |
| parameter | 只读 | AbilityResult | 是 | 表示被启动的Ability | | onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数 |
* 返回值
* AbilityResult类型说明
连接的ServiceAbilityID。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------ | ---- | ------------------------------------------------------------ | * 示例
| resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持） |
| want | 只读 | Want | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 | ```javascript
import featureAbility from '@ohos.ability.featureAbility'
- want类型说明 function onConnectCallback(element, remote){
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
| 名称 | 读写属性 | 类型 | 必填 | 描述 | }
| ----------- | -------- | ------ | ---- | -------------------------- | function onDisconnectCallback(element){
| deviceId | 只读 | string | 否 | 设备id | console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
| bundleName | 只读 | string | 否 | 捆绑包名称 | }
| abilityName | 只读 | string | 否 | ability 名字 | function onFailedCallback(code){
| uri | 只读 | string | 否 | 请求中URI的描述 | console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
| type | 只读 | string | 否 | 此文件中类型的说明 | }
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 | var connId = featureAbility.connectAbility(
| action | 只读 | string | 否 | 需求中对操作的描述 | {
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 | bundleName: "com.ix.ServiceAbility",
| entities | 只读 | string | 否 | 对象中实体的描述 | abilityName: "ServiceAbilityA",
},
* flags类型说明 {
onConnect: onConnectCallback,
| 名称 | 参数 | 描述 | onDisconnect: onDisconnectCallback,
| ------------------------------------ | ---------- | ------------------------------------------------------------ | onFailed: onFailedCallback,
| 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 | ## FeatureAbility.disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 | * 接口说明
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动 | 断开与指定ServiceAbility的连接(callback形式)
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能 |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示延续是可逆的。 | * disconnectAbility参数描述
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能 |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，请使用后台模式安装指定的DI功能。 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Intent}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用 | | ---------- | -------- | ------------- | ---- | ------------------------------ |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 | | connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 | | callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
* 返回值 * 返回值
void * 示例
* 示例 ```javascript
import featureAbility from '@ohos.ability.featureAbility'
```javascript function onConnectCallback(element, remote){
import featureAbility from '@ohos.ability.featureability'; console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
featureAbility.terminateSelfWithResult( }
{ function onDisconnectCallback(element){
resultCode: 1, console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
want: }
{ function onFailedCallback(code){
action: "action.system.home", console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
entities: ["entity.system.home"], }
type: "MIMETYPE", var connId = featureAbility.connectAbility(
flags: FLAG_AUTH_READ_URI_PERMISSION, {
deviceId: "", bundleName: "com.ix.ServiceAbility",
bundleName: "com.example.featureabilitytest", abilityName: "ServiceAbilityA",
abilityName: "com.example.finishwithresulttest1.MainAbility", },
uri:"", {
parameters: { onConnect: onConnectCallback,
mykey0: 2222, onDisconnect: onDisconnectCallback,
mykey1: [1, 2, 3], onFailed: onFailedCallback,
mykey2: "[1, 2, 3]", },
mykey3: "ssssssssssssssssssssssssss", );
mykey4: [1, 15], var result = featureAbility.disconnectAbility(connId,
mykey5: [false, true, false], (error,data) => {
mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], console.log('featureAbilityTest DisConnectJsSameBundleName result errCode : ' + error.code + " data: " + data)
mykey7: true, },
} );
}, ```
}
).then((void) => { ## FeatureAbility.disconnectAbility(connection: number): Promise\<void>
console.info("==========================>terminateSelfWithResult=======================>");
}); * 接口说明
```
断开与指定ServiceAbility的连接(promise形式)
* disconnectAbility参数描述
#### FeatureAbility.hasWindowFocus(callback: AsyncCallback\<boolean>)
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
* 接口说明 | ---------- | -------- | ------ | ---- | ------------------------------ |
| connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID |
检查ability的主窗口是否具有窗口焦点(callback形式)
* 返回值
* 参数描述
* 示例
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ----------------------- | ---- | ---------------- | ```javascript
| callback | 只读 | AsyncCallback\<boolean> | 是 | 被指定的回调方法 | import featureAbility from '@ohos.ability.featureAbility'
function onConnectCallback(element, remote){
* 返回值 console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
如果此异能当前具有视窗焦点，则返回{@code true}；否则返回{@code false} function onDisconnectCallback(element){
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
* 示例 }
function onFailedCallback(code){
```javascript console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
import featureAbility from '@ohos.ability.featureability'; }
featureAbility.hasWindowFocus() var connId = featureAbility.connectAbility(
``` {
bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA",
},
#### FeatureAbility.hasWindowFocus() {
onConnect: onConnectCallback,
* 接口说明 onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
检查ability的主窗口是否具有窗口焦点(Promise形式) },
);
* 参数描述 var result = await featureAbility.disconnectAbility(connId);
```
Null
## AbilityResult类型说明
* 返回值
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
如果此异能当前具有视窗焦点，则返回{@code true}；否则返回{@code false} | ---------- | -------- | --------------------- | ---- | ------------------------------------------------------------ |
| resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持） |
* 示例 | want | 只读 | [Want](#Want类型说明) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
```javascript ## StartAbilityParameter类型说明
import featureAbility from '@ohos.ability.featureability';
featureAbility.hasWindowFocus().then((void) => { | 名称 | 读写属性 | 类型 | 必填 | 描述 |
console.info("==========================>hasWindowFocus=======================>"); | ------------------- | -------- | --------------------- | ---- | ------------------------------------------------------------ |
}); | want | 只读 | [Want](#Want类型说明) | 是 | 表示需要包含有关目标启动能力的信息。 |
``` | abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 |
## Want类型说明
#### FeatureAbility.getWant(callback: AsyncCallback\<Want>) | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
* 接口说明 | deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
获取从ability发送的want(callback形式) | 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描述。 |
| callback | 只读 | AsyncCallback\<Want> | 是 | 被指定的回调方法 | | entities | 只读 | Array\<string> | 否 | 表示entities相关描述。 |
* 返回值 ## flags说明
void | 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
* 示例 | FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 |
```javascript | FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源能力 |
import featureAbility from '@ohos.ability.featureability'; | FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 |
featureAbility.getWant() | FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS |
``` | FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力 |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动 |
#### FeatureAbility.getWant() | FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能 |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 |
* 接口说明 | FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能 |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 |
获取从ability发送的want(Promise形式) | FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Want}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用 |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 |
* 参数描述 | FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
Null ## AbilityStartSetting类型说明
* 返回值 abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。
void 使用时通过featureAbility.AbilityStartSetting获取，示例：featureAbility.AbilityStartSetting.BOUNDS_KEY。
* 示例 | 名称 | 参数 | 描述 |
| --------------- | --------------- | -------------------------- |
```javascript | BOUNDS_KEY | "abilityBounds" | 窗口显示大小属性的名称。 |
import featureAbility from '@ohos.ability.featureability'; | WINDOW_MODE_KEY | "windowMode" | 窗口显示模式属性的名称。 |
featureAbility.getWant().then((void) => { | DISPLAY_ID_KEY | "displayId" | 窗口显示设备ID属性的名称。 |
console.info("==========================>getWantCallBack=======================>");
}); ## AbilityWindowConfiguration类型说明
```
使用时通过featureAbility.AbilityWindowConfiguration获取，示例：featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED。
| 名称 | 参数 | 描述 |
#### FeatureAbility.getContext() | --------------------------- | ---- | ---------- |
| WINDOW_MODE_UNDEFINED | 0 | 未定义。 |
* 接口说明 | WINDOW_MODE_FULLSCREEN | 1 | 全屏。 |
| WINDOW_MODE_SPLIT_PRIMARY | 100 | 分屏主屏。 |
获取应用程序上下文 | WINDOW_MODE_SPLIT_SECONDARY | 101 | 分屏次屏。 |
| WINDOW_MODE_FLOATING | 102 | 悬浮窗。 |
* 返回值 \ No newline at end of file
返回应用程序上下文
* 示例
```javascript
import featureAbility from '@ohos.ability.featureability';
var context = featureAbility.getContext()
context.getBundleName()
```
#### FeatureAbility.terminateSelf(callback: AsyncCallback\<void>)
* 接口说明
设置page ability返回给被调用方的结果代码和数据，并销毁此page ability(callback形式)
* 参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | -------------------- | ---- | ---------------- |
| callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
* 返回值
void
* 示例
```javascript
import featureAbility from '@ohos.ability.featureability';
featureAbility.terminateSelf()
```
#### FeatureAbility.terminateSelf()
* 接口说明
设置page ability返回给被调用方的结果代码和数据，并销毁此page ability(Promise形式)
* 参数描述
Null
* 返回值
* void
* 示例
```javascript
import featureAbility from '@ohos.ability.featureability';
featureAbility.terminateSelf().then((void) => { console.info("==========================>terminateSelfCallBack=======================>");
});
```
#### FeatureAbility.connectAbility(*request*: Want, *options*:ConnectOptions): number
* 接口说明
将当前ability连接到指定ServiceAbility(callback形式)
* connectAbility参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------- | -------- | -------------- | ---- | -------------------------- |
| request | 只读 | Want | 是 | 表示被连接的ServiceAbility |
| options | 只读 | ConnectOptions | 是 | 被指定的回调方法 |
* Want参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------ | -------- | -------- | ---- | ---------------------------------- |
| deviceId | 只读 | string | 否 | 表示被连接的ServiceAbility的设备id，缺省表示连接本地的ServiceAbility |
| bundleName | 只读 | string | 是 | 表示被连接的ServiceAbility的包名 |
| abilityName | 只读 | string | 是 | 表示被连接的ServiceAbility的类名 |
- ConnectOptions类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------ | -------- | -------- | ---- | ---------------------------------- |
| onConnect | 只读 | function | 是 | 连接成功时的回调函数 |
| onDisconnect | 只读 | function | 是 | 连接失败时的回调函数 |
| onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数 |
* 返回值
连接的ServiceAbilityID。
* 示例
```javascript
import featureAbility from '@ohos.ability.featureAbility'
var mRemote;
var connId;
function onConnectCallback(element, remote){
mRemote = remote;
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
function onDisconnectCallback(element){
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
}
function onFailedCallback(code){
console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connId = featureAbility.connectAbility(
{
deviceId: deviceId,
bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA",
},
{
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
},
);
```
#### FeatureAbility.disconnectAbility(connection: number, callback:AsyncCallback<void>): void
* 接口说明
断开与指定ServiceAbility的连接(callback形式)
* disconnectAbility参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------------- | ---- | ------------------------------ |
| connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID |
| callback | 只读 | AsyncCallback | 是 | 被指定的回调方法 |
* 返回值
无
* 示例
```javascript
import featureAbility from '@ohos.ability.featureAbility'
var mRemote;
var connId;
function onConnectCallback(element, remote){
mRemote = remote;
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
function onDisconnectCallback(element){
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
}
function onFailedCallback(code){
console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connId = featureAbility.connectAbility(
{
bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA",
},
{
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
},
);
var result = featureAbility.disconnectAbility(connId,
(error,data) => {
console.log('featureAbilityTest DisConnectJsSameBundleName result errCode : ' + error.code + " data: " + data)
},
);
```
#### FeatureAbility.disconnectAbility(connection: number): Promise<void>;
* 接口说明
断开与指定ServiceAbility的连接(promise形式)
* disconnectAbility参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------ | ---- | ------------------------------ |
| connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID |
* 返回值
无
* 示例
```javascript
import featureAbility from '@ohos.ability.featureAbility'
var mRemote;
var connId;
function onConnectCallback(element, remote){
mRemote = remote;
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
function onDisconnectCallback(element){
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
}
function onFailedCallback(code){
console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connId = featureAbility.connectAbility(
{
bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA",
},
{
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
},
);
var result = await featureAbility.disconnectAbility(connId);
```
#### FeatureAbility.continueAbility(options: ContinueAbilityOptions, callback: AsyncCallback<void>);
* 接口说明
迁移一个ability到目标设备，并返回执行结果(callback形式)
* startAbility参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | ------------------- |
| options | 只读 | ContinueAbilityOptions | 是 | 表示被启动的Ability |
| callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
- ContinueAbilityOptions类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------- | ---- | ----------------------------------------------------------- |
| deviceId | 只读 | string | 是 | 表示需要包含有关目标启动能力的信息 |
| reversible | 只读 | boolean | 是 | 是否支持回迁的标志，目前不支持该功能，为保留字段，可填false |
* 示例
```javascript
import featureAbility from '@ohos.ability.featureAbility'
async StartContinueAbility(deviceId) {
let continueAbilityOptions = {
reversible: false,
deviceId: deviceId,
}
function ContinueAbilityCallback(err, data) {
console.info("[Demo] ContinueAbilityCallback, result err = " + JSON.stringify(err));
console.info("[Demo] ContinueAbilityCallback, result data= " + JSON.stringify(data));
}
await featureAbility.continueAbility(continueAbilityOptions, ContinueAbilityCallback);
console.info('[Demo] featureAbility.StartContinueAbility end');
}
this.StartContinueAbility(remoteDeviceId); //remoteDeviceId is acquired from DeviceManager
```
zh-cn/application-dev/reference/apis/js-apis-notification.md
浏览文件 @ ba3112c1
# Notification模块(JS端SDK接口) # Notification模块
#### 支持设备 ## 支持设备
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | | API | 手机 | 平板 | 智慧屏 | 智能穿戴 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | | ------------------------------------------------------------ | ---- | ---- | ------ | -------- |
...@@ -83,19 +83,19 @@ ...@@ -83,19 +83,19 @@
| WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 | | WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\> | 支持 | 支持 | 支持 | 支持 | | WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\> | 支持 | 支持 | 支持 | 支持 |
#### 权限列表 ## 权限列表
无 无
#### 通知接口 ## 通知接口
#### 导入模块 ## 导入模块
```js ```js
import notify from '@ohos.notification'; import Notification from '@ohos.notification';
``` ```
#### Notification.publish(request: NotificationRequest, callback: AsyncCallback\<void\>) ## Notification.publish(request: NotificationRequest, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -144,12 +144,13 @@ import notify from '@ohos.notification'; ...@@ -144,12 +144,13 @@ import notify from '@ohos.notification';
NotificationContent类型说明 NotificationContent类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ---------------------------- | ---- | -------------- | | ----------- | -------- | ---------------------------- | ---- | ------------------ |
| contentType | 读、写 | ContentType | 是 | 通知内容类型 | | contentType | 读、写 | ContentType | 是 | 通知内容类型 |
| normal | 读、写 | NotificationBasicContent | 否 | 通知基本内容 | | normal | 读、写 | NotificationBasicContent | 否 | 基本类型通知内容 |
| longText | 读、写 | NotificationLongTextContent | 否 | 通知长文本内容 | | longText | 读、写 | NotificationLongTextContent | 否 | 长文本类型通知内容 |
| multiLine | 读、写 | NotificationMultiLineContent | 否 | 通知多行内容 | | multiLine | 读、写 | NotificationMultiLineContent | 否 | 多行类型通知内容 |
| picture | 读、写 | NotificationPictureContent | 否 | 图片类型通知内容 |
- ContentType类型说明 - ContentType类型说明
...@@ -202,6 +203,15 @@ NotificationContent类型说明 ...@@ -202,6 +203,15 @@ NotificationContent类型说明
| expandedTitle | 读、写 | string | 是 | 通知展开时的标题 | | expandedTitle | 读、写 | string | 是 | 通知展开时的标题 |
| picture | 读、写 | image.PixelMap | 是 | 通知的图片内容 | | picture | 读、写 | image.PixelMap | 是 | 通知的图片内容 |
- SlotType类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------------- | -------- | -------- | ---- | -------- |
| SOCIAL_COMMUNICATION | 只读 | SlotType | 否 | 社交类型 |
| SERVICE_INFORMATION | 只读 | SlotType | 否 | 服务类型 |
| CONTENT_INFORMATION | 只读 | SlotType | 否 | 内容类型 |
| OTHER_TYPES | 只读 | SlotType | 否 | 其他类型 |
- NotificationActionButton类型说明 - NotificationActionButton类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
...@@ -247,7 +257,7 @@ Notification.publish(notificationRequest, publishCallback) ...@@ -247,7 +257,7 @@ Notification.publish(notificationRequest, publishCallback)
#### Notification.publish(request: NotificationRequest) ## Notification.publish(request: NotificationRequest)
- 接口说明 - 接口说明
...@@ -280,7 +290,7 @@ Notification.publish(notificationRequest).then((void) => { ...@@ -280,7 +290,7 @@ Notification.publish(notificationRequest).then((void) => {
#### Notification.cancel(id: number, label: string, callback: AsyncCallback\<void\>) ## Notification.cancel(id: number, label: string, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -291,7 +301,7 @@ Notification.publish(notificationRequest).then((void) => { ...@@ -291,7 +301,7 @@ Notification.publish(notificationRequest).then((void) => {
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | -------------------- | | -------- | -------- | --------------------- | ---- | -------------------- |
| id | 只读 | number | 是 | 通知ID | | id | 只读 | number | 是 | 通知ID |
| lable | 只读 | string | 是 | 通知标签 | | label | 只读 | string | 是 | 通知标签 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 | | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- 返回值 - 返回值
...@@ -310,7 +320,7 @@ Notification.cancel(0, "label", cancelCallback) ...@@ -310,7 +320,7 @@ Notification.cancel(0, "label", cancelCallback)
#### Notification.cancel(id：number, label？：string） ## Notification.cancel(id：number, label？：string）
- 接口说明 - 接口说明
...@@ -321,7 +331,7 @@ Notification.cancel(0, "label", cancelCallback) ...@@ -321,7 +331,7 @@ Notification.cancel(0, "label", cancelCallback)
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----- | -------- | ------ | ---- | -------- | | ----- | -------- | ------ | ---- | -------- |
| id | 只读 | number | 是 | 通知ID | | id | 只读 | number | 是 | 通知ID |
| lable | 只读 | string | 是 | 通知标签 | | label | 只读 | string | 否 | 通知标签 |
- 返回值 - 返回值
...@@ -337,7 +347,7 @@ Notification.cancel(0).then((void) => { ...@@ -337,7 +347,7 @@ Notification.cancel(0).then((void) => {
#### Notification.cancel(id: number, callback: AsyncCallback\<void\>) ## Notification.cancel(id: number, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -366,7 +376,7 @@ Notification.cancel(0, cancelCallback) ...@@ -366,7 +376,7 @@ Notification.cancel(0, cancelCallback)
#### Notification.cancelAll(callback: AsyncCallback\<void\>) ## Notification.cancelAll(callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -394,11 +404,11 @@ Notification.cancelAll(cancelCallback) ...@@ -394,11 +404,11 @@ Notification.cancelAll(cancelCallback)
#### Notification.cancelAll() ## Notification.cancelAll()
- 接口说明 - 接口说明
取消所有已发布的通知（callback形式) 取消所有已发布的通知（Promise形式)
- 参数描述 - 参数描述
...@@ -406,7 +416,7 @@ Notification.cancelAll(cancelCallback) ...@@ -406,7 +416,7 @@ Notification.cancelAll(cancelCallback)
- 返回值 - 返回值
void Promise\<void\>
- 示例 - 示例
...@@ -418,7 +428,7 @@ Notification.cancelAll().then((void) => { ...@@ -418,7 +428,7 @@ Notification.cancelAll().then((void) => {
#### Notification.addSlot(slot: NotificationSlot, callback: AsyncCallback\<void\>) ## Notification.addSlot(slot: NotificationSlot, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -426,10 +436,10 @@ Notification.cancelAll().then((void) => { ...@@ -426,10 +436,10 @@ Notification.cancelAll().then((void) => {
- addSlot参数描述 - addSlot参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | ------------------------------------------ | | -------- | -------- | --------------------- | ---- | -------------------- |
| slot | 只读 | NotificationSlot | 是 | 要创建的通知通道，由{NotificationSlot}设置 | | slot | 只读 | NotificationSlot | 是 | 要创建的通知通道对象 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 | | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- NotificationSlot类型说明 - NotificationSlot类型说明
...@@ -460,14 +470,14 @@ function addSlotCallBack(err) { ...@@ -460,14 +470,14 @@ function addSlotCallBack(err) {
} }
//通知slot对象 //通知slot对象
var notificationSlot = { var notificationSlot = {
type:SOCIAL_COMMUNICATION type: Notification.SlotType.SOCIAL_COMMUNICATION
} }
Notification.addSlot(notificationSlot, addSlotCallBack) Notification.addSlot(notificationSlot, addSlotCallBack)
``` ```
#### Notification.addSlot(slot: NotificationSlot) ## Notification.addSlot(slot: NotificationSlot)
- 接口说明 - 接口说明
...@@ -475,9 +485,9 @@ Notification.addSlot(notificationSlot, addSlotCallBack) ...@@ -475,9 +485,9 @@ Notification.addSlot(notificationSlot, addSlotCallBack)
- addSlot参数描述 - addSlot参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ---------------- | ---- | ------------------------------------------ | | ---- | -------- | ---------------- | ---- | -------------------- |
| slot | 只读 | NotificationSlot | 是 | 要创建的通知通道，由{NotificationSlot}设置 | | slot | 只读 | NotificationSlot | 是 | 要创建的通知通道对象 |
- 返回值 - 返回值
...@@ -487,10 +497,9 @@ Notification.addSlot(notificationSlot, addSlotCallBack) ...@@ -487,10 +497,9 @@ Notification.addSlot(notificationSlot, addSlotCallBack)
```js ```js
//通知slot对象 //通知slot对象
var notificationSlot = { var notificationSlot = {
notificationId: 0, type: Notification.SlotType.SOCIAL_COMMUNICATION
type:SOCIAL_COMMUNICATION }
}
Notification.addSlot(notificationSlot).then((void) => { Notification.addSlot(notificationSlot).then((void) => {
console.info("==========================>addSlotCallback=======================>"); console.info("==========================>addSlotCallback=======================>");
}); });
...@@ -498,7 +507,7 @@ Notification.addSlot(notificationSlot).then((void) => { ...@@ -498,7 +507,7 @@ Notification.addSlot(notificationSlot).then((void) => {
#### Notification.addSlot(type: SlotType, callback: AsyncCallback\<void\>) ## Notification.addSlot(type: SlotType, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -511,15 +520,6 @@ Notification.addSlot(notificationSlot).then((void) => { ...@@ -511,15 +520,6 @@ Notification.addSlot(notificationSlot).then((void) => {
| type | 只读 | SlotType | 是 | 要创建的通知通道的类型 | | type | 只读 | SlotType | 是 | 要创建的通知通道的类型 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 | | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- SlotType类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------------- | -------- | -------- | ---- | -------- |
| SOCIAL_COMMUNICATION | 只读 | SlotType | 否 | 社交类型 |
| SERVICE_INFORMATION | 只读 | SlotType | 否 | 服务类型 |
| CONTENT_INFORMATION | 只读 | SlotType | 否 | 内容类型 |
| OTHER_TYPES | 只读 | SlotType | 否 | 其他类型 |
- 返回值 - 返回值
void void
...@@ -531,12 +531,12 @@ Notification.addSlot(notificationSlot).then((void) => { ...@@ -531,12 +531,12 @@ Notification.addSlot(notificationSlot).then((void) => {
function addSlotCallBack(err) { function addSlotCallBack(err) {
console.info("==========================>addSlotCallBack=======================>"); console.info("==========================>addSlotCallBack=======================>");
} }
Notification.addSlot(SOCIAL_COMMUNICATION, addSlotCallBack) Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack)
``` ```
#### Notification.addSlot(type: SlotType) ## Notification.addSlot(type: SlotType)
- 接口说明 - 接口说明
...@@ -555,14 +555,14 @@ Notification.addSlot(SOCIAL_COMMUNICATION, addSlotCallBack) ...@@ -555,14 +555,14 @@ Notification.addSlot(SOCIAL_COMMUNICATION, addSlotCallBack)
- 示例 - 示例
```js ```js
Notification.addSlot(SOCIAL_COMMUNICATION).then((void) => { Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION).then((void) => {
console.info("==========================>addSlotCallback=======================>"); console.info("==========================>addSlotCallback=======================>");
}); });
``` ```
#### Notification.addSlots(slots: Array\<NotificationSlot\>, callback: AsyncCallback\<void\>) ## Notification.addSlots(slots: Array\<NotificationSlot\>, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -570,10 +570,10 @@ Notification.addSlot(SOCIAL_COMMUNICATION).then((void) => { ...@@ -570,10 +570,10 @@ Notification.addSlot(SOCIAL_COMMUNICATION).then((void) => {
- addSlots数描述 - addSlots数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------- | ---- | ------------------------------------------ | | -------- | -------- | ------------------------- | ---- | ------------------------ |
| slots | 只读 | Array\<NotificationSlot\> | 是 | 要创建的通知通道，由{NotificationSlot}设置 | | slots | 只读 | Array\<NotificationSlot\> | 是 | 要创建的通知通道对象数组 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 | | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- 返回值 - 返回值
...@@ -588,8 +588,7 @@ function addSlotsCallBack(err) { ...@@ -588,8 +588,7 @@ function addSlotsCallBack(err) {
} }
//通知slot对象 //通知slot对象
var notificationSlot = { var notificationSlot = {
notificationId: 0, type: Notification.SlotType.SOCIAL_COMMUNICATION
type:SOCIAL_COMMUNICATION
} }
//通知slot array 对象 //通知slot array 对象
var notificationSlotArray = new Array(); var notificationSlotArray = new Array();
...@@ -600,7 +599,7 @@ Notification.addSlots(notificationSlotArray, addSlotsCallBack) ...@@ -600,7 +599,7 @@ Notification.addSlots(notificationSlotArray, addSlotsCallBack)
#### Notification.addSlots(slots: Array\<NotificationSlot\>) ## Notification.addSlots(slots: Array\<NotificationSlot\>)
- 接口说明 - 接口说明
...@@ -608,9 +607,9 @@ Notification.addSlots(notificationSlotArray, addSlotsCallBack) ...@@ -608,9 +607,9 @@ Notification.addSlots(notificationSlotArray, addSlotsCallBack)
- addSlots数描述 - addSlots数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----- | -------- | ------------------------- | ---- | ------------------------------------------ | | ----- | -------- | ------------------------- | ---- | ------------------------ |
| slots | 只读 | Array\<NotificationSlot\> | 是 | 要创建的通知通道，由{NotificationSlot}设置 | | slots | 只读 | Array\<NotificationSlot\> | 是 | 要创建的通知通道对象数组 |
- 返回值 - 返回值
...@@ -621,8 +620,7 @@ Notification.addSlots(notificationSlotArray, addSlotsCallBack) ...@@ -621,8 +620,7 @@ Notification.addSlots(notificationSlotArray, addSlotsCallBack)
```js ```js
//通知slot对象 //通知slot对象
var notificationSlot = { var notificationSlot = {
notificationId: 0, type: Notification.SlotType.SOCIAL_COMMUNICATION
type:SOCIAL_COMMUNICATION
} }
//通知slot array 对象 //通知slot array 对象
var notificationSlotArray = new Array(); var notificationSlotArray = new Array();
...@@ -635,7 +633,7 @@ Notification.addSlots(notificationSlotArray).then((void) => { ...@@ -635,7 +633,7 @@ Notification.addSlots(notificationSlotArray).then((void) => {
#### Notification.getSlot(slotType: SlotType, callback: AsyncCallback\<NotificationSlot\>) ## Notification.getSlot(slotType: SlotType, callback: AsyncCallback\<NotificationSlot\>)
- 接口说明 - 接口说明
...@@ -659,13 +657,13 @@ Notification.addSlots(notificationSlotArray).then((void) => { ...@@ -659,13 +657,13 @@ Notification.addSlots(notificationSlotArray).then((void) => {
function getSlotCallback(err,data) { function getSlotCallback(err,data) {
console.info("==========================>getSlotCallback=======================>"); console.info("==========================>getSlotCallback=======================>");
} }
var slotType = SOCIAL_COMMUNICATION; var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.getSlot(slotType, getSlotCallback) Notification.getSlot(slotType, getSlotCallback)
``` ```
#### Notification.getSlot(slotType) ## Notification.getSlot(slotType)
- 接口说明 - 接口说明
...@@ -684,14 +682,15 @@ Notification.getSlot(slotType, getSlotCallback) ...@@ -684,14 +682,15 @@ Notification.getSlot(slotType, getSlotCallback)
- 示例 - 示例
```js ```js
var slotType = SOCIAL_COMMUNICATION; var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.getSlot(slotType).then((data) => { Notification.getSlot(slotType).then((data) => {
console.info("==========================>getSlotCallback=======================>"); console.info("==========================>getSlotCallback=======================>");
});
``` ```
#### Notification.getSlots(callback: AsyncCallback<Array\<NotificationSlot\>>) ## Notification.getSlots(callback: AsyncCallback<Array\<NotificationSlot\>>)
- 接口说明 - 接口说明
...@@ -719,7 +718,7 @@ Notification.getSlots(getSlotsCallback) ...@@ -719,7 +718,7 @@ Notification.getSlots(getSlotsCallback)
#### Notification.getSlots() ## Notification.getSlots()
- 接口说明 - 接口说明
...@@ -738,11 +737,12 @@ Notification.getSlots(getSlotsCallback) ...@@ -738,11 +737,12 @@ Notification.getSlots(getSlotsCallback)
```js ```js
Notification.getSlots().then((data) => { Notification.getSlots().then((data) => {
console.info("==========================>getSlotsCallback=======================>"); console.info("==========================>getSlotsCallback=======================>");
});
``` ```
#### Notification.removeSlot(slotType: SlotType, callback: AsyncCallback\<void\>) ## Notification.removeSlot(slotType: SlotType, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -766,13 +766,13 @@ Notification.getSlots().then((data) => { ...@@ -766,13 +766,13 @@ Notification.getSlots().then((data) => {
function removeSlotCallback(err) { function removeSlotCallback(err) {
console.info("==========================>removeSlotCallback=======================>"); console.info("==========================>removeSlotCallback=======================>");
} }
var slotType = SOCIAL_COMMUNICATION; var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.removeSlot(slotType,removeSlotCallback) Notification.removeSlot(slotType,removeSlotCallback)
``` ```
#### Notification.removeSlot(slotType: SlotType) ## Notification.removeSlot(slotType: SlotType)
- 接口说明 - 接口说明
...@@ -791,14 +791,15 @@ Notification.removeSlot(slotType,removeSlotCallback) ...@@ -791,14 +791,15 @@ Notification.removeSlot(slotType,removeSlotCallback)
- 示例 - 示例
```js ```js
var slotType = SOCIAL_COMMUNICATION; var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.removeSlot(slotType).then((void) => { Notification.removeSlot(slotType).then((void) => {
console.info("==========================>removeSlotCallback=======================>"); console.info("==========================>removeSlotCallback=======================>");
});
``` ```
#### Notification.removeAllSlots(callback: AsyncCallback\<void\>) ## Notification.removeAllSlots(callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -825,7 +826,7 @@ Notification.removeAllSlots(removeAllCallBack) ...@@ -825,7 +826,7 @@ Notification.removeAllSlots(removeAllCallBack)
#### Notification.removeAllSlots() ## Notification.removeAllSlots()
- 接口说明 - 接口说明
...@@ -849,7 +850,7 @@ Notification.removeAllSlots().then((void) => { ...@@ -849,7 +850,7 @@ Notification.removeAllSlots().then((void) => {
#### Notification.subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback\<void\>) ## Notification.subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -873,7 +874,6 @@ Notification.removeAllSlots().then((void) => { ...@@ -873,7 +874,6 @@ Notification.removeAllSlots().then((void) => {
| onConnect?:() | 读、写 | function | 否 | 注册订阅回调函数 | | onConnect?:() | 读、写 | function | 否 | 注册订阅回调函数 |
| onDisconnect?:() | 读、写 | function | 否 | 取消订阅回调函数 | | onDisconnect?:() | 读、写 | function | 否 | 取消订阅回调函数 |
| onDestroy?:() | 读、写 | function | 否 | 服务失联回调函数 | | onDestroy?:() | 读、写 | function | 否 | 服务失联回调函数 |
| onDisturbModeChange?:(mode: notification.DoNotDisturbMode) | 读、写 | function | 否 | 免打扰模式变更回调函数 |
| onDoNotDisturbDateChange?:(mode: notification.DoNotDisturbDate) | 读、写 | function | 否 | 免打扰时间选项变更回调函数 | | onDoNotDisturbDateChange?:(mode: notification.DoNotDisturbDate) | 读、写 | function | 否 | 免打扰时间选项变更回调函数 |
- SubscribeCallbackData 类型说明 - SubscribeCallbackData 类型说明
...@@ -901,15 +901,6 @@ Notification.removeAllSlots().then((void) => { ...@@ -901,15 +901,6 @@ Notification.removeAllSlots().then((void) => {
| hashCode | 只读 | string | 是 | 通知唯一标识 | | hashCode | 只读 | string | 是 | 通知唯一标识 |
| ranking | 只读 | number | 是 | 通知排序序号 | | ranking | 只读 | number | 是 | 通知排序序号 |
- DoNotDisturbMode类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | ---------------- | ---- | ---------------------------- |
| ALLOW_ALL | 只读 | DoNotDisturbMode | 否 | 全部绕过免打扰 |
| ALLOW_PRIORITY | 只读 | DoNotDisturbMode | 否 | 指定优先级通知可以绕过免打扰 |
| ALLOW_NONE | 只读 | DoNotDisturbMode | 否 | 全部免打扰 |
| ALLOW_ALARMS | 只读 | DoNotDisturbMode | 否 | 闹钟类型通知可以绕过免打扰 |
- DoNotDisturbType类型说明 - DoNotDisturbType类型说明
...@@ -950,17 +941,17 @@ function onConsumeCallback(err, data) { ...@@ -950,17 +941,17 @@ function onConsumeCallback(err, data) {
console.info("==========================>onConsumeCallback=======================>"); console.info("==========================>onConsumeCallback=======================>");
} }
var subscriber = { var subscriber = {
onConsume:onConsumeCallback; onConsume: onConsumeCallback
} }
var info = { var info = {
bundleNames:["bundleName1","bundleName2"] bundleNames: ["bundleName1","bundleName2"]
} }
Notification.subscribe(subscriber, info, subscribeCallback); Notification.subscribe(subscriber, info, subscribeCallback);
``` ```
#### Notification.subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>) ## Notification.subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -987,14 +978,14 @@ function onConsumeCallback(err, data) { ...@@ -987,14 +978,14 @@ function onConsumeCallback(err, data) {
console.info("==========================>onConsumeCallback=======================>"); console.info("==========================>onConsumeCallback=======================>");
} }
var subscriber = { var subscriber = {
onConsume:onConsumeCallback; onConsume: onConsumeCallback
} }
Notification.subscribe(subscriber, subscribeCallback); Notification.subscribe(subscriber, subscribeCallback);
``` ```
#### Notification.subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo) ## Notification.subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo)
- 接口说明 - 接口说明
...@@ -1018,7 +1009,7 @@ function onConsumeCallback(err, data) { ...@@ -1018,7 +1009,7 @@ function onConsumeCallback(err, data) {
console.info("==========================>onConsumeCallback=======================>"); console.info("==========================>onConsumeCallback=======================>");
} }
var subscriber = { var subscriber = {
onConsume:onConsumeCallback; onConsume: onConsumeCallback
}; };
Notification.subscribe(subscriber).then((void) => { Notification.subscribe(subscriber).then((void) => {
console.info("==========================>subscribeCallback=======================>"); console.info("==========================>subscribeCallback=======================>");
...@@ -1027,7 +1018,7 @@ Notification.subscribe(subscriber).then((void) => { ...@@ -1027,7 +1018,7 @@ Notification.subscribe(subscriber).then((void) => {
#### Notification.unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>) ## Notification.unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -1054,14 +1045,14 @@ function onConsumeCallback(err, data) { ...@@ -1054,14 +1045,14 @@ function onConsumeCallback(err, data) {
console.info("==========================>onConsumeCallback=======================>"); console.info("==========================>onConsumeCallback=======================>");
} }
var subscriber = { var subscriber = {
onConsume:onConsumeCallback; onConsume: onConsumeCallback
} }
Notification.unsubscribe(subscriber, unsubscribeCallback); Notification.unsubscribe(subscriber, unsubscribeCallback);
``` ```
#### Notification.unsubscribe(subscriber: NotificationSubscriber) ## Notification.unsubscribe(subscriber: NotificationSubscriber)
- 接口说明 - 接口说明
...@@ -1084,7 +1075,7 @@ function onConsumeCallback(err, data) { ...@@ -1084,7 +1075,7 @@ function onConsumeCallback(err, data) {
console.info("==========================>onConsumeCallback=======================>"); console.info("==========================>onConsumeCallback=======================>");
} }
var subscriber = { var subscriber = {
onConsume:onConsumeCallback; onConsume: onConsumeCallback
}; };
Notification.unsubscribe(subscriber).then((void) => { Notification.unsubscribe(subscriber).then((void) => {
console.info("==========================>unsubscribeCallback=======================>"); console.info("==========================>unsubscribeCallback=======================>");
...@@ -1093,7 +1084,7 @@ Notification.unsubscribe(subscriber).then((void) => { ...@@ -1093,7 +1084,7 @@ Notification.unsubscribe(subscriber).then((void) => {
#### Notification.enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>) ## Notification.enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -1124,14 +1115,14 @@ function enableNotificationCallback(err) { ...@@ -1124,14 +1115,14 @@ function enableNotificationCallback(err) {
console.info("==========================>enableNotificationCallback=======================>"); console.info("==========================>enableNotificationCallback=======================>");
} }
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
Notification.enableNotification(bundle, false, enableNotificationCallback); Notification.enableNotification(bundle, false, enableNotificationCallback);
``` ```
#### Notification.enableNotification(bundle: BundleOption, enable: boolean) ## Notification.enableNotification(bundle: BundleOption, enable: boolean)
- 接口说明 - 接口说明
...@@ -1152,7 +1143,7 @@ Notification.enableNotification(bundle, false, enableNotificationCallback); ...@@ -1152,7 +1143,7 @@ Notification.enableNotification(bundle, false, enableNotificationCallback);
```js ```js
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
Notification.enableNotification(bundle, false).then((void) => { Notification.enableNotification(bundle, false).then((void) => {
console.info("==========================>enableNotificationCallback=======================>"); console.info("==========================>enableNotificationCallback=======================>");
...@@ -1161,7 +1152,7 @@ Notification.enableNotification(bundle, false).then((void) => { ...@@ -1161,7 +1152,7 @@ Notification.enableNotification(bundle, false).then((void) => {
#### Notification.isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean\>) ## Notification.isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean\>)
- 接口说明 - 接口说明
...@@ -1185,14 +1176,14 @@ function isNotificationEnabledCallback(err, data) { ...@@ -1185,14 +1176,14 @@ function isNotificationEnabledCallback(err, data) {
console.info("==========================>isNotificationEnabledCallback=======================>"); console.info("==========================>isNotificationEnabledCallback=======================>");
} }
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
Notification.isNotificationEnabled(bundle, isNotificationEnabledCallback); Notification.isNotificationEnabled(bundle, isNotificationEnabledCallback);
``` ```
#### Notification.isNotificationEnabled(bundle: BundleOption) ## Notification.isNotificationEnabled(bundle: BundleOption)
- 接口说明 - 接口说明
...@@ -1212,7 +1203,7 @@ Notification.isNotificationEnabled(bundle, isNotificationEnabledCallback); ...@@ -1212,7 +1203,7 @@ Notification.isNotificationEnabled(bundle, isNotificationEnabledCallback);
```js ```js
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
Notification.isNotificationEnabled(bundle).then((data) => { Notification.isNotificationEnabled(bundle).then((data) => {
console.info("==========================>isNotificationEnabledCallback=======================>"); console.info("==========================>isNotificationEnabledCallback=======================>");
...@@ -1221,7 +1212,7 @@ Notification.isNotificationEnabled(bundle).then((data) => { ...@@ -1221,7 +1212,7 @@ Notification.isNotificationEnabled(bundle).then((data) => {
#### Notification.isNotificationEnabled(callback: AsyncCallback\<boolean\>) ## Notification.isNotificationEnabled(callback: AsyncCallback\<boolean\>)
- 接口说明 - 接口说明
...@@ -1249,7 +1240,7 @@ Notification.isNotificationEnabled(isNotificationEnabledCallback); ...@@ -1249,7 +1240,7 @@ Notification.isNotificationEnabled(isNotificationEnabledCallback);
#### Notification.isNotificationEnabled() ## Notification.isNotificationEnabled()
- 接口说明 - 接口说明
...@@ -1275,7 +1266,7 @@ Notification.isNotificationEnabled().then((data) => { ...@@ -1275,7 +1266,7 @@ Notification.isNotificationEnabled().then((data) => {
#### Notification.displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>) ## Notification.displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -1300,14 +1291,14 @@ function displayBadgeCallback(err) { ...@@ -1300,14 +1291,14 @@ function displayBadgeCallback(err) {
console.info("==========================>displayBadgeCallback=======================>"); console.info("==========================>displayBadgeCallback=======================>");
} }
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
Notification.displayBadge(bundle, false, displayBadgeCallback); Notification.displayBadge(bundle, false, displayBadgeCallback);
``` ```
#### Notification.displayBadge(bundle: BundleOption, enable: boolean) ## Notification.displayBadge(bundle: BundleOption, enable: boolean)
- 接口说明 - 接口说明
...@@ -1328,7 +1319,7 @@ Notification.displayBadge(bundle, false, displayBadgeCallback); ...@@ -1328,7 +1319,7 @@ Notification.displayBadge(bundle, false, displayBadgeCallback);
```js ```js
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
Notification.displayBadge(bundle, false).then((void) => { Notification.displayBadge(bundle, false).then((void) => {
console.info("==========================>displayBadgeCallback=======================>"); console.info("==========================>displayBadgeCallback=======================>");
...@@ -1337,7 +1328,7 @@ Notification.displayBadge(bundle, false).then((void) => { ...@@ -1337,7 +1328,7 @@ Notification.displayBadge(bundle, false).then((void) => {
#### Notification.isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>) ## Notification.isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>)
- 接口说明 - 接口说明
...@@ -1361,14 +1352,14 @@ function isBadgeDisplayedCallback(err, data) { ...@@ -1361,14 +1352,14 @@ function isBadgeDisplayedCallback(err, data) {
console.info("==========================>isBadgeDisplayedCallback=======================>"); console.info("==========================>isBadgeDisplayedCallback=======================>");
} }
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
Notification.isBadgeDisplayed(bundle, isBadgeDisplayedCallback); Notification.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
``` ```
#### Notification.isBadgeDisplayed(bundle: BundleOption) ## Notification.isBadgeDisplayed(bundle: BundleOption)
- 接口说明 - 接口说明
...@@ -1388,7 +1379,7 @@ Notification.isBadgeDisplayed(bundle, isBadgeDisplayedCallback); ...@@ -1388,7 +1379,7 @@ Notification.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
```js ```js
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
Notification.isBadgeDisplayed(bundle).then((data) => { Notification.isBadgeDisplayed(bundle).then((data) => {
console.info("==========================>isBadgeDisplayedCallback=======================>"); console.info("==========================>isBadgeDisplayedCallback=======================>");
...@@ -1397,7 +1388,7 @@ Notification.isBadgeDisplayed(bundle).then((data) => { ...@@ -1397,7 +1388,7 @@ Notification.isBadgeDisplayed(bundle).then((data) => {
#### Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback\<void\>) ## Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -1422,17 +1413,17 @@ function setSlotByBundleCallback(err) { ...@@ -1422,17 +1413,17 @@ function setSlotByBundleCallback(err) {
console.info("==========================>setSlotByBundleCallback=======================>"); console.info("==========================>setSlotByBundleCallback=======================>");
} }
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
var notificationSlot = { var notificationSlot = {
type:SOCIAL_COMMUNICATION type: Notification.SlotType.SOCIAL_COMMUNICATION
} }
Notification.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback); Notification.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
``` ```
#### Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot) ## Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot)
- 接口说明 - 接口说明
...@@ -1453,10 +1444,10 @@ Notification.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback); ...@@ -1453,10 +1444,10 @@ Notification.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
```js ```js
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
var notificationSlot = { var notificationSlot = {
type:SOCIAL_COMMUNICATION type: Notification.SlotType.SOCIAL_COMMUNICATION
} }
Notification.displayBadge(bundle, notificationSlot).then((void) => { Notification.displayBadge(bundle, notificationSlot).then((void) => {
console.info("==========================>setSlotByBundleCallback=======================>"); console.info("==========================>setSlotByBundleCallback=======================>");
...@@ -1465,7 +1456,7 @@ Notification.displayBadge(bundle, notificationSlot).then((void) => { ...@@ -1465,7 +1456,7 @@ Notification.displayBadge(bundle, notificationSlot).then((void) => {
#### Notification.getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array\<NotificationSlot\>>) ## Notification.getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array\<NotificationSlot\>>)
- 接口说明 - 接口说明
...@@ -1489,14 +1480,14 @@ function getSlotsByBundleCallback(err, data) { ...@@ -1489,14 +1480,14 @@ function getSlotsByBundleCallback(err, data) {
console.info("==========================>getSlotsByBundleCallback=======================>"); console.info("==========================>getSlotsByBundleCallback=======================>");
} }
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
Notification.getSlotsByBundle(bundle, getSlotsByBundleCallback); Notification.getSlotsByBundle(bundle, getSlotsByBundleCallback);
``` ```
#### Notification.getSlotsByBundle(bundle: BundleOption) ## Notification.getSlotsByBundle(bundle: BundleOption)
- 接口说明 - 接口说明
...@@ -1516,7 +1507,7 @@ Notification.getSlotsByBundle(bundle, getSlotsByBundleCallback); ...@@ -1516,7 +1507,7 @@ Notification.getSlotsByBundle(bundle, getSlotsByBundleCallback);
```js ```js
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
Notification.getSlotsByBundle(bundle).then((data) => { Notification.getSlotsByBundle(bundle).then((data) => {
console.info("==========================>getSlotsByBundleCallback=======================>"); console.info("==========================>getSlotsByBundleCallback=======================>");
...@@ -1525,7 +1516,7 @@ Notification.getSlotsByBundle(bundle).then((data) => { ...@@ -1525,7 +1516,7 @@ Notification.getSlotsByBundle(bundle).then((data) => {
#### Notification.getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\<number\>) ## Notification.getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\<number\>)
- 接口说明 - 接口说明
...@@ -1549,14 +1540,14 @@ function getSlotNumByBundle(err, data) { ...@@ -1549,14 +1540,14 @@ function getSlotNumByBundle(err, data) {
console.info("==========================>getSlotNumByBundleCallback=======================>"); console.info("==========================>getSlotNumByBundleCallback=======================>");
} }
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
Notification.getSlotNumByBundle(bundle, getSlotNumByBundleCallback); Notification.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
``` ```
#### Notification.getSlotNumByBundle(bundle: BundleOption) ## Notification.getSlotNumByBundle(bundle: BundleOption)
- 接口说明 - 接口说明
...@@ -1576,7 +1567,7 @@ Notification.getSlotNumByBundle(bundle, getSlotNumByBundleCallback); ...@@ -1576,7 +1567,7 @@ Notification.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
```js ```js
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
Notification.getSlotNumByBundle(bundle).then((data) => { Notification.getSlotNumByBundle(bundle).then((data) => {
console.info("==========================>getSlotNumByBundleCallback=======================>"); console.info("==========================>getSlotNumByBundleCallback=======================>");
...@@ -1585,7 +1576,7 @@ Notification.getSlotNumByBundle(bundle).then((data) => { ...@@ -1585,7 +1576,7 @@ Notification.getSlotNumByBundle(bundle).then((data) => {
#### Notification.remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback\<void\>) ## Notification.remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -1617,18 +1608,18 @@ function removeCallback(err) { ...@@ -1617,18 +1608,18 @@ function removeCallback(err) {
console.info("==========================>removeCallback=======================>"); console.info("==========================>removeCallback=======================>");
} }
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
var notificationKey = { var notificationKey = {
id:0; id: 0;
label:"label"; label: "label";
} }
Notification.remove(bundle, notificationKey, removeCallback); Notification.remove(bundle, notificationKey, removeCallback);
``` ```
#### Notification.remove(bundle: BundleOption, notificationKey: NotificationKey) ## Notification.remove(bundle: BundleOption, notificationKey: NotificationKey)
- 接口说明 - 接口说明
...@@ -1649,11 +1640,11 @@ Notification.remove(bundle, notificationKey, removeCallback); ...@@ -1649,11 +1640,11 @@ Notification.remove(bundle, notificationKey, removeCallback);
```js ```js
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
var notificationKey = { var notificationKey = {
id:0; id: 0;
label:"label"; label: "label";
} }
Notification.remove(bundle, notificationKey).then((void) => { Notification.remove(bundle, notificationKey).then((void) => {
console.info("==========================>removeCallback=======================>"); console.info("==========================>removeCallback=======================>");
...@@ -1662,7 +1653,7 @@ Notification.remove(bundle, notificationKey).then((void) => { ...@@ -1662,7 +1653,7 @@ Notification.remove(bundle, notificationKey).then((void) => {
#### Notification.remove(hashCode: string, callback: AsyncCallback\<void\>) ## Notification.remove(hashCode: string, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -1691,7 +1682,7 @@ Notification.remove(hashCode, removeCallback); ...@@ -1691,7 +1682,7 @@ Notification.remove(hashCode, removeCallback);
#### Notification.remove(hashCode: string) ## Notification.remove(hashCode: string)
- 接口说明 - 接口说明
...@@ -1717,7 +1708,7 @@ Notification.remove(hashCode).then((void) => { ...@@ -1717,7 +1708,7 @@ Notification.remove(hashCode).then((void) => {
#### Notification.removeAll(bundle: BundleOption, callback: AsyncCallback\<void\>) ## Notification.removeAll(bundle: BundleOption, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -1741,14 +1732,14 @@ function removeAllCallback(err) { ...@@ -1741,14 +1732,14 @@ function removeAllCallback(err) {
console.info("==========================>removeAllCallback=======================>"); console.info("==========================>removeAllCallback=======================>");
} }
var bundle = { var bundle = {
bundle:"bundleName1"; bundle: "bundleName1";
} }
Notification.removeAll(bundle, removeAllCallback); Notification.removeAll(bundle, removeAllCallback);
``` ```
#### Notification.removeAll(callback: AsyncCallback\<void\>) ## Notification.removeAll(callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -1776,7 +1767,7 @@ Notification.removeAll(removeAllCallback); ...@@ -1776,7 +1767,7 @@ Notification.removeAll(removeAllCallback);
#### Notification.removeAll(bundle?: BundleOption) ## Notification.removeAll(bundle?: BundleOption)
- 接口说明 - 接口说明
...@@ -1802,7 +1793,7 @@ Notification.removeAll().then((void) => { ...@@ -1802,7 +1793,7 @@ Notification.removeAll().then((void) => {
#### Notification.getAllActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>) ## Notification.getAllActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>)
- 接口说明 - 接口说明
...@@ -1830,7 +1821,7 @@ Notification.getAllActiveNotifications(getAllActiveNotificationsCallback); ...@@ -1830,7 +1821,7 @@ Notification.getAllActiveNotifications(getAllActiveNotificationsCallback);
#### Notification.getAllActiveNotifications() ## Notification.getAllActiveNotifications()
- 接口说明 - 接口说明
...@@ -1854,7 +1845,7 @@ Notification.getAllActiveNotifications().then((data) => { ...@@ -1854,7 +1845,7 @@ Notification.getAllActiveNotifications().then((data) => {
#### Notification.getActiveNotificationCount(callback: AsyncCallback\<number\>) ## Notification.getActiveNotificationCount(callback: AsyncCallback\<number\>)
- 接口说明 - 接口说明
...@@ -1882,7 +1873,7 @@ Notification.getActiveNotificationCount(getActiveNotificationCountCallback); ...@@ -1882,7 +1873,7 @@ Notification.getActiveNotificationCount(getActiveNotificationCountCallback);
#### Notification.getActiveNotificationCount() ## Notification.getActiveNotificationCount()
- 接口说明 - 接口说明
...@@ -1906,7 +1897,7 @@ Notification.getActiveNotificationCount().then((data) => { ...@@ -1906,7 +1897,7 @@ Notification.getActiveNotificationCount().then((data) => {
#### Notification.getActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>) ## Notification.getActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>)
- 接口说明 - 接口说明
...@@ -1934,7 +1925,7 @@ Notification.getActiveNotifications(getActiveNotificationsCallback); ...@@ -1934,7 +1925,7 @@ Notification.getActiveNotifications(getActiveNotificationsCallback);
#### Notification.getActiveNotifications() ## Notification.getActiveNotifications()
- 接口说明 - 接口说明
...@@ -1958,7 +1949,7 @@ Notification.getActiveNotifications().then((data) => { ...@@ -1958,7 +1949,7 @@ Notification.getActiveNotifications().then((data) => {
#### Notification.cancelGroup(groupName: string, callback: AsyncCallback\<void\>) ## Notification.cancelGroup(groupName: string, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -1989,7 +1980,7 @@ Notification.cancelGroup(groupName, cancelGroupCallback); ...@@ -1989,7 +1980,7 @@ Notification.cancelGroup(groupName, cancelGroupCallback);
#### Notification.cancelGroup(groupName: string) ## Notification.cancelGroup(groupName: string)
- 接口说明 - 接口说明
...@@ -2016,7 +2007,7 @@ Notification.cancelGroup(groupName).then(() => { ...@@ -2016,7 +2007,7 @@ Notification.cancelGroup(groupName).then(() => {
#### Notification.removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback\<void\>) ## Notification.removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -2041,7 +2032,7 @@ function removeGroupByBundleCallback(err) { ...@@ -2041,7 +2032,7 @@ function removeGroupByBundleCallback(err) {
console.info("==========================>removeGroupByBundleCallback=======================>"); console.info("==========================>removeGroupByBundleCallback=======================>");
} }
var bundleOption = {bundle:"Bundle"}; var bundleOption = {bundle: "Bundle"};
var groupName = "GroupName"; var groupName = "GroupName";
Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback); Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
...@@ -2049,7 +2040,7 @@ Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCal ...@@ -2049,7 +2040,7 @@ Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCal
#### Notification.removeGroupByBundle(bundle: BundleOption, groupName: string) ## Notification.removeGroupByBundle(bundle: BundleOption, groupName: string)
- 接口说明 - 接口说明
...@@ -2069,7 +2060,7 @@ Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCal ...@@ -2069,7 +2060,7 @@ Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCal
- 示例 - 示例
```js ```js
var bundleOption = {bundle:"Bundle"}; var bundleOption = {bundle: "Bundle"};
var groupName = "GroupName"; var groupName = "GroupName";
Notification.removeGroupByBundle(bundleOption, groupName).then(() => { Notification.removeGroupByBundle(bundleOption, groupName).then(() => {
console.info("==========================>removeGroupByBundlePromise=======================>"); console.info("==========================>removeGroupByBundlePromise=======================>");
...@@ -2078,7 +2069,7 @@ Notification.removeGroupByBundle(bundleOption, groupName).then(() => { ...@@ -2078,7 +2069,7 @@ Notification.removeGroupByBundle(bundleOption, groupName).then(() => {
#### Notification.setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\<void\>) ## Notification.setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -2103,9 +2094,9 @@ function setDoNotDisturbDateCallback(err) { ...@@ -2103,9 +2094,9 @@ function setDoNotDisturbDateCallback(err) {
} }
var doNotDisturbDate = { var doNotDisturbDate = {
type : notification.DoNotDisturbType.TYPE_ONCE, type: notification.DoNotDisturbType.TYPE_ONCE,
begin : new Date(), begin: new Date(),
end : new Date(2021, 11, 15, 18, 0) end: new Date(2021, 11, 15, 18, 0)
} }
Notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback); Notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);
...@@ -2113,7 +2104,7 @@ Notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback); ...@@ -2113,7 +2104,7 @@ Notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);
#### Notification.setDoNotDisturbDate(date: DoNotDisturbDate) ## Notification.setDoNotDisturbDate(date: DoNotDisturbDate)
- 接口说明 - 接口说明
...@@ -2133,9 +2124,9 @@ Notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback); ...@@ -2133,9 +2124,9 @@ Notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);
```js ```js
var doNotDisturbDate = { var doNotDisturbDate = {
type : notification.DoNotDisturbType.TYPE_ONCE, type: notification.DoNotDisturbType.TYPE_ONCE,
begin : new Date(), begin: new Date(),
end : new Date(2021, 11, 15, 18, 0) end: new Date(2021, 11, 15, 18, 0)
} }
Notification.setDoNotDisturbDate(doNotDisturbDate).then(() => { Notification.setDoNotDisturbDate(doNotDisturbDate).then(() => {
console.info("==========================>setDoNotDisturbDatePromise=======================>"); console.info("==========================>setDoNotDisturbDatePromise=======================>");
...@@ -2144,7 +2135,7 @@ Notification.setDoNotDisturbDate(doNotDisturbDate).then(() => { ...@@ -2144,7 +2135,7 @@ Notification.setDoNotDisturbDate(doNotDisturbDate).then(() => {
#### Notification.getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>) ## Notification.getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>)
- 接口说明 - 接口说明
...@@ -2172,7 +2163,7 @@ Notification.getDoNotDisturbDate(getDoNotDisturbDateCallback); ...@@ -2172,7 +2163,7 @@ Notification.getDoNotDisturbDate(getDoNotDisturbDateCallback);
#### Notification.getDoNotDisturbDate() ## Notification.getDoNotDisturbDate()
- 接口说明 - 接口说明
...@@ -2196,7 +2187,7 @@ Notification.getDoNotDisturbDate().then((data) => { ...@@ -2196,7 +2187,7 @@ Notification.getDoNotDisturbDate().then((data) => {
#### Notification.supportDoNotDisturbMode(callback: AsyncCallback\<boolean\>) ## Notification.supportDoNotDisturbMode(callback: AsyncCallback\<boolean\>)
- 接口说明 - 接口说明
...@@ -2224,7 +2215,7 @@ Notification.supportDoNotDisturbMode(supportDoNotDisturbModeCallback); ...@@ -2224,7 +2215,7 @@ Notification.supportDoNotDisturbMode(supportDoNotDisturbModeCallback);
#### Notification.supportDoNotDisturbMode() ## Notification.supportDoNotDisturbMode()
- 接口说明 - 接口说明
...@@ -2248,15 +2239,15 @@ Notification.supportDoNotDisturbMode().then((data) => { ...@@ -2248,15 +2239,15 @@ Notification.supportDoNotDisturbMode().then((data) => {
#### WantAgent接口 ## WantAgent接口
#### 导入模块 ## 导入模块
```js ```js
import WantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
``` ```
#### WantAgent.getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>) ## WantAgent.getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>)
- 接口说明 - 接口说明
...@@ -2291,11 +2282,6 @@ import WantAgent from '@ohos.wantAgent'; ...@@ -2291,11 +2282,6 @@ import WantAgent from '@ohos.wantAgent';
| CANCEL_PRESENT_FLAG | 只读 | enum | 否 | 在生成一个新的WantAgent对象前取消已存在的一个WantAgent对象 | | CANCEL_PRESENT_FLAG | 只读 | enum | 否 | 在生成一个新的WantAgent对象前取消已存在的一个WantAgent对象 |
| UPDATE_PRESENT_FLAG | 只读 | enum | 否 | 使用新的WantAgent的额外数据替换已存在的WantAgent中的额外数据 | | UPDATE_PRESENT_FLAG | 只读 | enum | 否 | 使用新的WantAgent的额外数据替换已存在的WantAgent中的额外数据 |
| CONSTANT_FLAG | 只读 | enum | 否 | WantAgent是不可变的 | | CONSTANT_FLAG | 只读 | enum | 否 | WantAgent是不可变的 |
| REPLACE_ELEMENT | 只读 | enum | 否 | 当前Want中的element属性可被WantAgent.trigger()中Want的element属性取代 |
| REPLACE_ACTION | 只读 | enum | 否 | 当前Want中的action属性可被WantAgent.trigger()中Want的action属性取代 |
| REPLACE_URI | 只读 | enum | 否 | 当前Want中的uri属性可被WantAgent.trigger()中Want的uri属性取代 |
| REPLACE_ENTITIES | 只读 | enum | 否 | 当前Want中的entities属性可被WantAgent.trigger()中Want的entities属性取代 |
| REPLACE_BUNDLE | 只读 | enum | 否 | 当前Want中的bundleName属性可被WantAgent.trigger()中Want的bundleName属性取代 |
- OperationType类型说明 - OperationType类型说明
...@@ -2314,8 +2300,8 @@ import WantAgent from '@ohos.wantAgent'; ...@@ -2314,8 +2300,8 @@ import WantAgent from '@ohos.wantAgent';
- 示例 - 示例
```js ```js
import wantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//getWantAgent回调 //getWantAgent回调
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
...@@ -2349,12 +2335,12 @@ var wantAgentInfo = { ...@@ -2349,12 +2335,12 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
``` ```
#### WantAgent.getWantAgent(info: WantAgentInfo): Promise\<WantAgent\> ## WantAgent.getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
- 接口说明 - 接口说明
...@@ -2374,8 +2360,8 @@ wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) ...@@ -2374,8 +2360,8 @@ wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
- 示例 - 示例
```js ```js
import wantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { var wantAgentInfo = {
...@@ -2405,14 +2391,14 @@ var wantAgentInfo = { ...@@ -2405,14 +2391,14 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); console.info("==========================>getWantAgentCallback=======================>");
}); });
``` ```
#### WantAgent.getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>) ## WantAgent.getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>)
- 接口说明 - 接口说明
...@@ -2433,17 +2419,17 @@ wantAgent.getWantAgent(wantAgentInfo).then((data) => { ...@@ -2433,17 +2419,17 @@ wantAgent.getWantAgent(wantAgentInfo).then((data) => {
- 示例 - 示例
```js ```js
import wantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象 //wantAgent对象
var WantAgent; var wantAgent;
//getWantAgent回调 //getWantAgent回调
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>"); console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) { if (err.code == 0) {
WantAgent = data; wantAgent = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.info('----getWantAgent failed!----');
} }
...@@ -2476,18 +2462,18 @@ var wantAgentInfo = { ...@@ -2476,18 +2462,18 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//getBundleName回调 //getBundleName回调
function getBundleNameCallback(err, data) { function getBundleNameCallback(err, data) {
console.info("==========================>getBundleNameCallback=======================>"); console.info("==========================>getBundleNameCallback=======================>");
} }
wantAgent.getBundleName(WantAgent, getBundleNameCallback) WantAgent.getBundleName(wantAgent, getBundleNameCallback)
``` ```
#### WantAgent.getBundleName(agent: WantAgent): Promise\<string\> ## WantAgent.getBundleName(agent: WantAgent): Promise\<string\>
- 接口说明 - 接口说明
...@@ -2507,11 +2493,11 @@ wantAgent.getBundleName(WantAgent, getBundleNameCallback) ...@@ -2507,11 +2493,11 @@ wantAgent.getBundleName(WantAgent, getBundleNameCallback)
- 示例 - 示例
```js ```js
import wantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象 //wantAgent对象
var WantAgent; var wantAgent;
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { var wantAgentInfo = {
...@@ -2541,19 +2527,19 @@ var wantAgentInfo = { ...@@ -2541,19 +2527,19 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); console.info("==========================>getWantAgentCallback=======================>");
WantAgent = data; wantAgent = data;
}); });
wantAgent.getBundleName(WantAgent).then((data) => { WantAgent.getBundleName(wantAgent).then((data) => {
console.info("==========================>getBundleNameCallback=======================>"); console.info("==========================>getBundleNameCallback=======================>");
}); });
``` ```
#### WantAgent.getUid(agent: WantAgent, callback: AsyncCallback\<number\>) ## WantAgent.getUid(agent: WantAgent, callback: AsyncCallback\<number\>)
- 接口说明 - 接口说明
...@@ -2574,17 +2560,17 @@ wantAgent.getBundleName(WantAgent).then((data) => { ...@@ -2574,17 +2560,17 @@ wantAgent.getBundleName(WantAgent).then((data) => {
- 示例 - 示例
```js ```js
import wantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象 //wantAgent对象
var WantAgent; var wantAgent;
//getWantAgent回调 //getWantAgent回调
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>"); console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) { if (err.code == 0) {
WantAgent = data; wantAgent = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.info('----getWantAgent failed!----');
} }
...@@ -2617,18 +2603,18 @@ var wantAgentInfo = { ...@@ -2617,18 +2603,18 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//getUid回调 //getUid回调
function getUidCallback(err, data) { function getUidCallback(err, data) {
console.info("==========================>getUidCallback=======================>"); console.info("==========================>getUidCallback=======================>");
} }
wantAgent.getUid(WantAgent, getUidCallback) WantAgent.getUid(wantAgent, getUidCallback)
``` ```
#### WantAgent.getUid(agent: WantAgent): Promise\<number\> ## WantAgent.getUid(agent: WantAgent): Promise\<number\>
- 接口说明 - 接口说明
...@@ -2648,11 +2634,11 @@ wantAgent.getUid(WantAgent, getUidCallback) ...@@ -2648,11 +2634,11 @@ wantAgent.getUid(WantAgent, getUidCallback)
- 示例 - 示例
```js ```js
import wantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象 //wantAgent对象
var WantAgent; var wantAgent;
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { var wantAgentInfo = {
...@@ -2682,19 +2668,19 @@ var wantAgentInfo = { ...@@ -2682,19 +2668,19 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); console.info("==========================>getWantAgentCallback=======================>");
WantAgent = data; wantAgent = data;
}); });
wantAgent.getUid(WantAgent).then((data) => { WantAgent.getUid(wantAgent).then((data) => {
console.info("==========================>getUidCallback=======================>"); console.info("==========================>getUidCallback=======================>");
}); });
``` ```
#### WantAgent.getWant(agent: WantAgent, callback: AsyncCallback\<Want\>) ## WantAgent.getWant(agent: WantAgent, callback: AsyncCallback\<Want\>)
- 接口说明 - 接口说明
...@@ -2715,17 +2701,17 @@ wantAgent.getUid(WantAgent).then((data) => { ...@@ -2715,17 +2701,17 @@ wantAgent.getUid(WantAgent).then((data) => {
- 示例 - 示例
```js ```js
import wantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象 //wantAgent对象
var WantAgent; var wantAgent;
//getWantAgent回调 //getWantAgent回调
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>"); console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) { if (err.code == 0) {
WantAgent = data; wantAgent = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.info('----getWantAgent failed!----');
} }
...@@ -2758,22 +2744,22 @@ var wantAgentInfo = { ...@@ -2758,22 +2744,22 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgentWantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentWantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//getWant回调 //getWant回调
function getWantCallback(err, data) { function getWantCallback(err, data) {
console.info("==========================>getWantCallback=======================>"); console.info("==========================>getWantCallback=======================>");
} }
wantAgent.getWant(WantAgent, getWantCallback) WantAgent.getWant(wantAgent, getWantCallback)
``` ```
#### WantAgent.getWant(agent: WantAgent): Promise\<Want\> ## WantAgent.getWant(agent: WantAgent): Promise\<Want\>
- 接口说明 - 接口说明
获取WantAgent对象的Uid（Promise形式） 获取WantAgent对象的want（Promise形式）
- getWant参数描述 - getWant参数描述
...@@ -2789,11 +2775,11 @@ wantAgent.getWant(WantAgent, getWantCallback) ...@@ -2789,11 +2775,11 @@ wantAgent.getWant(WantAgent, getWantCallback)
- 示例 - 示例
```js ```js
import wantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象 //wantAgent对象
var WantAgent; var wantAgent;
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { var wantAgentInfo = {
...@@ -2823,19 +2809,19 @@ var wantAgentInfo = { ...@@ -2823,19 +2809,19 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); console.info("==========================>getWantAgentCallback=======================>");
WantAgent = data; wantAgent = data;
}); });
wantAgent.getWant(WantAgent).then((data) => { WantAgent.getWant(wantAgent).then((data) => {
console.info("==========================>getWantCallback=======================>"); console.info("==========================>getWantCallback=======================>");
}); });
``` ```
#### WantAgent.cancel(agent: WantAgent, callback: AsyncCallback\<void\>) ## WantAgent.cancel(agent: WantAgent, callback: AsyncCallback\<void\>)
- 接口说明 - 接口说明
...@@ -2856,17 +2842,17 @@ wantAgent.getWant(WantAgent).then((data) => { ...@@ -2856,17 +2842,17 @@ wantAgent.getWant(WantAgent).then((data) => {
- 示例 - 示例
```js ```js
import wantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象 //wantAgent对象
var WantAgent; var wantAgent;
//getWantAgent回调 //getWantAgent回调
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>"); console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) { if (err.code == 0) {
WantAgent = data; wantAgent = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.info('----getWantAgent failed!----');
} }
...@@ -2899,18 +2885,18 @@ var wantAgentInfo = { ...@@ -2899,18 +2885,18 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//cancel回调 //cancel回调
function cancelCallback(err, data) { function cancelCallback(err, data) {
console.info("==========================>cancelCallback=======================>"); console.info("==========================>cancelCallback=======================>");
} }
wantAgent.cancel(WantAgent, cancelCallback) WantAgent.cancel(wantAgent, cancelCallback)
``` ```
#### WantAgent.cancel(agent: WantAgent): Promise\<void\> ## WantAgent.cancel(agent: WantAgent): Promise\<void\>
- 接口说明 - 接口说明
...@@ -2930,11 +2916,11 @@ wantAgent.cancel(WantAgent, cancelCallback) ...@@ -2930,11 +2916,11 @@ wantAgent.cancel(WantAgent, cancelCallback)
- 示例 - 示例
```js ```js
import wantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象 //wantAgent对象
var WantAgent; var wantAgent;
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { var wantAgentInfo = {
...@@ -2964,19 +2950,19 @@ var wantAgentInfo = { ...@@ -2964,19 +2950,19 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); console.info("==========================>getWantAgentCallback=======================>");
WantAgent = data; wantAgent = data;
}); });
wantAgent.cancel(WantAgent).then((data) => { WantAgent.cancel(wantAgent).then((data) => {
console.info("==========================>cancelCallback=======================>"); console.info("==========================>cancelCallback=======================>");
}); });
``` ```
#### WantAgent.trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\<CompleteData\>) ## WantAgent.trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\<CompleteData\>)
- 接口说明 - 接口说明
...@@ -3007,17 +2993,17 @@ wantAgent.cancel(WantAgent).then((data) => { ...@@ -3007,17 +2993,17 @@ wantAgent.cancel(WantAgent).then((data) => {
- 示例 - 示例
```js ```js
import wantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象 //wantAgent对象
var WantAgent; var wantAgent;
//getWantAgent回调 //getWantAgent回调
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>"); console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) { if (err.code == 0) {
WantAgent = data; wantAgent = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.info('----getWantAgent failed!----');
} }
...@@ -3050,7 +3036,7 @@ var wantAgentInfo = { ...@@ -3050,7 +3036,7 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//trigger回调 //trigger回调
function triggerCallback(err, data) { function triggerCallback(err, data) {
...@@ -3060,12 +3046,12 @@ function triggerCallback(err, data) { ...@@ -3060,12 +3046,12 @@ function triggerCallback(err, data) {
var triggerInfo = { var triggerInfo = {
code:0 code:0
} }
wantAgent.trigger(WantAgent, triggerInfo, triggerCallback) WantAgent.trigger(wantAgent, triggerInfo, triggerCallback)
``` ```
#### WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\>) ## WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\>)
- 接口说明 - 接口说明
...@@ -3087,19 +3073,19 @@ wantAgent.trigger(WantAgent, triggerInfo, triggerCallback) ...@@ -3087,19 +3073,19 @@ wantAgent.trigger(WantAgent, triggerInfo, triggerCallback)
- 示例 - 示例
```js ```js
import wantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象 //wantAgent对象
var WantAgent1; var wantAgent1;
var WantAgent2; var wantAgent2;
//getWantAgent回调 //getWantAgent回调
function getWantAgentCallback(err, data) { function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>"); console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) { if (err.code == 0) {
WantAgent1 = data; wantAgent1 = data;
WantAgent2 = data; wantAgent2 = data;
} else { } else {
console.info('----getWantAgent failed!----'); console.info('----getWantAgent failed!----');
} }
...@@ -3132,18 +3118,18 @@ var wantAgentInfo = { ...@@ -3132,18 +3118,18 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//equal回调 //equal回调
function equalCallback(err, data) { function equalCallback(err, data) {
console.info("==========================>equalCallback=======================>"); console.info("==========================>equalCallback=======================>");
} }
wantAgent.equal(WantAgent1, WantAgent1, equalCallback) WantAgent.equal(wantAgent1, wantAgent2, equalCallback)
``` ```
#### WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\> ## WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\>
- 接口说明 - 接口说明
...@@ -3164,12 +3150,12 @@ wantAgent.equal(WantAgent1, WantAgent1, equalCallback) ...@@ -3164,12 +3150,12 @@ wantAgent.equal(WantAgent1, WantAgent1, equalCallback)
- 示例 - 示例
```js ```js
import wantAgent from '@ohos.wantAgent'; import WantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象 //wantAgent对象
var WantAgent1; var wantAgent1;
var WantAgent2; var wantAgent2;
//WantAgentInfo对象 //WantAgentInfo对象
var wantAgentInfo = { var wantAgentInfo = {
...@@ -3199,12 +3185,13 @@ var wantAgentInfo = { ...@@ -3199,12 +3185,13 @@ var wantAgentInfo = {
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
} }
wantAgent.getWantAgent(wantAgentInfo).then((data) => { WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); console.info("==========================>getWantAgentCallback=======================>");
WantAgent = data; wantAgent1 = data;
wantAgent2 = data;
}); });
wantAgent.equal(WantAgent1, WantAgent2).then((data) => { WantAgent.equal(wantAgent1, wantAgent2).then((data) => {
console.info("==========================>equalCallback=======================>"); console.info("==========================>equalCallback=======================>");
}); });
``` ```
......
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md
浏览文件 @ ba3112c1
# ParticleAbility模块(JS端SDK接口) # particleAbility模块
#### 支持设备 ## 支持设备
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 | | API | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ | | ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ |
| ParticleAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | particleAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>: void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| ParticleAbility.startAbility(parameter: StartAbilityParameter) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | particleAbility.startAbility(parameter: StartAbilityParameter): Promise\<number> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| ParticleAbility.terminateSelf(callback: AsyncCallback\<void>) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | particleAbility.terminateSelf(callback: AsyncCallback\<void>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| ParticleAbility.terminateSelf() | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | particleAbility.terminateSelf(): Promise\<void> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| ParticleAbility.acquireDataAbilityHelper(uri: string) | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 | | particleAbility.acquireDataAbilityHelper(uri: string): DataAbilityHelper | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| particleAbility.connectAbility(request: Want, options:ConnectOptions): number | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
#### 权限列表 | particleAbility.disconnectAbility(connection: number, callback:AsyncCallback\<void>): void | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
| particleAbility.disconnectAbility(connection: number): Promise\<void> | 支持 | 支持 | 支持 | 支持 | 不支持 | 不支持 |
ohos.permission.RUNNING_LOCK permission
## 使用限制
#### 使用限制
particleAbility模块用来对Data和Service类型的Ability进行操作
ParticleAbility模块的接口只能在Ability为Data和Service类型的时候进行调用
## 导入模块
#### 导入模块
```js
``` import particleAbility from '@ohos.ability.particleAbility'
import featureAbility from '@ohos.ability.featureAbility' ```
```
## particleAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>: void
#### ParticleAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>
- 接口说明
- 接口说明
使用此方法启动指定的particleAbility(callback形式)
服务ability使用此方法启动特定ability(callback形式)
- startAbility参数描述
- startAbility参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | --------- | -------- | ------------------------------------------------------- | ---- | ----------------- |
| --------- | -------- | --------------------- | ---- | ----------------- | | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 指示启动的ability |
| parameter | 只读 | StartAbilityParameter | 是 | 指示启动的ability | | callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
| callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
- 返回值
- StartAbilityParameter类型说明
void
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | ------ | ---- | ---------------------------------- | - 示例
| want | 只读 | want | 是 | 表示需要包含有关目标启动能力的信息 |
| abilityStartSetting | 只读 | string | 否 | 指示启动能力中使用的特殊启动设置 | ```js
import particleAbility from '@ohos.ability.particleAbility'
- want类型说明 particleAbility.startAbility(
{
| 名称 | 读写属性 | 类型 | 必填 | 描述 | want:
| ----------- | -------- | ------ | ---- | -------------------------- | {
| deviceId | 只读 | string | 否 | 设备id | action: "action.system.home",
| bundleName | 只读 | string | 否 | 捆绑包名称 | entities: ["entity.system.home"],
| abilityName | 只读 | string | 否 | ability 名字 | type: "MIMETYPE",
| uri | 只读 | string | 否 | 请求中URI的描述 | flags: FLAG_AUTH_READ_URI_PERMISSION;
| type | 只读 | string | 否 | 此文件中类型的说明 | deviceId: "",
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 | bundleName: "com.example.Data",
| action | 只读 | string | 否 | 需求中对操作的描述 | abilityName: "com.example.Data.MainAbility",
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 | uri:""
| entities | 只读 | string | 否 | 对象中实体的描述 | },
},
- flags类型说明 (error, result) => {
console.log('particleAbility startAbility errCode:' + error + 'result:' + result)
| 名称 | 参数 | 描述 | },
| ------------------------------------ | ---------- | ------------------------------------------------------------ | )
| 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 | ## particleAbility.startAbility(parameter: StartAbilityParameter): Promise\<number>
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 | - 接口说明
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 | 使用此方法启动指定的particleAbility(Promise形式)
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动 |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能 | - startAbility参数描述
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示延续是可逆的。 |
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能 |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，请使用后台模式安装指定的DI功能。 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Intent}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用 | | --------- | -------- | ------------------------------------------------------- | ---- | ----------------- |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 | | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 指示启动的ability |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 | - 返回值
- 返回值 Promise\<void>
void - 示例
- 示例 ```js
import particleAbility from '@ohos.ability.particleAbility'
```js particleAbility.startAbility(
import particleAbility from '@ohos.ability.particleAbility' {
particleAbility.startAbility( want:
{ {
want: action: "action.system.home",
{ entities: ["entity.system.home"],
action: "action.system.home", type: "MIMETYPE",
entities: ["entity.system.home"], flags: FLAG_AUTH_READ_URI_PERMISSION;
type: "MIMETYPE", deviceId: "",
flags: FLAG_AUTH_READ_URI_PERMISSION; bundleName: "com.example.Data",
deviceId: "", abilityName: "com.example.Data.MainAbility",
bundleName: "com.example.Data", uri:""
abilityName: "com.jstest.startabilitytest5.MainAbility", },
uri:"" },
}, ).then((void) => {
}, console.info("particleAbility startAbility");
) });
``` ```
#### ParticleAbility.startAbility(parameter: StartAbilityParameter) ## particleAbility.terminateSelf(callback: AsyncCallback\<void>): void
- 接口说明 - 接口说明
服务ability使用此方法启动特定ability((Promise形式)
- startAbility参数描述 终止particleAbility(callback形式)
- terminateSelf参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | --------------------- | ---- | ----------------- | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| parameter | 只读 | StartAbilityParameter | 是 | 指示启动的ability | | -------- | -------- | -------------------- | ---- | -------------------- |
- StartAbilityParameter类型说明 | callback | 只读 | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | - 返回值
| ------------------- | -------- | ------ | ---- | ---------------------------------- |
| want | 只读 | want | 是 | 表示需要包含有关目标启动能力的信息 | void
| abilityStartSetting | 只读 | string | 否 | 指示启动能力中使用的特殊启动设置 |
- 示例
- want类型说明
```js
| 名称 | 读写属性 | 类型 | 必填 | 描述 | import particleAbility from '@ohos.ability.particleAbility'
| ----------- | -------- | ------ | ---- | -------------------------- | particleAbility.terminateSelf(
| deviceId | 只读 | string | 否 | 设备id | (error, result) => {
| bundleName | 只读 | string | 否 | 捆绑包名称 | console.log('particleAbility terminateSelf errCode:' + error + 'result:' + result)
| abilityName | 只读 | string | 否 | ability 名字 | }
| uri | 只读 | string | 否 | 请求中URI的描述 | )
| type | 只读 | string | 否 | 此文件中类型的说明 | ```
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 |
| action | 只读 | string | 否 | 需求中对操作的描述 |
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 |
| entities | 只读 | string | 否 | 对象中实体的描述 | ## particleAbility.terminateSelf(): Promise\<void>
- flags类型说明 - 接口说明
| 名称 | 参数 | 描述 | 终止particleAbility(Promise形式)
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 | - 返回值
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源异能 | Promise\<void>
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否不属于OHOS | - 示例
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 | ```js
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 | import particleAbility from '@ohos.ability.particleAbility'
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动 | particleAbility.terminateSelf().then((void) => {
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能 | console.info("particleAbility terminateSelf");
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示延续是可逆的。 | });
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能 | ```
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，请使用后台模式安装指定的DI功能。 |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Intent}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用 |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 | ## particleAbility.acquireDataAbilityHelper(uri: string): DataAbilityHelper
- 返回值 - 接口说明
void 获取dataAbilityHelper
- 示例 - acquireDataAbilityHelper参数描述
```js | 名称 | 读写属性 | 类型 | 必填 | 描述 |
import featureAbility from '@ohos.ability.featureAbility' | :--- | -------- | ------ | ---- | ---------------------- |
import particleAbility from '@ohos.ability.particleAbility' | uri | 只读 | string | 是 | 指示要打开的文件的路径 |
var windowMode = featureAbility.AbilityStartSetting.WINDOW_MODE_KEY;
particleAbility.startAbility( - 返回值
want:
{ | 类型 | 说明 |
bundleName: "com.jstest.featureabilitytest", | ----------------- | ------------------------------------------ |
abilityName: "com.jstest.startabilitytest1.MainAbility", | DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类 |
},
abilityStartSetting: - 示例
{
windowMode: featureAbility.AbilityWindowConfiguration.WINDOW_MODE_FLOATING, ```js
}, import particleAbility from '@ohos.ability.particleAbility'
} var uri = "";
particleAbility.acquireDataAbilityHelper(uri)
).then((void) => { ```
console.info("==========================>startAbilityCallback=======================>");
}); ## particleAbility.connectAbility(request: Want, options:ConnectOptions): number
```
* 接口说明
将当前ability连接到指定ServiceAbility(callback形式)
#### ParticleAbility.terminateSelf(callback: AsyncCallback\<void>)
* connectAbility参数描述
- 接口说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
摧毁服务ability(callback形式) | ------- | -------- | -------------- | ---- | -------------------------- |
| request | 只读 | Want | 是 | 表示被连接的ServiceAbility |
- terminateSelf参数描述 | options | 只读 | ConnectOptions | 是 | 被指定的回调方法 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | - ConnectOptions类型说明
| -------- | -------- | -------------------- | ---- | -------------------- |
| callback | 只读 | AsyncCallback\<void> | 是 | 表示被指定的回调方法 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------ | -------- | -------- | ---- | ---------------------------------- |
- 返回值 | onConnect | 只读 | function | 是 | 连接成功时的回调函数 |
| onDisconnect | 只读 | function | 是 | 断开连接时的回调函数 |
void | onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数 |
- 示例 * 返回值
```js 标识一次连接。
import particleAbility from '@ohos.ability.particleAbility'
ParticleAbility.terminateSelf() * 示例
```
```javascript
import particleAbility from '@ohos.ability.particleAbility'
function onConnectCallback(element, remote){
#### ParticleAbility.terminateSelf() console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
- 接口说明 function onDisconnectCallback(element){
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
摧毁服务ability(Promise形式) }
function onFailedCallback(code){
- 返回值 console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code)
}
void var connId = particleAbility.connectAbility(
{
- 示例 bundleName: "com.ix.ServiceAbility",
abilityName: "com.ix.ServiceAbility.ServiceAbilityA",
```js },
import particleAbility from '@ohos.ability.particleAbility' {
particleAbility.terminateSelf().then((void) => { onConnect: onConnectCallback,
console.info("==========================>terminateSelfCallback=======================>"); onDisconnect: onDisconnectCallback,
}); onFailed: onFailedCallback,
``` },
);
```
#### ParticleAbility.acquireDataAbilityHelper(uri: string) ## particleAbility.disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
- 接口说明 * 接口说明
获取dataAbilityHelper 断开与指定ServiceAbility的连接(callback形式)
- acquireDataAbilityHelper参数描述 * disconnectAbility参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| :--- | -------- | ------ | ---- | ---------------------- | | ---------- | -------- | ------------- | ---- | ------------------------------ |
| uri | 只读 | string | 是 | 指示要打开的文件的路径 | | connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID |
| callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
- 返回值
* 返回值
返回dataAbilityHelper
void
- 示例
* 示例
```js
import particleAbility from '@ohos.ability.particleAbility' ```javascript
var uri = ""; import particleAbility from '@ohos.ability.particleAbility'
ParticleAbility.acquireDataAbilityHelper(uri) function onConnectCallback(element, remote){
``` console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
#### ParticleAbility.connectAbility(*request*: Want, *options*:ConnectOptions): number function onDisconnectCallback(element){
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
* 接口说明 }
function onFailedCallback(code){
将当前ability连接到指定ServiceAbility(callback形式) console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code)
}
* connectAbility参数描述 var connId = particleAbility.connectAbility(
{
| 名称 | 读写属性 | 类型 | 必填 | 描述 | bundleName: "com.ix.ServiceAbility",
| ------- | -------- | -------------- | ---- | -------------------------- | abilityName: "com.ix.ServiceAbility.ServiceAbilityA",
| request | 只读 | Want | 是 | 表示被连接的ServiceAbility | },
| options | 只读 | ConnectOptions | 是 | 被指定的回调方法 | {
onConnect: onConnectCallback,
- ConnectOptions类型说明 onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
| 名称 | 读写属性 | 类型 | 必填 | 描述 | },
| ------------ | -------- | -------- | ---- | ---------------------------------- | );
| onConnect | 只读 | function | 是 | 连接成功时的回调函数 | var result = particleAbility.disconnectAbility(connId,
| onDisconnect | 只读 | function | 是 | 连接失败时的回调函数 | (error,data) => {
| onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数 | console.log('particleAbilityTest DisConnectAbility result errCode : ' + error.code + " data: " + data)
},
* 返回值 );
```
连接的ServiceAbilityID。
## particleAbility.disconnectAbility(connection: number): Promise\<void>
* 示例
* 接口说明
```javascript
import particleAbility from '@ohos.ability.particleAbility' 断开与指定ServiceAbility的连接(promise形式)
var mRemote;
var connId; * disconnectAbility参数描述
function onConnectCallback(element, remote){
mRemote = remote; | 名称 | 读写属性 | 类型 | 必填 | 描述 |
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); | ---------- | -------- | ------ | ---- | ------------------------------ |
} | connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID |
function onDisconnectCallback(element){
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) * 返回值
}
function onFailedCallback(code){ Promise\<void>
console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code)
} * 示例
var connId = particleAbility.connectAbility(
{ ```javascript
bundleName: "com.ix.ServiceAbility", import particleAbility from '@ohos.ability.particleAbility'
abilityName: "ServiceAbilityA", function onConnectCallback(element, remote){
}, console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
{ }
onConnect: onConnectCallback, function onDisconnectCallback(element){
onDisconnect: onDisconnectCallback, console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
onFailed: onFailedCallback, }
}, function onFailedCallback(code){
); console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code)
``` }
var connId = particleAbility.connectAbility(
#### ParticleAbility.disconnectAbility(connection: number, callback:AsyncCallback<void>): void {
bundleName: "com.ix.ServiceAbility",
* 接口说明 abilityName: "com.ix.ServiceAbility.ServiceAbilityA",
},
断开与指定ServiceAbility的连接(callback形式) {
onConnect: onConnectCallback,
* disconnectAbility参数描述 onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
| 名称 | 读写属性 | 类型 | 必填 | 描述 | },
| ---------- | -------- | ------------- | ---- | ------------------------------ | );
| connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID | var result = particleAbility.disconnectAbility(connId).then((void) => {
| callback | 只读 | AsyncCallback | 是 | 被指定的回调方法 | console.info("particleAbilityTest disconnectAbility");
});
* 返回值 ```
无 ## StartAbilityParameter类型说明
* 示例 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | --------------------- | ---- | ------------------------------------------------------------ |
```javascript | want | 只读 | [Want](#Want类型说明) | 是 | 表示需要包含有关目标启动能力的信息。 |
import particleAbility from '@ohos.ability.particleAbility' | abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 |
var mRemote;
var connId; ## Want类型说明
function onConnectCallback(element, remote){
mRemote = remote; | 名称 | 读写属性 | 类型 | 必填 | 描述 |
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); | ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
} | deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
function onDisconnectCallback(element){ | bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) | abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
} | uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
function onFailedCallback(code){ | type | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。 |
console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code) | flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](#flags说明)。 |
} | action | 只读 | string | 否 | 表示action选项描述。 |
var connId = particleAbility.connectAbility( | parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。 |
{ | entities | 只读 | Array\<string> | 否 | 表示entities相关描述。 |
bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA", ## flags说明
},
{ | 名称 | 参数 | 描述 |
onConnect: onConnectCallback, | ------------------------------------ | ---------- | ------------------------------------------------------------ |
onDisconnect: onDisconnectCallback, | FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 |
onFailed: onFailedCallback, | FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 |
}, | FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源能力 |
); | FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 |
var result = particleAbility.disconnectAbility(connId, | FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS |
(error,data) => { | FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 |
console.log('particleAbilityTest DisConnectJsSameBundleName result errCode : ' + error.code + " data: " + data) | FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 |
}, | FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力 |
); | FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动 |
``` | FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能 |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 |
#### ParticleAbility.disconnectAbility(connection: number): Promise<void>; | FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能 |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 |
* 接口说明 | FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Want}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用 |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 |
断开与指定ServiceAbility的连接(promise形式) | FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
* disconnectAbility参数描述 ## AbilityStartSetting类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。
| ---------- | -------- | ------ | ---- | ------------------------------ |
| connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID | 使用时通过featureAbility.AbilityStartSetting获取，示例：featureAbility.AbilityStartSetting.BOUNDS_KEY。
* 返回值 | 名称 | 参数 | 描述 |
| --------------- | --------------- | -------------------------- |
无 | BOUNDS_KEY | "abilityBounds" | 窗口显示大小属性的名称。 |
| WINDOW_MODE_KEY | "windowMode" | 窗口显示模式属性的名称。 |
* 示例 | DISPLAY_ID_KEY | "displayId" | 窗口显示设备ID属性的名称。 |
```javascript ## AbilityWindowConfiguration类型说明
import particleAbility from '@ohos.ability.particleAbility'
var mRemote; 使用时通过featureAbility.AbilityWindowConfiguration获取，示例：featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED。
var connId;
function onConnectCallback(element, remote){ | 名称 | 参数 | 描述 |
mRemote = remote; | --------------------------- | ---- | ---------- |
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); | WINDOW_MODE_UNDEFINED | 0 | 未定义。 |
} | WINDOW_MODE_FULLSCREEN | 1 | 全屏。 |
function onDisconnectCallback(element){ | WINDOW_MODE_SPLIT_PRIMARY | 100 | 分屏主屏。 |
console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId) | WINDOW_MODE_SPLIT_SECONDARY | 101 | 分屏次屏。 |
} | WINDOW_MODE_FLOATING | 102 | 悬浮窗。 |
function onFailedCallback(code){ \ No newline at end of file
console.log('particleAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connId = particleAbility.connectAbility(
{
bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA",
},
{
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
},
);
var result = await particleAbility.disconnectAbility(connId);
```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或