Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 275e470e 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!1061 Update js-apis 

Merge pull request !1061 from jsjzju/OpenHarmony-3.1-Beta
上级 12089797 da04cde0
隐藏空白更改
内联 并排
Showing with 6194 addition and 4702 deletion
zh-cn/application-dev/reference/apis/js-apis-Context.md
浏览文件 @ 275e470e
# 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
浏览文件 @ 275e470e
### 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
浏览文件 @ 275e470e
# 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
浏览文件 @ 275e470e
### 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
浏览文件 @ 275e470e
# 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>) ## FeatureAbility.startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>): void
* 接口说明 * 接口说明
...@@ -44,56 +42,12 @@ import featureAbility from '@ohos.ability.featureAbility' ...@@ -44,56 +42,12 @@ import featureAbility from '@ohos.ability.featureAbility'
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | --------------------- | ---- | ------------------- | | --------- | -------- | --------------------- | ---- | ------------------- |
| parameter | 只读 | StartAbilityParameter | 是 | 表示被启动的Ability | | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability |
| callback | 只读 | AsyncCallback | 是 | 被指定的回调方法 | | callback | 只读 | AsyncCallback\<number> | 是 | 被指定的回调方法 |
- StartAbilityParameter类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | ------ | ---- | ---------------------------------- |
| want | 只读 | want | 是 | 表示需要包含有关目标启动能力的信息 |
| abilityStartSetting | 只读 | string | 否 | 指示启动能力中使用的特殊启动设置 |
- want类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | -------------------------- |
| deviceId | 只读 | string | 否 | 设备id |
| bundleName | 只读 | string | 否 | 捆绑包名称 |
| abilityName | 只读 | string | 否 | ability 名字 |
| uri | 只读 | string | 否 | 请求中URI的描述 |
| type | 只读 | string | 否 | 此文件中类型的说明 |
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 |
| action | 只读 | string | 否 | 需求中对操作的描述 |
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 |
| entities | 只读 | string | 否 | 对象中实体的描述 |
* flags类型说明
| 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源异能 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否不属于OHOS |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 |
| 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 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
* 返回值
void - 返回值
* 示例 - 示例
```javascript ```javascript
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
...@@ -104,7 +58,7 @@ featureAbility.startAbility( ...@@ -104,7 +58,7 @@ featureAbility.startAbility(
action: "", action: "",
entities: [""], entities: [""],
type: "", type: "",
flags: FLAG_AUTH_READ_URI_PERMISSION, flags: FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: "",
bundleName: "com.example.startability", bundleName: "com.example.startability",
abilityName: "com.example.startability.MainAbility", abilityName: "com.example.startability.MainAbility",
...@@ -117,7 +71,7 @@ featureAbility.startAbility( ...@@ -117,7 +71,7 @@ featureAbility.startAbility(
#### FeatureAbility.startAbility(parameter: StartAbilityParameter) ## FeatureAbility.startAbility(parameter: StartAbilityParameter): Promise\<number>
* 接口说明 * 接口说明
...@@ -125,57 +79,13 @@ featureAbility.startAbility( ...@@ -125,57 +79,13 @@ featureAbility.startAbility(
* startAbility参数描述 * startAbility参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | --------------------- | ---- | ------------------- | | --------- | -------- | ------------------------------------------------------- | ---- | ------------------- |
| parameter | 只读 | StartAbilityParameter | 是 | 表示被启动的Ability | | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability |
- StartAbilityParameter类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | ------ | ---- | ---------------------------------- |
| want | 只读 | want | 是 | 表示需要包含有关目标启动能力的信息 |
| abilityStartSetting | 只读 | string | 否 | 指示启动能力中使用的特殊启动设置 |
- want类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | -------------------------- |
| deviceId | 只读 | string | 否 | 设备id |
| bundleName | 只读 | string | 否 | 捆绑包名称 |
| abilityName | 只读 | string | 否 | ability 名字 |
| uri | 只读 | string | 否 | 请求中URI的描述 |
| type | 只读 | string | 否 | 此文件中类型的说明 |
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 |
| action | 只读 | string | 否 | 需求中对操作的描述 |
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 |
| entities | 只读 | string | 否 | 对象中实体的描述 |
* flags类型说明
| 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源异能 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否不属于OHOS |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 |
| 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 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
* 返回值
void - 返回值
* 示例 - 示例
```javascript ```javascript
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
...@@ -200,7 +110,7 @@ featureAbility.startAbility( ...@@ -200,7 +110,7 @@ featureAbility.startAbility(
#### FeatureAbility.acquireDataAbilityHelper(uri: string) ## FeatureAbility.acquireDataAbilityHelper(uri: string): DataAbilityHelper
* 接口说明 * 接口说明
...@@ -208,13 +118,15 @@ featureAbility.startAbility( ...@@ -208,13 +118,15 @@ featureAbility.startAbility(
* 参数描述 * 参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ---------------------- | | ---- | -------- | ------ | ---- | ---------------------- |
| uri | 只读 | string | 是 | 指示要打开的文件的路径 | | uri | 只读 | string | 是 | 指示要打开的文件的路径 |
* 返回值 * 返回值
返回dataAbilityHelper | 类型 | 说明 |
| ----------------- | ------------------------------------------ |
| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类 |
* 示例 * 示例
...@@ -227,7 +139,7 @@ featureAbility.acquireDataAbilityHelper( ...@@ -227,7 +139,7 @@ featureAbility.acquireDataAbilityHelper(
#### FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>) ## FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void
* 接口说明 * 接口说明
...@@ -237,54 +149,12 @@ featureAbility.acquireDataAbilityHelper( ...@@ -237,54 +149,12 @@ featureAbility.acquireDataAbilityHelper(
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ---------------------- | ---- | ------------------- | | --------- | -------- | ---------------------- | ---- | ------------------- |
| parameter | 只读 | StartAbilityParameter | 是 | 表示被启动的Ability | | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability |
| callback | 只读 | AsyncCallback\<number> | 是 | 被指定的回调方法 | | callback | 只读 | AsyncCallback\<[AbilityResult](#AbilityResult类型说明)> | 是 | 被指定的回调方法 |
- StartAbilityParameter类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | ------ | ---- | ---------------------------------- |
| want | 只读 | want | 是 | 表示需要包含有关目标启动能力的信息 |
| abilityStartSetting | 只读 | string | 否 | 指示启动能力中使用的特殊启动设置 |
- want类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | -------------------------- |
| deviceId | 只读 | string | 否 | 设备id |
| bundleName | 只读 | string | 否 | 捆绑包名称 |
| abilityName | 只读 | string | 否 | ability 名字 |
| uri | 只读 | string | 否 | 请求中URI的描述 |
| type | 只读 | string | 否 | 此文件中类型的说明 |
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 |
| action | 只读 | string | 否 | 需求中对操作的描述 |
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 |
| entities | 只读 | string | 否 | 对象中实体的描述 |
* flags类型说明
| 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源异能 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否不属于OHOS |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 |
| 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 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
* 返回值 * 返回值
返回{@link AbilityResult} [AbilityResult](#AbilityResult类型说明)
* 示例 * 示例
...@@ -300,7 +170,7 @@ featureAbility.startAbilityForResult( ...@@ -300,7 +170,7 @@ featureAbility.startAbilityForResult(
flags: FLAG_AUTH_READ_URI_PERMISSION, flags: FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: "",
bundleName: "com.example.featureabilitytest", bundleName: "com.example.featureabilitytest",
abilityName: "com.example.startabilityforresulttest1.MainAbility", abilityName: "com.example.featureabilitytest.MainAbility",
uri:"" uri:""
}, },
}, },
...@@ -309,7 +179,7 @@ featureAbility.startAbilityForResult( ...@@ -309,7 +179,7 @@ featureAbility.startAbilityForResult(
#### FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter) ## FeatureAbility.startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
* 接口说明 * 接口说明
...@@ -317,55 +187,13 @@ featureAbility.startAbilityForResult( ...@@ -317,55 +187,13 @@ featureAbility.startAbilityForResult(
* startAbility参数描述 * startAbility参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | --------------------- | ---- | ------------------- | | --------- | -------- | ------------------------------------------------------- | ---- | ------------------- |
| parameter | 只读 | StartAbilityParameter | 是 | 表示被启动的Ability | | parameter | 只读 | [StartAbilityParameter](#StartAbilityParameter类型说明) | 是 | 表示被启动的Ability |
- StartAbilityParameter类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | ------ | ---- | ---------------------------------- |
| want | 只读 | want | 是 | 表示需要包含有关目标启动能力的信息 |
| abilityStartSetting | 只读 | string | 否 | 指示启动能力中使用的特殊启动设置 |
- want类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | -------------------------- |
| deviceId | 只读 | string | 否 | 设备id |
| bundleName | 只读 | string | 否 | 捆绑包名称 |
| abilityName | 只读 | string | 否 | ability 名字 |
| uri | 只读 | string | 否 | 请求中URI的描述 |
| type | 只读 | string | 否 | 此文件中类型的说明 |
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 |
| action | 只读 | string | 否 | 需求中对操作的描述 |
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 |
| entities | 只读 | string | 否 | 对象中实体的描述 |
* flags类型说明
| 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源异能 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否不属于OHOS |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 |
| 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 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
* 返回值 * 返回值
返回{@link AbilityResult} [AbilityResult](#AbilityResult类型说明)
* 示例 * 示例
...@@ -381,7 +209,7 @@ featureAbility.startAbilityForResult( ...@@ -381,7 +209,7 @@ featureAbility.startAbilityForResult(
flags: FLAG_AUTH_READ_URI_PERMISSION, flags: FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: "",
bundleName: "com.example.featureabilitytest", bundleName: "com.example.featureabilitytest",
abilityName: "com.example.startabilityforresulttest2.MainAbility", abilityName: "com.example.featureabilitytest.MainAbility",
uri:"", uri:"",
parameters: parameters:
{ {
...@@ -404,7 +232,7 @@ featureAbility.startAbilityForResult( ...@@ -404,7 +232,7 @@ featureAbility.startAbilityForResult(
#### FeatureAbility.terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>) ## FeatureAbility.terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>): void
* 接口说明 * 接口说明
...@@ -415,56 +243,11 @@ featureAbility.startAbilityForResult( ...@@ -415,56 +243,11 @@ featureAbility.startAbilityForResult(
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ------------- | ---- | ------------------- | | --------- | -------- | ------------- | ---- | ------------------- |
| parameter | 只读 | AbilityResult | 是 | 表示被启动的Ability | | parameter | 只读 | [AbilityResult](#AbilityResult类型说明) | 是 | 表示被启动的Ability |
| callback | 只读 | AsyncCallback | 是 | 被指定的回调方法 | | callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
* AbilityResult类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------ | ---- | ------------------------------------------------------------ |
| resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持） |
| want | 只读 | Want | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
- want类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | -------------------------- |
| deviceId | 只读 | string | 否 | 设备id |
| bundleName | 只读 | string | 否 | 捆绑包名称 |
| abilityName | 只读 | string | 否 | ability 名字 |
| uri | 只读 | string | 否 | 请求中URI的描述 |
| type | 只读 | string | 否 | 此文件中类型的说明 |
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 |
| action | 只读 | string | 否 | 需求中对操作的描述 |
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 |
| entities | 只读 | string | 否 | 对象中实体的描述 |
* flags类型说明
| 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源异能 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否不属于OHOS |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 |
| 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 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
* 返回值 * 返回值
void
* 示例 * 示例
```javascript ```javascript
...@@ -480,7 +263,7 @@ featureAbility.terminateSelfWithResult( ...@@ -480,7 +263,7 @@ featureAbility.terminateSelfWithResult(
flags: FLAG_AUTH_READ_URI_PERMISSION, flags: FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: "",
bundleName: "com.example.featureabilitytest", bundleName: "com.example.featureabilitytest",
abilityName: "com.example.finishwithresulttest1.MainAbility", abilityName: "com.example.featureabilitytest.MainAbility",
uri:"", uri:"",
parameters: { parameters: {
mykey0: 2222, mykey0: 2222,
...@@ -499,7 +282,7 @@ featureAbility.terminateSelfWithResult( ...@@ -499,7 +282,7 @@ featureAbility.terminateSelfWithResult(
#### FeatureAbility.terminateSelfWithResult(parameter: AbilityResult) ## FeatureAbility.terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
* 接口说明 * 接口说明
...@@ -507,57 +290,12 @@ featureAbility.terminateSelfWithResult( ...@@ -507,57 +290,12 @@ featureAbility.terminateSelfWithResult(
* startAbility参数描述 * startAbility参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ------------- | ---- | ------------------- | | --------- | -------- | --------------------------------------- | ---- | ------------------- |
| parameter | 只读 | AbilityResult | 是 | 表示被启动的Ability | | parameter | 只读 | [AbilityResult](#AbilityResult类型说明) | 是 | 表示被启动的Ability |
* AbilityResult类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------ | ---- | ------------------------------------------------------------ |
| resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持） |
| want | 只读 | Want | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
- want类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | -------------------------- |
| deviceId | 只读 | string | 否 | 设备id |
| bundleName | 只读 | string | 否 | 捆绑包名称 |
| abilityName | 只读 | string | 否 | ability 名字 |
| uri | 只读 | string | 否 | 请求中URI的描述 |
| type | 只读 | string | 否 | 此文件中类型的说明 |
| flags | 只读 | number | 否 | 此文件中标志的选项是必需的 |
| action | 只读 | string | 否 | 需求中对操作的描述 |
| parameters | 只读 | string | 否 | Want中WantParams对象的描述 |
| entities | 只读 | string | 否 | 对象中实体的描述 |
* flags类型说明
| 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源异能 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否不属于OHOS |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 将结果返回到源能力片 |
| 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 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
* 返回值 * 返回值
void
* 示例 * 示例
```javascript ```javascript
...@@ -573,7 +311,7 @@ featureAbility.terminateSelfWithResult( ...@@ -573,7 +311,7 @@ featureAbility.terminateSelfWithResult(
flags: FLAG_AUTH_READ_URI_PERMISSION, flags: FLAG_AUTH_READ_URI_PERMISSION,
deviceId: "", deviceId: "",
bundleName: "com.example.featureabilitytest", bundleName: "com.example.featureabilitytest",
abilityName: "com.example.finishwithresulttest1.MainAbility", abilityName: "com.example.featureabilitytest.MainAbility",
uri:"", uri:"",
parameters: { parameters: {
mykey0: 2222, mykey0: 2222,
...@@ -588,13 +326,13 @@ featureAbility.terminateSelfWithResult( ...@@ -588,13 +326,13 @@ featureAbility.terminateSelfWithResult(
}, },
} }
).then((void) => { ).then((void) => {
console.info("==========================>terminateSelfWithResult=======================>"); console.info("==========================>terminateSelfWithResult=======================>");
}); });
``` ```
#### FeatureAbility.hasWindowFocus(callback: AsyncCallback\<boolean>) ## FeatureAbility.hasWindowFocus(callback: AsyncCallback\<boolean>): void
* 接口说明 * 接口说明
...@@ -619,7 +357,7 @@ featureAbility.hasWindowFocus() ...@@ -619,7 +357,7 @@ featureAbility.hasWindowFocus()
#### FeatureAbility.hasWindowFocus() ## FeatureAbility.hasWindowFocus(): Promise\<boolean>
* 接口说明 * 接口说明
...@@ -627,7 +365,7 @@ featureAbility.hasWindowFocus() ...@@ -627,7 +365,7 @@ featureAbility.hasWindowFocus()
* 参数描述 * 参数描述
Null 无
* 返回值 * 返回值
...@@ -638,13 +376,13 @@ featureAbility.hasWindowFocus() ...@@ -638,13 +376,13 @@ featureAbility.hasWindowFocus()
```javascript ```javascript
import featureAbility from '@ohos.ability.featureability'; import featureAbility from '@ohos.ability.featureability';
featureAbility.hasWindowFocus().then((void) => { featureAbility.hasWindowFocus().then((void) => {
console.info("==========================>hasWindowFocus=======================>"); console.info("==========================>hasWindowFocus=======================>");
}); });
``` ```
#### FeatureAbility.getWant(callback: AsyncCallback\<Want>) ## FeatureAbility.getWant(callback: AsyncCallback\<Want>)
* 接口说明 * 接口说明
...@@ -658,8 +396,6 @@ featureAbility.hasWindowFocus().then((void) => { ...@@ -658,8 +396,6 @@ featureAbility.hasWindowFocus().then((void) => {
* 返回值 * 返回值
void
* 示例 * 示例
```javascript ```javascript
...@@ -669,7 +405,7 @@ featureAbility.getWant() ...@@ -669,7 +405,7 @@ featureAbility.getWant()
#### FeatureAbility.getWant() ## FeatureAbility.getWant(): void
* 接口说明 * 接口说明
...@@ -677,12 +413,10 @@ featureAbility.getWant() ...@@ -677,12 +413,10 @@ featureAbility.getWant()
* 参数描述 * 参数描述
Null 无
* 返回值 * 返回值
void
* 示例 * 示例
```javascript ```javascript
...@@ -694,7 +428,7 @@ featureAbility.getWant().then((void) => { ...@@ -694,7 +428,7 @@ featureAbility.getWant().then((void) => {
#### FeatureAbility.getContext() ## FeatureAbility.getContext(): Context
* 接口说明 * 接口说明
...@@ -714,7 +448,7 @@ context.getBundleName() ...@@ -714,7 +448,7 @@ context.getBundleName()
#### FeatureAbility.terminateSelf(callback: AsyncCallback\<void>) ## FeatureAbility.terminateSelf(callback: AsyncCallback\<void>): void
* 接口说明 * 接口说明
...@@ -728,8 +462,6 @@ context.getBundleName() ...@@ -728,8 +462,6 @@ context.getBundleName()
* 返回值 * 返回值
void
* 示例 * 示例
```javascript ```javascript
...@@ -739,7 +471,7 @@ featureAbility.terminateSelf() ...@@ -739,7 +471,7 @@ featureAbility.terminateSelf()
#### FeatureAbility.terminateSelf() ## FeatureAbility.terminateSelf(): Promise\<void>
* 接口说明 * 接口说明
...@@ -751,8 +483,6 @@ featureAbility.terminateSelf() ...@@ -751,8 +483,6 @@ featureAbility.terminateSelf()
* 返回值 * 返回值
* void
* 示例 * 示例
```javascript ```javascript
...@@ -761,7 +491,7 @@ featureAbility.terminateSelf().then((void) => { console.info("============= ...@@ -761,7 +491,7 @@ featureAbility.terminateSelf().then((void) => { console.info("=============
}); });
``` ```
#### FeatureAbility.connectAbility(*request*: Want, *options*:ConnectOptions): number ## FeatureAbility.connectAbility(request: Want, options:ConnectOptions): number
* 接口说明 * 接口说明
...@@ -790,10 +520,7 @@ featureAbility.terminateSelf().then((void) => { console.info("============= ...@@ -790,10 +520,7 @@ featureAbility.terminateSelf().then((void) => { console.info("=============
```javascript ```javascript
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var mRemote;
var connId;
function onConnectCallback(element, remote){ function onConnectCallback(element, remote){
mRemote = remote;
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
} }
function onDisconnectCallback(element){ function onDisconnectCallback(element){
...@@ -815,7 +542,7 @@ var connId = featureAbility.connectAbility( ...@@ -815,7 +542,7 @@ var connId = featureAbility.connectAbility(
); );
``` ```
#### FeatureAbility.disconnectAbility(connection: number, callback:AsyncCallback<void>): void ## FeatureAbility.disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
* 接口说明 * 接口说明
...@@ -826,20 +553,15 @@ var connId = featureAbility.connectAbility( ...@@ -826,20 +553,15 @@ var connId = featureAbility.connectAbility(
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------------- | ---- | ------------------------------ | | ---------- | -------- | ------------- | ---- | ------------------------------ |
| connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID | | connection | 只读 | number | 是 | 指定断开连接的ServiceAbilityID |
| callback | 只读 | AsyncCallback | 是 | 被指定的回调方法 | | callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 |
* 返回值 * 返回值
无
* 示例 * 示例
```javascript ```javascript
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var mRemote;
var connId;
function onConnectCallback(element, remote){ function onConnectCallback(element, remote){
mRemote = remote;
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
} }
function onDisconnectCallback(element){ function onDisconnectCallback(element){
...@@ -866,7 +588,7 @@ var result = featureAbility.disconnectAbility(connId, ...@@ -866,7 +588,7 @@ var result = featureAbility.disconnectAbility(connId,
); );
``` ```
#### FeatureAbility.disconnectAbility(connection: number): Promise<void>; ## FeatureAbility.disconnectAbility(connection: number): Promise\<void>
* 接口说明 * 接口说明
...@@ -880,16 +602,11 @@ var result = featureAbility.disconnectAbility(connId, ...@@ -880,16 +602,11 @@ var result = featureAbility.disconnectAbility(connId,
* 返回值 * 返回值
无
* 示例 * 示例
```javascript ```javascript
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
var mRemote;
var connId;
function onConnectCallback(element, remote){ function onConnectCallback(element, remote){
mRemote = remote;
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
} }
function onDisconnectCallback(element){ function onDisconnectCallback(element){
...@@ -912,43 +629,75 @@ var connId = featureAbility.connectAbility( ...@@ -912,43 +629,75 @@ var connId = featureAbility.connectAbility(
var result = await featureAbility.disconnectAbility(connId); var result = await featureAbility.disconnectAbility(connId);
``` ```
#### FeatureAbility.continueAbility(options: ContinueAbilityOptions, callback: AsyncCallback<void>); ## AbilityResult类型说明
* 接口说明 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------- | ---- | ------------------------------------------------------------ |
迁移一个ability到目标设备，并返回执行结果(callback形式) | resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持） |
| want | 只读 | [Want](#Want类型说明) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
* startAbility参数描述
## StartAbilityParameter类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | ------------------- | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| options | 只读 | ContinueAbilityOptions | 是 | 表示被启动的Ability | | ------------------- | -------- | --------------------- | ---- | ------------------------------------------------------------ |
| callback | 只读 | AsyncCallback\<void> | 是 | 被指定的回调方法 | | want | 只读 | [Want](#Want类型说明) | 是 | 表示需要包含有关目标启动能力的信息。 |
| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 |
- ContinueAbilityOptions类型说明
## Want类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------- | ---- | ----------------------------------------------------------- | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| deviceId | 只读 | string | 是 | 表示需要包含有关目标启动能力的信息 | | ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| reversible | 只读 | boolean | 是 | 是否支持回迁的标志，目前不支持该功能，为保留字段，可填false | | deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
* 示例 | abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
```javascript | type | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。 |
import featureAbility from '@ohos.ability.featureAbility' | flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](#flags说明)。 |
| action | 只读 | string | 否 | 表示action选项描述。 |
async StartContinueAbility(deviceId) { | parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。 |
let continueAbilityOptions = { | entities | 只读 | Array\<string> | 否 | 表示entities相关描述。 |
reversible: false,
deviceId: deviceId, ## flags说明
}
function ContinueAbilityCallback(err, data) { | 名称 | 参数 | 描述 |
console.info("[Demo] ContinueAbilityCallback, result err = " + JSON.stringify(err)); | ------------------------------------ | ---------- | ------------------------------------------------------------ |
console.info("[Demo] ContinueAbilityCallback, result data= " + JSON.stringify(data)); | FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 |
} | FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 |
await featureAbility.continueAbility(continueAbilityOptions, ContinueAbilityCallback); | FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给源能力 |
console.info('[Demo] featureAbility.StartContinueAbility end'); | FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 |
} | FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS |
this.StartContinueAbility(remoteDeviceId); //remoteDeviceId is acquired from DeviceManager | FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 |
``` | 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 | 表示迁移是可拉回的。 |
| 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 | 指示在历史任务堆栈上创建任务的操作。 |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
## AbilityStartSetting类型说明
abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。
使用时通过featureAbility.AbilityStartSetting获取，示例：featureAbility.AbilityStartSetting.BOUNDS_KEY。
| 名称 | 参数 | 描述 |
| --------------- | --------------- | -------------------------- |
| BOUNDS_KEY | "abilityBounds" | 窗口显示大小属性的名称。 |
| WINDOW_MODE_KEY | "windowMode" | 窗口显示模式属性的名称。 |
| DISPLAY_ID_KEY | "displayId" | 窗口显示设备ID属性的名称。 |
## AbilityWindowConfiguration类型说明
使用时通过featureAbility.AbilityWindowConfiguration获取，示例：featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED。
| 名称 | 参数 | 描述 |
| --------------------------- | ---- | ---------- |
| WINDOW_MODE_UNDEFINED | 0 | 未定义。 |
| WINDOW_MODE_FULLSCREEN | 1 | 全屏。 |
| WINDOW_MODE_SPLIT_PRIMARY | 100 | 分屏主屏。 |
| WINDOW_MODE_SPLIT_SECONDARY | 101 | 分屏次屏。 |
| WINDOW_MODE_FLOATING | 102 | 悬浮窗。 |
zh-cn/application-dev/reference/apis/js-apis-notification.md
浏览文件 @ 275e470e
# Notification模块(JS端SDK接口) # Notification模块
#### 支持设备 ## 支持设备
| API | 手机 | 平板 | 智慧屏 | 智能穿戴 | | API | 手机 | 平板 | 智慧屏 | 智能穿戴 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | | ------------------------------------------------------------ | ---- | ---- | ------ | -------- |
| Notification.publish(request: NotificationRequest, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.publish(request: NotificationRequest, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.publish(request: NotificationRequest) | 支持 | 支持 | 支持 | 支持 | | Notification.publish(request: NotificationRequest) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancel(id: number, label: string, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.cancel(id: number, label: string, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancel(id：number, label？：string） | 支持 | 支持 | 支持 | 支持 | | Notification.cancel(id：number, label?：string） | 支持 | 支持 | 支持 | 支持 |
| Notification.cancel(id: number, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.cancel(id: number, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancelAll(callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.cancelAll(callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.cancelAll() | 支持 | 支持 | 支持 | 支持 | | Notification.cancelAll() | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlot(slot: NotificationSlot, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.addSlot(slot: NotificationSlot, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlot(slot: NotificationSlot) | 支持 | 支持 | 支持 | 支持 | | Notification.addSlot(slot: NotificationSlot) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlot(type: SlotType, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.addSlot(type: SlotType, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlot(type: SlotType) | 支持 | 支持 | 支持 | 支持 | | Notification.addSlot(type: SlotType) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlots(slots: Array<NotificationSlot>, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.addSlots(slots: Array\<NotificationSlot\>, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.addSlots(slots: Array<NotificationSlot>) | 支持 | 支持 | 支持 | 支持 | | Notification.addSlots(slots: Array\<NotificationSlot\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlot(slotType: SlotType, callback: AsyncCallback<NotificationSlot>) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlot(slotType: SlotType, callback: AsyncCallback\<NotificationSlot\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlot(slotType: SlotType) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlot(slotType: SlotType) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlots(callback: AsyncCallback<Array<NotificationSlot>>) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlots(callback: AsyncCallback<Array\<NotificationSlot\>>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlots() | 支持 | 支持 | 支持 | 支持 | | Notification.getSlots() | 支持 | 支持 | 支持 | 支持 |
| Notification.removeSlot(slotType: SlotType, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.removeSlot(slotType: SlotType, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeSlot(slotType: SlotType) | 支持 | 支持 | 支持 | 支持 | | Notification.removeSlot(slotType: SlotType) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAllSlots(callback: AsyncCallback<void>): void | 支持 | 支持 | 支持 | 支持 | | Notification.removeAllSlots(callback: AsyncCallback\<void\>): void | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAllSlots(): Promise<void> | 支持 | 支持 | 支持 | 支持 | | Notification.removeAllSlots(): Promise\<void\> | 支持 | 支持 | 支持 | 支持 |
| Notification.subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo) | 支持 | 支持 | 支持 | 支持 | | Notification.subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo) | 支持 | 支持 | 支持 | 支持 |
| Notification.unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.unsubscribe(subscriber: NotificationSubscriber) | 支持 | 支持 | 支持 | 支持 | | Notification.unsubscribe(subscriber: NotificationSubscriber) | 支持 | 支持 | 支持 | 支持 |
| Notification.enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.enableNotification(bundle: BundleOption, enable: boolean) | 支持 | 支持 | 支持 | 支持 | | Notification.enableNotification(bundle: BundleOption, enable: boolean) | 支持 | 支持 | 支持 | 支持 |
| Notification.isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback<boolean>) | 支持 | 支持 | 支持 | 支持 | | Notification.isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.isNotificationEnabled(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 | | Notification.isNotificationEnabled(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.isNotificationEnabled(callback: AsyncCallback<boolean>) | 支持 | 支持 | 支持 | 支持 | | Notification.isNotificationEnabled(callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.isNotificationEnabled() | 支持 | 支持 | 支持 | 支持 | | Notification.isNotificationEnabled() | 支持 | 支持 | 支持 | 支持 |
| Notification.displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.displayBadge(bundle: BundleOption, enable: boolean) | 支持 | 支持 | 支持 | 支持 | | Notification.displayBadge(bundle: BundleOption, enable: boolean) | 支持 | 支持 | 支持 | 支持 |
| Notification.isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback<boolean>) | 支持 | 支持 | 支持 | 支持 | | Notification.isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.isBadgeDisplayed(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 | | Notification.isBadgeDisplayed(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot) | 支持 | 支持 | 支持 | 支持 | | Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array<NotificationSlot>>) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array\<NotificationSlot\>>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlotsByBundle(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlotsByBundle(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback<number>) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\<number\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getSlotNumByBundle(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 | | Notification.getSlotNumByBundle(bundle: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.remove(bundle: BundleOption, notificationKey: NotificationKey) | 支持 | 支持 | 支持 | 支持 | | Notification.remove(bundle: BundleOption, notificationKey: NotificationKey) | 支持 | 支持 | 支持 | 支持 |
| Notification.remove(hashCode: string, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.remove(hashCode: string, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.remove(hashCode: string) | 支持 | 支持 | 支持 | 支持 | | Notification.remove(hashCode: string) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAll(bundle: BundleOption, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.removeAll(bundle: BundleOption, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAll(callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.removeAll(callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.removeAll(bundle?: BundleOption) | 支持 | 支持 | 支持 | 支持 | | Notification.removeAll(bundle?: BundleOption) | 支持 | 支持 | 支持 | 支持 |
| Notification.getAllActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>) | 支持 | 支持 | 支持 | 支持 | | Notification.getAllActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getAllActiveNotifications() | 支持 | 支持 | 支持 | 支持 | | Notification.getAllActiveNotifications() | 支持 | 支持 | 支持 | 支持 |
| Notification.getActiveNotificationCount(callback: AsyncCallback<number>) | 支持 | 支持 | 支持 | 支持 | | Notification.getActiveNotificationCount(callback: AsyncCallback\<number\>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getActiveNotificationCount() | 支持 | 支持 | 支持 | 支持 | | Notification.getActiveNotificationCount() | 支持 | 支持 | 支持 | 支持 |
| Notification.getActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>) | 支持 | 支持 | 支持 | 支持 | | Notification.getActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>) | 支持 | 支持 | 支持 | 支持 |
| Notification.getActiveNotifications() | 支持 | 支持 | 支持 | 支持 | | Notification.getActiveNotifications() | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWantAgent(info: WantAgentInfo, callback: AsyncCallback<WantAgent>) | 支持 | 支持 | 支持 | 支持 | | Notification.cancelGroup(groupName: string, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWantAgent(info: WantAgentInfo): Promise<WantAgent> | 支持 | 支持 | 支持 | 支持 | | Notification.cancelGroup(groupName: string) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getBundleName(agent: WantAgent, callback: AsyncCallback<string>) | 支持 | 支持 | 支持 | 支持 | | Notification.removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getBundleName(agent: WantAgent): Promise<string> | 支持 | 支持 | 支持 | 支持 | | Notification.removeGroupByBundle(bundle: BundleOption, groupName: string) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getUid(agent: WantAgent, callback: AsyncCallback<number>) | 支持 | 支持 | 支持 | 支持 | | Notification.setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getUid(agent: WantAgent): Promise<number> | 支持 | 支持 | 支持 | 支持 | | Notification.setDoNotDisturbDate(date: DoNotDisturbDate) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWant(agent: WantAgent, callback: AsyncCallback<Want>) | 支持 | 支持 | 支持 | 支持 | | Notification.getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWant(agent: WantAgent): Promise<Want> | 支持 | 支持 | 支持 | 支持 | | Notification.getDoNotDisturbDate() | 支持 | 支持 | 支持 | 支持 |
| WantAgent.cancel(agent: WantAgent, callback: AsyncCallback<void>) | 支持 | 支持 | 支持 | 支持 | | Notification.supportDoNotDisturbMode(callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.cancel(agent: WantAgent): Promise<void> | 支持 | 支持 | 支持 | 支持 | | Notification.supportDoNotDisturbMode() | 支持 | 支持 | 支持 | 支持 |
| WantAgent.trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback<CompleteData>) | 支持 | 支持 | 支持 | 支持 | | WantAgent.getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback<boolean>) | 支持 | 支持 | 支持 | 支持 | | WantAgent.getWantAgent(info: WantAgentInfo): Promise\<WantAgent\> | 支持 | 支持 | 支持 | 支持 |
| WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise<boolean> | 支持 | 支持 | 支持 | 支持 | | WantAgent.getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getBundleName(agent: WantAgent): Promise\<string\> | 支持 | 支持 | 支持 | 支持 |
#### 权限列表 | WantAgent.getUid(agent: WantAgent, callback: AsyncCallback\<number\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getUid(agent: WantAgent): Promise\<number\> | 支持 | 支持 | 支持 | 支持 |
无 | WantAgent.getWant(agent: WantAgent, callback: AsyncCallback\<Want\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.getWant(agent: WantAgent): Promise\<Want\> | 支持 | 支持 | 支持 | 支持 |
#### 通知接口 | WantAgent.cancel(agent: WantAgent, callback: AsyncCallback\<void\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.cancel(agent: WantAgent): Promise\<void\> | 支持 | 支持 | 支持 | 支持 |
#### 导入模块 | WantAgent.trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\<CompleteData\>) | 支持 | 支持 | 支持 | 支持 |
| WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\>) | 支持 | 支持 | 支持 | 支持 |
```js | WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\> | 支持 | 支持 | 支持 | 支持 |
import notify from '@ohos.notification';
``` ## 权限列表
#### Notification.publish(request: NotificationRequest, callback: AsyncCallback<void>) 无
- 接口说明 ## 通知接口
发布通知（callback形式） ## 导入模块
- publish参数描述 ```js
import Notification from '@ohos.notification';
```
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------- | ---- | ------------------------------------------- | ## Notification.publish(request: NotificationRequest, callback: AsyncCallback\<void\>)
| request | 只读 | NotificationRequest | 是 | 设置要发布通知内容的NotificationRequest对象 |
| callback | 只读 | AsyncCallback<void> | 是 | 被指定的回调方法 | - 接口说明
- NotificationRequest类型说明 发布通知（callback形式）
| 名称 | 读写属性 | 类型 | 必填 | 描述 | - publish参数描述
| ----------------- | -------- | ------------------------------- | ---- | -------------------------- |
| content | 读、写 | NotificationContent | 是 | 通知内容 |
| id | 读、写 | number | 否 | 通知ID | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| slotType | 读、写 | SlotType | 否 | 通道类型 | | -------- | -------- | --------------------- | ---- | ------------------------------------------- |
| isOngoing | 读、写 | boolean | 否 | 是否进行时通知 | | request | 只读 | NotificationRequest | 是 | 设置要发布通知内容的NotificationRequest对象 |
| isUnremovable | 读、写 | boolean | 否 | 是否可移除 | | callback | 只读 | AsyncCallback\<void\> | 是 | 被指定的回调方法 |
| deliveryTime | 读、写 | number | 否 | 通知发送时间 |
| tapDismissed | 读、写 | boolean | 否 | 通知是否自动清除 | - NotificationRequest类型说明
| autoDeletedTime | 读、写 | number | 否 | 自动清除的时间 |
| wantAgent | 读、写 | WantAgent | 否 | 点击跳转的WantAgent | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| extraInfo | 读、写 | {[key: string]: any} | 否 | 扩展参数 | | ----------------- | -------- | --------------------------------- | ---- | -------------------------- |
| color | 读、写 | number | 否 | 通知背景颜色 | | content | 读、写 | NotificationContent | 是 | 通知内容 |
| colorEnabled | 读、写 | boolean | 否 | 通知背景颜色是否使能 | | id | 读、写 | number | 否 | 通知ID |
| isAlertOnce | 读、写 | boolean | 否 | 设置是否仅有一次此通知警报 | | slotType | 读、写 | SlotType | 否 | 通道类型 |
| isStopwatch | 读、写 | boolean | 否 | 是否显示已用时间 | | isOngoing | 读、写 | boolean | 否 | 是否进行时通知 |
| isCountDown | 读、写 | boolean | 否 | 是否显示倒计时时间 | | isUnremovable | 读、写 | boolean | 否 | 是否可移除 |
| isFloatingIcon | 读、写 | boolean | 否 | 是否显示状态栏图标 | | deliveryTime | 读、写 | number | 否 | 通知发送时间 |
| isFloatingIcon | 读、写 | boolean | 否 | 是否显示状态栏图标 | | tapDismissed | 读、写 | boolean | 否 | 通知是否自动清除 |
| label | 读、写 | string | 否 | 通知标签 | | autoDeletedTime | 读、写 | number | 否 | 自动清除的时间 |
| badgeIconStyle | 读、写 | number | 否 | 通知角标类型 | | wantAgent | 读、写 | WantAgent | 否 | 点击跳转的WantAgent |
| showDeliveryTime | 读、写 | boolean | 否 | 是否显示分发时间 | | extraInfo | 读、写 | {[key: string]: any} | 否 | 扩展参数 |
| actionButtons | 读、写 | Array<NotificationActionButton> | 否 | 通知按钮，最多两个按钮 | | color | 读、写 | number | 否 | 通知背景颜色 |
| smallIcon | 读、写 | PixelMap | 否 | 通知小图标 | | colorEnabled | 读、写 | boolean | 否 | 通知背景颜色是否使能 |
| largeIcon | 读、写 | PixelMap | 否 | 通知大图标 | | isAlertOnce | 读、写 | boolean | 否 | 设置是否仅有一次此通知警报 |
| creatorBundleName | 只读 | string | 否 | 创建通知的包名 | | isStopwatch | 读、写 | boolean | 否 | 是否显示已用时间 |
| creatorUid | 只读 | number | 否 | 创建通知的UID | | isCountDown | 读、写 | boolean | 否 | 是否显示倒计时时间 |
| creatorPid | 只读 | number | 否 | 创建通知的PID | | isFloatingIcon | 读、写 | boolean | 否 | 是否显示状态栏图标 |
| hashCode | 只读 | string | 否 | 通知唯一标识 | | label | 读、写 | string | 否 | 通知标签 |
| classification | 读、写 | string | 否 | 通知分类 | | badgeIconStyle | 读、写 | number | 否 | 通知角标类型 |
| showDeliveryTime | 读、写 | boolean | 否 | 是否显示分发时间 |
NotificationContent类型说明 | actionButtons | 读、写 | Array\<NotificationActionButton\> | 否 | 通知按钮，最多两个按钮 |
| smallIcon | 读、写 | PixelMap | 否 | 通知小图标 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | largeIcon | 读、写 | PixelMap | 否 | 通知大图标 |
| ----------- | -------- | ---------------------------- | ---- | -------------- | | creatorBundleName | 只读 | string | 否 | 创建通知的包名 |
| contentType | 读、写 | ContentType | 是 | 通知内容类型 | | creatorUid | 只读 | number | 否 | 创建通知的UID |
| normal | 读、写 | NotificationBasicContent | 否 | 通知基本内容 | | creatorPid | 只读 | number | 否 | 创建通知的PID |
| longText | 读、写 | NotificationLongTextContent | 否 | 通知长文本内容 | | hashCode | 只读 | string | 否 | 通知唯一标识 |
| multiLine | 读、写 | NotificationMultiLineContent | 否 | 通知多行内容 | | classification | 读、写 | string | 否 | 通知分类 |
| groupName | 读、写 | string | 否 | 组通知名称 |
- ContentType类型说明
NotificationContent类型说明
| 名称 | 读写属性 | 类型 | 描述 |
| --------------------------------- | -------- | ----------- | ---------------- | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| NOTIFICATION_CONTENT_BASIC_TEXT | 只读 | ContentType | 普通类型通知 | | ----------- | -------- | ---------------------------- | ---- | ------------------ |
| NOTIFICATION_CONTENT_LONG_TEXT | 只读 | ContentType | 长文本类型通知 | | contentType | 读、写 | ContentType | 是 | 通知内容类型 |
| NOTIFICATION_CONTENT_PICTURE | 只读 | ContentType | 图片类型通知 | | normal | 读、写 | NotificationBasicContent | 否 | 基本类型通知内容 |
| NOTIFICATION_CONTENT_CONVERSATION | 只读 | ContentType | 社交类型通知 | | longText | 读、写 | NotificationLongTextContent | 否 | 长文本类型通知内容 |
| NOTIFICATION_CONTENT_MULTILINE | 只读 | ContentType | 多行文本类型通知 | | multiLine | 读、写 | NotificationMultiLineContent | 否 | 多行类型通知内容 |
| picture | 读、写 | NotificationPictureContent | 否 | 图片类型通知内容 |
- NotificationBasicContent类型说明
- ContentType类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | ------ | ---- | -------------------------------- | | 名称 | 读写属性 | 类型 | 描述 |
| title | 读、写 | string | 是 | 通知标题 | | --------------------------------- | -------- | ----------- | ---------------- |
| text | 读、写 | string | 是 | 通知内容 | | NOTIFICATION_CONTENT_BASIC_TEXT | 只读 | ContentType | 普通类型通知 |
| additionalText | 读、写 | string | 是 | 通知次要内容，是对通知内容的补充 | | NOTIFICATION_CONTENT_LONG_TEXT | 只读 | ContentType | 长文本类型通知 |
| NOTIFICATION_CONTENT_PICTURE | 只读 | ContentType | 图片类型通知 |
- NotificationLongTextContent类型说明 | NOTIFICATION_CONTENT_CONVERSATION | 只读 | ContentType | 社交类型通知 |
| NOTIFICATION_CONTENT_MULTILINE | 只读 | ContentType | 多行文本类型通知 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | ------ | ---- | -------------------------------- | - NotificationBasicContent类型说明
| title | 读、写 | string | 是 | 通知标题 |
| text | 读、写 | string | 是 | 通知内容 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| additionalText | 读、写 | string | 是 | 通知次要内容，是对通知内容的补充 | | -------------- | -------- | ------ | ---- | -------------------------------- |
| longText | 读、写 | string | 是 | 通知的长文本 | | title | 读、写 | string | 是 | 通知标题 |
| briefText | 读、写 | string | 是 | 通知概要内容，是对通知内容的总结 | | text | 读、写 | string | 是 | 通知内容 |
| expandedTitle | 读、写 | string | 是 | 通知展开时的标题 | | additionalText | 读、写 | string | 是 | 通知次要内容，是对通知内容的补充 |
- NotificationMultiLineContent类型说明 - NotificationLongTextContent类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | ------------- | ---- | -------------------------------- | | -------------- | -------- | ------ | ---- | -------------------------------- |
| title | 读、写 | string | 是 | 通知标题 | | title | 读、写 | string | 是 | 通知标题 |
| text | 读、写 | string | 是 | 通知内容 | | text | 读、写 | string | 是 | 通知内容 |
| additionalText | 读、写 | string | 是 | 通知次要内容，是对通知内容的补充 | | additionalText | 读、写 | string | 是 | 通知次要内容，是对通知内容的补充 |
| briefText | 读、写 | string | 是 | 通知概要内容，是对通知内容的总结 | | longText | 读、写 | string | 是 | 通知的长文本 |
| longTitle | 读、写 | string | 是 | 通知展开时的标题 | | briefText | 读、写 | string | 是 | 通知概要内容，是对通知内容的总结 |
| lines | 读、写 | Array<String> | 是 | 通知的多行文本 | | expandedTitle | 读、写 | string | 是 | 通知展开时的标题 |
- NotificationPictureContent类型说明 - NotificationMultiLineContent类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | -------------- | ---- | -------------------------------- | | -------------- | -------- | --------------- | ---- | -------------------------------- |
| title | 读、写 | string | 是 | 通知标题 | | title | 读、写 | string | 是 | 通知标题 |
| text | 读、写 | string | 是 | 通知内容 | | text | 读、写 | string | 是 | 通知内容 |
| additionalText | 读、写 | string | 是 | 通知次要内容，是对通知内容的补充 | | additionalText | 读、写 | string | 是 | 通知次要内容，是对通知内容的补充 |
| briefText | 读、写 | string | 是 | 通知概要内容，是对通知内容的总结 | | briefText | 读、写 | string | 是 | 通知概要内容，是对通知内容的总结 |
| expandedTitle | 读、写 | string | 是 | 通知展开时的标题 | | longTitle | 读、写 | string | 是 | 通知展开时的标题 |
| picture | 读、写 | image.PixelMap | 是 | 通知的图片内容 | | lines | 读、写 | Array\<String\> | 是 | 通知的多行文本 |
- NotificationActionButton类型说明 - NotificationPictureContent类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------------------- | -------- | ----------------------------------------------- | ---- | ------------------------- | | -------------- | -------- | -------------- | ---- | -------------------------------- |
| title | 读、写 | string | 是 | 按钮标题 | | title | 读、写 | string | 是 | 通知标题 |
| wantAgent | 读、写 | wantAgent | 是 | 点击按钮时触发的WantAgent | | text | 读、写 | string | 是 | 通知内容 |
| extras | 读、写 | Array<String> | 否 | 按钮扩展信息 | | additionalText | 读、写 | string | 是 | 通知次要内容，是对通知内容的补充 |
| icon | 读、写 | image.PixelMap | 否 | 按钮图标 | | briefText | 读、写 | string | 是 | 通知概要内容，是对通知内容的总结 |
| userInput<sup>8+</sup> | 读、写 | [NotificationUserInput](#NotificationUserInput) | 否 | 用户输入对象实例 | | expandedTitle | 读、写 | string | 是 | 通知展开时的标题 |
| picture | 读、写 | image.PixelMap | 是 | 通知的图片内容 |
## NotificationUserInput<sup>8+</sup>
- SlotType类型说明
用户输入对象。
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------------- | -------- | -------- | ---- | -------- |
### 属性 | SOCIAL_COMMUNICATION | 只读 | SlotType | 否 | 社交类型 |
| SERVICE_INFORMATION | 只读 | SlotType | 否 | 服务类型 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | CONTENT_INFORMATION | 只读 | SlotType | 否 | 内容类型 |
| -------- | -------- | ---- | ---- | ----------------------------- | | OTHER_TYPES | 只读 | SlotType | 否 | 其他类型 |
| inputKey | string | 是 | 是 | 用户输入时用于标识此输入的key |
- NotificationActionButton类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
- 返回值 | --------- | -------- | --------------------- | ---- | ------------------------- |
| title | 读、写 | string | 是 | 按钮标题 |
返回值为void | wantAgent | 读、写 | wantAgent | 是 | 点击按钮时触发的WantAgent |
| extras | 读、写 | Array\<String\> | 否 | 按钮扩展信息 |
- 示例 | icon | 读、写 | image.PixelMap | 否 | 按钮图标 |
| userInput | 读、写 | NotificationUserInput | 否 | 用户输入对象实例 |
```js
//publish回调 - NotificationUserInput类型说明
function publishCallback(err) {
console.info("==========================>publishCallback=======================>"); | 名称 | 读写属性 | 类型 | 必填 | 描述 |
} | -------- | -------- | ------ | ---- | ----------------------------- |
//通知Request对象 | inputKey | 读、写 | string | 是 | 用户输入时用于标识此输入的key |
var notificationRequest = {
id: 1,
content: { - 返回值
contentType: notify.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: { void
title: "test_title",
text: "test_text", - 示例
additionalText: "test_additionalText"
} ```js
} //publish回调
} function publishCallback(err) {
Notification.publish(notificationRequest, publishCallback) console.info("==========================>publishCallback=======================>");
``` }
//通知Request对象
var notificationRequest = {
id: 1,
#### Notification.publish(request: NotificationRequest) content: {
contentType: notify.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
- 接口说明 normal: {
title: "test_title",
发布通知（Promise形式） text: "test_text",
additionalText: "test_additionalText"
- 返回值 }
}
返回值为Promise<**void**> }
Notification.publish(notificationRequest, publishCallback)
- 示例 ```
```js
//通知Request对象
var notificationRequest = { ## Notification.publish(request: NotificationRequest)
notificationId: 1,
content: { - 接口说明
contentType: notify.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: { 发布通知（Promise形式）
title: "test_title",
text: "test_text", - 返回值
additionalText: "test_additionalText"
} Promise\<void\>
}
} - 示例
Notification.publish(notificationRequest).then((void) => {
console.info("==========================>publishCallback=======================>"); ```js
}); //通知Request对象
var notificationRequest = {
``` notificationId: 1,
content: {
contentType: notify.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
#### Notification.cancel(id: number, label: string, callback: AsyncCallback<void>) title: "test_title",
text: "test_text",
- 接口说明 additionalText: "test_additionalText"
}
取消与指定id和label相匹配的已发布通知（callback形式） }
}
- cancel参数描述 Notification.publish(notificationRequest).then((void) => {
console.info("==========================>publishCallback=======================>");
| 名称 | 读写属性 | 类型 | 必填 | 描述 | });
| -------- | -------- | ------------------- | ---- | -------------------- |
| id | 只读 | number | 是 | 通知ID | ```
| lable | 只读 | string | 是 | 通知标签 |
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 |
- 返回值 ## Notification.cancel(id: number, label: string, callback: AsyncCallback\<void\>)
返回值为void - 接口说明
- 示例 取消与指定id和label相匹配的已发布通知（callback形式）
```js - cancel参数描述
//cancel回调
function cancelCallback(err) { | 名称 | 读写属性 | 类型 | 必填 | 描述 |
console.info("==========================>cancelCallback=======================>"); | -------- | -------- | --------------------- | ---- | -------------------- |
} | id | 只读 | number | 是 | 通知ID |
Notification.cancel(0, "label", cancelCallback) | label | 只读 | string | 是 | 通知标签 |
``` | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- 返回值
#### Notification.cancel(id：number, label？：string） void
- 接口说明 - 示例
取消与指定id相匹配的已发布通知,label可以指定也可以不指定（Promise形式) ```js
//cancel回调
- cancel参数描述 function cancelCallback(err) {
console.info("==========================>cancelCallback=======================>");
| 名称 | 读写属性 | 类型 | 必填 | 描述 | }
| ----- | -------- | ------ | ---- | -------- | Notification.cancel(0, "label", cancelCallback)
| id | 只读 | number | 是 | 通知ID | ```
| lable | 只读 | string | 是 | 通知标签 |
- 返回值
## Notification.cancel(id：number, label？：string）
返回值为Promise<**void**>
- 接口说明
- 示例
取消与指定id相匹配的已发布通知,label可以指定也可以不指定（Promise形式)
```js
Notification.cancel(0).then((void) => { - cancel参数描述
console.info("==========================>cancelCallback=======================>");
}); | 名称 | 读写属性 | 类型 | 必填 | 描述 |
``` | ----- | -------- | ------ | ---- | -------- |
| id | 只读 | number | 是 | 通知ID |
| label | 只读 | string | 否 | 通知标签 |
#### Notification.cancel(id: number, callback: AsyncCallback<void>) - 返回值
- 接口说明 Promise\<void\>
取消与指定id相匹配的已发布通知（callback形式) - 示例
- cancel参数描述 ```js
Notification.cancel(0).then((void) => {
| 名称 | 读写属性 | 类型 | 必填 | 描述 | console.info("==========================>cancelCallback=======================>");
| -------- | -------- | ------------------- | ---- | -------------------- | });
| id | 只读 | number | 是 | 通知ID | ```
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 |
- 返回值
## Notification.cancel(id: number, callback: AsyncCallback\<void\>)
返回值为void
- 接口说明
- 示例
取消与指定id相匹配的已发布通知（callback形式)
```js
//cancel回调 - cancel参数描述
function cancelCallback(err) {
console.info("==========================>cancelCallback=======================>"); | 名称 | 读写属性 | 类型 | 必填 | 描述 |
} | -------- | -------- | --------------------- | ---- | -------------------- |
Notification.cancel(0, cancelCallback) | id | 只读 | number | 是 | 通知ID |
``` | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- 返回值
#### Notification.cancelAll(callback: AsyncCallback<void>) void
- 接口说明 - 示例
取消所有已发布的通知（callback形式) ```js
//cancel回调
- cancelAll参数描述 function cancelCallback(err) {
console.info("==========================>cancelCallback=======================>");
| 名称 | 读写属性 | 类型 | 必填 | 描述 | }
| -------- | -------- | ------------------- | ---- | -------------------- | Notification.cancel(0, cancelCallback)
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 | ```
- 返回值
返回值为void ## Notification.cancelAll(callback: AsyncCallback\<void\>)
- 示例 - 接口说明
```js 取消所有已发布的通知（callback形式)
//cancel回调
function cancelAllback(err) { - cancelAll参数描述
console.info("==========================>cancelAllback=======================>");
} | 名称 | 读写属性 | 类型 | 必填 | 描述 |
Notification.cancelAll(cancelCallback) | -------- | -------- | --------------------- | ---- | -------------------- |
``` | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- 返回值
#### Notification.cancelAll() void
- 接口说明 - 示例
取消所有已发布的通知（callback形式) ```js
//cancel回调
- 参数描述 function cancelAllback(err) {
console.info("==========================>cancelAllback=======================>");
无参数 }
Notification.cancelAll(cancelCallback)
- 返回值 ```
返回值为void
- 示例 ## Notification.cancelAll()
```js - 接口说明
Notification.cancelAll().then((void) => {
console.info("==========================>cancelAllback=======================>"); 取消所有已发布的通知（Promise形式)
});
``` - 参数描述
#### Notification.addSlot(type: SlotType, callback: AsyncCallback<void>) 无参数
- 接口说明 - 返回值
创建通知通道（callback形式) Promise\<void\>
- addSlot参数描述 - 示例
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ```js
| -------- | -------- | ------------------- | ---- | ---------------------- | Notification.cancelAll().then((void) => {
| type | 只读 | SlotType | 是 | 要创建的通知通道的类型 | console.info("==========================>cancelAllback=======================>");
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 | });
```
- SlotType类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------------- | -------- | -------- | ---- | -------- | ## Notification.addSlot(slot: NotificationSlot, callback: AsyncCallback\<void\>)
| SOCIAL_COMMUNICATION | 只读 | SlotType | 否 | 社交类型 |
| SERVICE_INFORMATION | 只读 | SlotType | 否 | 服务类型 | - 接口说明
| CONTENT_INFORMATION | 只读 | SlotType | 否 | 内容类型 |
| OTHER_TYPES | 只读 | SlotType | 否 | 其他类型 | 创建通知通道（callback形式)
* 返回值 - addSlot参数描述
返回值为void | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | -------------------- |
* 示例 | slot | 只读 | NotificationSlot | 是 | 要创建的通知通道对象 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
```js
//addslot回调 - NotificationSlot类型说明
function addSlotCallBack(err) {
console.info("==========================>addSlotCallBack=======================>"); | 名称 | 读写属性 | 类型 | 必填 | 描述 |
} | -------------------- | -------- | --------------- | ---- | ------------------------------------------ |
Notification.addSlot(SOCIAL_COMMUNICATION, addSlotCallBack) | type | 读、写 | SlotType | 是 | 通道类型 |
``` | level | 读、写 | number | 否 | 通知级别，不设置则根据通知渠道类型有默认值 |
| desc | 读、写 | string | 否 | 通知渠道描述信息 |
| badgeFlag | 读、写 | boolean | 否 | 是否显示角标 |
| bypassDnd | 读、写 | boolean | 否 | 置是否在系统中绕过免打扰模式 |
#### Notification.addSlot(type: SlotType) | lockscreenVisibility | 读、写 | boolean | 否 | 在锁定屏幕上显示通知的模式 |
| vibrationEnabled | 读、写 | boolean | 否 | 是否可振动 |
- 接口说明 | sound | 读、写 | string | 否 | 通知提示音 |
| lightEnabled | 读、写 | boolean | 否 | 是否闪灯 |
创建通知通道（Promise形式) | lightColor | 读、写 | number | 否 | 通知灯颜色 |
| vibrationValues | 读、写 | Array\<number\> | 否 | 通知振动样式 |
- addSlot参数描述
* 返回值
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | -------- | ---- | ---------------------- | void
| type | 只读 | SlotType | 是 | 要创建的通知通道的类型 |
* 示例
- 返回值
```js
返回值为Promise<**void**> //addslot回调
function addSlotCallBack(err) {
- 示例 console.info("==========================>addSlotCallBack=======================>");
}
```js //通知slot对象
Notification.addSlot(SOCIAL_COMMUNICATION).then((void) => { var notificationSlot = {
console.info("==========================>addSlotCallback=======================>"); type: Notification.SlotType.SOCIAL_COMMUNICATION
}); }
``` Notification.addSlot(notificationSlot, addSlotCallBack)
```
#### Notification.getSlot(slotType: SlotType, callback: AsyncCallback<NotificationSlot>)
- 接口说明
## Notification.addSlot(slot: NotificationSlot)
获取一个通知通道（callback形式)
- 接口说明
- getSlot参数描述
创建通知通道（Promise形式)
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------------- | ---- | ----------------------------------------------------------- | - addSlot参数描述
| slotType | 只读 | slotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |
| callback | 只读 | AsyncCallback<NotificationSlot> | 是 | 表示被指定的回调方法 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ---------------- | ---- | -------------------- |
- 返回值 | slot | 只读 | NotificationSlot | 是 | 要创建的通知通道对象 |
返回值为void - 返回值
- 示例 Promise\<void\>
```js - 示例
//getSlot回调
function getSlotCallback(err,data) { ```js
console.info("==========================>getSlotCallback=======================>"); //通知slot对象
} var notificationSlot = {
var slotType = SOCIAL_COMMUNICATION; type: Notification.SlotType.SOCIAL_COMMUNICATION
Notification.getSlot(slotType, getSlotCallback) }
``` Notification.addSlot(notificationSlot).then((void) => {
console.info("==========================>addSlotCallback=======================>");
});
```
#### Notification.getSlot(slotType)
- 接口说明
## Notification.addSlot(type: SlotType, callback: AsyncCallback\<void\>)
获取一个通知通道（Promise形式)
- 接口说明
* getSlot参数描述
创建通知通道（callback形式)
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | -------- | ---- | ----------------------------------------------------------- | - addSlot参数描述
| slotType | 只读 | slotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
* 返回值 | -------- | -------- | --------------------- | ---- | ---------------------- |
| type | 只读 | SlotType | 是 | 要创建的通知通道的类型 |
返回值为Promise<NotificationSlot> | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
* 示例 - 返回值
```js void
var slotType = SOCIAL_COMMUNICATION;
Notification.getSlot(slotType).then((data) => { - 示例
console.info("==========================>getSlotCallback=======================>");
``` ```js
//addslot回调
function addSlotCallBack(err) {
console.info("==========================>addSlotCallBack=======================>");
#### Notification.getSlots(callback: AsyncCallback<Array<NotificationSlot>>) }
Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION, addSlotCallBack)
- 接口说明 ```
获取此应用程序的所有通知通道（callback形式)
- getSlots参数描述 ## Notification.addSlot(type: SlotType)
| 名称 | 读写属性 | 类型 | 必填 | 描述 | - 接口说明
| -------- | -------- | ------------------------------- | ---- | -------------------- |
| callback | 只读 | AsyncCallback<NotificationSlot> | 是 | 表示被指定的回调方法 | 创建通知通道（Promise形式)
- 返回值 - addSlot参数描述
返回值为void | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | -------- | ---- | ---------------------- |
- 示例 | type | 只读 | SlotType | 是 | 要创建的通知通道的类型 |
```js - 返回值
//getSlots回调
function getSlotsCallback(err,data) { Promise\<void\>
console.info("==========================>getSlotsCallback=======================>");
} - 示例
Notification.getSlots(getSlotsCallback)
``` ```js
Notification.addSlot(Notification.SlotType.SOCIAL_COMMUNICATION).then((void) => {
console.info("==========================>addSlotCallback=======================>");
});
#### Notification.getSlots() ```
- 接口说明
获取此应用程序的所有通知通道（Promise形式) ## Notification.addSlots(slots: Array\<NotificationSlot\>, callback: AsyncCallback\<void\>)
- getSlots参数描述 - 接口说明
无参数 创建多个通知通道（callback形式)
- 返回值 - addSlots数描述
返回值为Promise<Array<NotificationSlot>> | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------- | ---- | ------------------------ |
- 示例 | slots | 只读 | Array\<NotificationSlot\> | 是 | 要创建的通知通道对象数组 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
```js
Notification.getSlots().then((data) => { - 返回值
console.info("==========================>getSlotsCallback=======================>");
``` void
- 示例
#### Notification.removeSlot(slotType: SlotType, callback: AsyncCallback<void>) ```js
//addSlots回调
- 接口说明 function addSlotsCallBack(err) {
console.info("==========================>addSlotsCallBack=======================>");
根据通知通道类型删除创建的通知通道（callback形式) }
//通知slot对象
- removeSlot参数描述 var notificationSlot = {
type: Notification.SlotType.SOCIAL_COMMUNICATION
| 名称 | 读写属性 | 类型 | 必填 | 描述 | }
| -------- | -------- | ------------------- | ---- | ----------------------------------------------------------- | //通知slot array 对象
| SlotType | 只读 | SlotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 | var notificationSlotArray = new Array();
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 | notificationSlotArray[0] = notificationSlot;
- Notification.addSlots(notificationSlotArray, addSlotsCallBack)
```
返回值为void
- 示例
## Notification.addSlots(slots: Array\<NotificationSlot\>)
```js
//removeSlot回调 - 接口说明
function removeSlotCallback(err) {
console.info("==========================>removeSlotCallback=======================>"); 创建多个通知通道（Promise形式)
}
var slotType = SOCIAL_COMMUNICATION; - addSlots数描述
Notification.removeSlot(slotType,removeSlotCallback)
``` | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----- | -------- | ------------------------- | ---- | ------------------------ |
| slots | 只读 | Array\<NotificationSlot\> | 是 | 要创建的通知通道对象数组 |
#### Notification.removeSlot(slotType: SlotType) - 返回值
- 接口说明 Promise\<void\>
根据通知通道类型删除创建的通知通道（Promise形式) - 示例
- removeSlot参数描述 ```js
//通知slot对象
| 名称 | 读写属性 | 类型 | 必填 | 描述 | var notificationSlot = {
| -------- | -------- | -------- | ---- | ----------------------------------------------------------- | type: Notification.SlotType.SOCIAL_COMMUNICATION
| SlotType | 只读 | SlotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 | }
//通知slot array 对象
- var notificationSlotArray = new Array();
notificationSlotArray[0] = notificationSlot;
返回值为Promise<**void**>
Notification.addSlots(notificationSlotArray).then((void) => {
- 示例 console.info("==========================>addSlotCallback=======================>");
});
```js ```
var slotType = SOCIAL_COMMUNICATION;
Notification.removeSlot(slotType).then((void) => {
console.info("==========================>removeSlotCallback=======================>");
``` ## Notification.getSlot(slotType: SlotType, callback: AsyncCallback\<NotificationSlot\>)
- 接口说明
#### Notification.removeAllSlots(callback: AsyncCallback<void>) 获取一个通知通道（callback形式)
- 接口说明 - getSlot参数描述
删除所有通知通道（callback形式) | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------------------- | ---- | ----------------------------------------------------------- |
- removeAllSlots参数描述 | slotType | 只读 | slotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |
| callback | 只读 | AsyncCallback\<NotificationSlot\> | 是 | 表示被指定的回调方法 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------- | ---- | -------------------- | - 返回值
| callback | 只读 | AsyncCallback<void> | 是 | 表示被指定的回调方法 |
void
-
- 示例
返回值为void
```js
- 示例 //getSlot回调
function getSlotCallback(err,data) {
```js console.info("==========================>getSlotCallback=======================>");
function removeAllCallBack(err) { }
console.info("================>removeAllCallBack=======================>"); var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
} Notification.getSlot(slotType, getSlotCallback)
Notification.removeAllSlots(removeAllCallBack) ```
```
## Notification.getSlot(slotType)
#### Notification.removeAllSlots()
- 接口说明
- 接口说明
获取一个通知通道（Promise形式)
删除所有通知通道（Promise形式)
- getSlot参数描述
- removeAllSlots参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
参数无 | -------- | -------- | -------- | ---- | ----------------------------------------------------------- |
| slotType | 只读 | slotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |
-
- 返回值
返回值为Promise<**void**>
Promise\<NotificationSlot\>
- 示例
- 示例
```js
```js
Notification.removeAllSlots().then((void) => { var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
console.info("==========================>removeAllCallBack=======================>"); Notification.getSlot(slotType).then((data) => {
}); console.info("==========================>getSlotCallback=======================>");
``` });
```
#### Notification.getAllActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>)
- 接口说明
## Notification.getSlots(callback: AsyncCallback<Array\<NotificationSlot\>>)
获取活动通知（Callback形式)
- 接口说明
- getAllActiveNotifications参数描述
获取此应用程序的所有通知通道（callback形式)
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ----------------------------------------- | ---- | -------------------- | - getSlots参数描述
| callback | 只读 | AsyncCallback<Array<NotificationRequest>> | 是 | 获取活动通知回调函数 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
- | -------- | -------- | --------------------------------- | ---- | -------------------- |
| callback | 只读 | AsyncCallback\<NotificationSlot\> | 是 | 表示被指定的回调方法 |
返回值为void
- 返回值
- 示例
void
```js
function getAllActiveNotificationsCallback(err, data) { - 示例
console.info("==========================>getAllActiveNotificationsCallback=======================>");
} ```js
//getSlots回调
Notification.getAllActiveNotifications(getAllActiveNotificationsCallback); function getSlotsCallback(err,data) {
``` console.info("==========================>getSlotsCallback=======================>");
}
Notification.getSlots(getSlotsCallback)
```
#### Notification.getAllActiveNotifications()
- 接口说明
## Notification.getSlots()
获取活动通知（Promise形式)
- 接口说明
- getAllActiveNotifications参数描述
获取此应用程序的所有通知通道（Promise形式)
无
- getSlots参数描述
-
无参数
返回值为Promise<Array<NotificationRequest>>
- 返回值
- 示例
Promise\<Array\<NotificationSlot\>\>
```js
Notification.getAllActiveNotifications().then((data) => { - 示例
console.info("==========================>getAllActiveNotificationsCallback=======================>");
}); ```js
``` Notification.getSlots().then((data) => {
console.info("==========================>getSlotsCallback=======================>");
});
```
#### Notification.getActiveNotificationCount(callback: AsyncCallback<**number**>)
- 接口说明
## Notification.removeSlot(slotType: SlotType, callback: AsyncCallback\<void\>)
获取当前应用的活动通知数（Callback形式)
- 接口说明
- getActiveNotificationCount参数描述
根据通知通道类型删除创建的通知通道（callback形式)
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------- | ---- | ---------------------- | - removeSlot参数描述
| callback | 只读 | AsyncCallback<**number**> | 是 | 获取活动通知数回调函数 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
- | -------- | -------- | --------------------- | ---- | ----------------------------------------------------------- |
| SlotType | 只读 | SlotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |
返回值为void | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
- 示例 - 返回值
```js void
function getActiveNotificationCountCallback(err, data) {
console.info("==========================>getActiveNotificationCountCallback=======================>"); - 示例
}
```js
Notification.getActiveNotificationCount(getActiveNotificationCountCallback); //removeSlot回调
``` function removeSlotCallback(err) {
console.info("==========================>removeSlotCallback=======================>");
}
var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
#### Notification.getActiveNotificationCount() Notification.removeSlot(slotType,removeSlotCallback)
```
- 接口说明
获取当前应用的活动通知数（Promise形式)
## Notification.removeSlot(slotType: SlotType)
- getActiveNotificationCount参数描述
- 接口说明
无
根据通知通道类型删除创建的通知通道（Promise形式)
-
- removeSlot参数描述
返回值为Promise<**number**>
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
- 示例 | -------- | -------- | -------- | ---- | ----------------------------------------------------------- |
| SlotType | 只读 | SlotType | 是 | 通知渠道类型,目前分为社交通信、服务提醒、内容咨询和其他类型 |
```js
Notification.getActiveNotificationCount().then((data) => { - 返回值
console.info("==========================>getActiveNotificationCountCallback=======================>");
}); Promise\<void\>
```
- 示例
```js
#### Notification.getActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>) var slotType = Notification.SlotType.SOCIAL_COMMUNICATION;
Notification.removeSlot(slotType).then((void) => {
- 接口说明 console.info("==========================>removeSlotCallback=======================>");
});
获取当前应用的活动通知（Callback形式) ```
- getActiveNotifications参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ## Notification.removeAllSlots(callback: AsyncCallback\<void\>)
| -------- | -------- | ----------------------------------------- | ---- | ------------------------------ |
| callback | 只读 | AsyncCallback<Array<NotificationRequest>> | 是 | 获取当前应用的活动通知回调函数 | - 接口说明
- 删除所有通知通道（callback形式)
返回值为void - removeAllSlots参数描述
- 示例 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | -------------------- |
```js | callback | 只读 | AsyncCallback\<void\> | 是 | 表示被指定的回调方法 |
function getActiveNotificationsCallback(err, data) {
console.info("==========================>getActiveNotificationsCallback=======================>"); - 返回值
}
void
Notification.getActiveNotifications(getActiveNotificationsCallback);
``` - 示例
```js
function removeAllCallBack(err) {
#### Notification.getActiveNotifications() console.info("================>removeAllCallBack=======================>");
}
- 接口说明 Notification.removeAllSlots(removeAllCallBack)
```
获取当前应用的活动通知（Promise形式)
- getActiveNotifications参数描述
## Notification.removeAllSlots()
无
- 接口说明
-
删除所有通知通道（Promise形式)
返回值为Promise<Array<NotificationRequest>>
- removeAllSlots参数描述
- 示例
参数无
```js
Notification.getActiveNotifications().then((data) => { - 返回值
console.info("==========================>getActiveNotificationsCallback=======================>");
}); Promise\<void\>
```
- 示例
```js
## notification.setDoNotDisturbDate<sup>8+</sup> Notification.removeAllSlots().then((void) => {
console.info("==========================>removeAllCallBack=======================>");
setDoNotDisturbDate(date:DoNotDisturbDate,callback: AsyncCallback&lt;void&gt;): void });
```
设置免打扰时间。
需要权限ohos.permission.NOTIFICATION_CONTROLLER
## Notification.subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback\<void\>)
- 参数：
- 接口说明
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ---------------------- | 订阅通知并指定订阅信息（callback形式)
| date | [DoNotDisturbDate](#DoNotDisturbDate) | 是 | 免打扰时间选项 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置免打扰时间回调函数 | - subscribe参数描述
- 示例： | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------------------------- | ---- | ---------------- |
``` | subscriber | 只读 | NotificationSubscriber | 是 | 通知订阅对象 |
function setDoNotDisturbDateCallback(err) { | info | 只读 | NotificationSubscribeInfo | 是 | 订阅信息 |
console.info("setDoNotDisturbDateCallback"); | callback | 只读 | AsyncCallback\<void\> | 是 | 订阅动作回调函数 |
}
- NotificationSubscriber类型说明
var doNotDisturbDate = {
type : notification.DoNotDisturbType.TYPE_ONCE, | 名称 | 读写属性 | 类型 | 必填 | 描述 |
begin : new Date(), | ------------------------------------------------------------ | -------- | -------- | ---- | -------------------------- |
end : new Date(2021, 11, 15, 18, 0) | onConsume?:(data: SubscribeCallbackData) | 读、写 | function | 否 | 接收通知回调函数 |
} | onCancel?:(data: SubscribeCallbackData) | 读、写 | function | 否 | 删除通知回调函数 |
| onUpdate?:(data: NotificationSortingMap) | 读、写 | function | 否 | 更新通知排序回调函数 |
notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback); | onConnect?:() | 读、写 | function | 否 | 注册订阅回调函数 |
``` | onDisconnect?:() | 读、写 | function | 否 | 取消订阅回调函数 |
| onDestroy?:() | 读、写 | function | 否 | 服务失联回调函数 |
## notification.setDoNotDisturbDate<sup>8+</sup> | onDoNotDisturbDateChange?:(mode: notification.DoNotDisturbDate) | 读、写 | function | 否 | 免打扰时间选项变更回调函数 |
setDoNotDisturbDate(date:DoNotDisturbDate): Promise\<void\> - SubscribeCallbackData 类型说明
设置免打扰时间。 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------------- | -------- | ---------------------- | ---- | -------- |
需要权限ohos.permission.NOTIFICATION_CONTROLLER | request | 只读 | NotificationRequest | 是 | 通知内容 |
| sortingMap | 只读 | NotificationSortingMap | 否 | 排序信息 |
- 参数： | reason | 只读 | number | 否 | 删除原因 |
| sound | 只读 | string | 否 | 通知声音 |
| 参数名 | 类型 | 必填 | 说明 | | vibrationValues | 只读 | Array\<number\> | 否 | 通知震动 |
| ------ | ------------------------------------- | ---- | -------------- |
| date | [DoNotDisturbDate](#DoNotDisturbDate) | 是 | 免打扰时间选项 | - NotificationSortingMap类型说明
- 返回值： | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | ------------------------------------ | ---- | ---------------- |
| 类型 | 说明 | | sortings | 只读 | {[key: string]: NotificationSorting} | 是 | 通知排序信息数组 |
| --------------- | --------------- | | sortedHashCode | 只读 | Array\<string\> | 是 | 通知唯一标识数组 |
| Promise\<void\> | Promise方式返回 |
- NotificationSorting 类型说明
- 示例：
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
``` | -------- | -------- | ---------------- | ---- | ------------ |
var doNotDisturbDate = { | slot | 只读 | NotificationSlot | 是 | 通知通道内容 |
type : notification.DoNotDisturbType.TYPE_ONCE, | hashCode | 只读 | string | 是 | 通知唯一标识 |
begin : new Date(), | ranking | 只读 | number | 是 | 通知排序序号 |
end : new Date(2021, 11, 15, 18, 0)
} - DoNotDisturbType类型说明
notification.setDoNotDisturbDate(doNotDisturbDate).then(() => {
console.info("setDoNotDisturbDatePromise"); | 名称 | 读写属性 | 类型 | 描述 |
}); | ------------ | -------- | --------------------- | ---------------------------------------- |
``` | TYPE_NONE | 只读 | enum DoNotDisturbType | 非通知勿扰类型 |
| TYPE_ONCE | 只读 | enum DoNotDisturbType | 以设置时间段(只看小时和分钟)一次执行勿扰 |
| TYPE_DAILY | 只读 | enum DoNotDisturbType | 以设置时间段(只看小时和分钟)每天执行勿扰 |
| TYPE_CLEARLY | 只读 | enum DoNotDisturbType | 以设置时间段(明确年月日时分)执行勿扰 |
## notification.getDoNotDisturbDate<sup>8+</sup>
- DoNotDisturbDate类型说明
getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>): void
| 名称 | 读写属性 | 类型 | 描述 |
查询免打扰时间。 | ----- | -------- | ---------------- | ------------------------ |
| type | 读写 | DoNotDisturbType | 指定免打扰设置的时间类型 |
需要权限ohos.permission.NOTIFICATION_CONTROLLER | begin | 读写 | Date | 指定免打扰设置的起点时间 |
| end | 读写 | Date | 指定免打扰设置的终点时间 |
- 参数：
- NotificationSubscribeInfo类型说明
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------------- | ---- | ---------------------- | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| callback | AsyncCallback&lt;[DoNotDisturbDate](#DoNotDisturbDate)&gt; | 是 | 查询免打扰时间回调函数 | | ----------- | -------- | --------------- | ---- | ------------------------------- |
| bundleNames | 读、写 | Array\<string\> | 否 | 指定订阅哪些包名的APP发来的通知 |
| userId | 读、写 | number | 否 | 指定订阅哪个用户下发来的通知 |
- 示例：
- 返回值
```
function getDoNotDisturbDateCallback(err,data) { void
console.info("getDoNotDisturbDateCallback");
} - 示例
notification.getDoNotDisturbDate(getDoNotDisturbDateCallback); ```js
``` //subscribe回调
function subscribeCallback(err) {
console.info("==========================>subscribeCallback=======================>");
}
## notification.getDoNotDisturbDate<sup>8+</sup> function onConsumeCallback(err, data) {
console.info("==========================>onConsumeCallback=======================>");
getDoNotDisturbDate(): Promise&lt;DoNotDisturbDate&gt; }
var subscriber = {
查询免打扰时间。 onConsume: onConsumeCallback
}
需要权限ohos.permission.NOTIFICATION_CONTROLLER var info = {
bundleNames: ["bundleName1","bundleName2"]
- 返回值： }
Notification.subscribe(subscriber, info, subscribeCallback);
| 类型 | 说明 | ```
| ---------------------------------------------------- | ----------------------------- |
| Promise&lt;[DoNotDisturbDate](#DoNotDisturbDate)&gt; | Promise方式返回的免打时间信息 |
- 示例： ## Notification.subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>)
``` - 接口说明
notification.getDoNotDisturbDate().then((data) => {
console.info("getDoNotDisturbDatePromise"); 订阅通知并指定订阅信息（callback形式)
});
``` - subscribe参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ---------------------- | ---- | ---------------- |
## notification.supportDoNotDisturbMode<sup>8+</sup> | subscriber | 只读 | NotificationSubscriber | 是 | 通知订阅对象 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 订阅动作回调函数 |
supportDoNotDisturbMode(callback: AsyncCallback\<boolean\>): void
- 返回值
查询是否支持勿扰模式功能。
void
需要权限ohos.permission.NOTIFICATION_CONTROLLER
- 示例
- 参数：
```js
| 参数名 | 类型 | 必填 | 说明 | function subscribeCallback(err) {
| -------- | ------------------------- | ---- | -------------------------------- | console.info("==========================>subscribeCallback=======================>");
| callback | AsyncCallback\<boolean\>; | 是 | 查询是否支持勿扰模式功能回调函数 | }
function onConsumeCallback(err, data) {
- 示例： console.info("==========================>onConsumeCallback=======================>");
}
``` var subscriber = {
function supportDoNotDisturbModeCallback(err,data) { onConsume: onConsumeCallback
console.info("supportDoNotDisturbModeCallback"); }
} Notification.subscribe(subscriber, subscribeCallback);
```
notification.supportDoNotDisturbMode(supportDoNotDisturbModeCallback);
```
## Notification.subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo)
## notification.supportDoNotDisturbMode<sup>8+</sup> - 接口说明
supportDoNotDisturbMode(): Promise\<boolean\> 订阅通知并指定订阅信息（Promise形式)
查询是否支持勿扰模式功能。 - subscribe参数描述
需要权限ohos.permission.NOTIFICATION_CONTROLLER | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------------------------- | ---- | ------------ |
- 返回值： | subscriber | 只读 | NotificationSubscriber | 是 | 通知订阅对象 |
| info | 只读 | NotificationSubscribeInfo | 否 | 订阅信息 |
| 类型 | 说明 |
| ------------------ | ------------------------- | - 返回值
| Promise\<boolean\> | Promise方式返回的支持结果 |
Promise\<void\>
- 示例： - 示例
``` ```js
notification.supportDoNotDisturbMode().then((data) => { function onConsumeCallback(err, data) {
console.info("supportDoNotDisturbModePromise"); console.info("==========================>onConsumeCallback=======================>");
}); }
``` var subscriber = {
onConsume: onConsumeCallback
};
Notification.subscribe(subscriber).then((void) => {
## DoNotDisturbType<sup>8+</sup> console.info("==========================>subscribeCallback=======================>");
});
免打扰时间类型。 ```
| 名称 | 默认值 | 说明 |
| ------------ | ------ | -------------------------------------- |
| TYPE_NONE | 0 | 非通知勿扰类型 | ## Notification.unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback\<void\>)
| TYPE_ONCE | 1 | 设置时间段内执行一次勿扰 |
| TYPE_DAILY | 2 | 设置时间段(只看小时和分钟)每天执行勿扰 | - 接口说明
| TYPE_CLEARLY | 3 | 以设置时间段(明确年月日时分)执行勿扰 |
取消订阅（callbcak形式)
- unsubscribe参数描述
## DoNotDisturbDate<sup>8+</sup>
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
免打扰时间。 | ---------- | -------- | ---------------------- | ---- | -------------------- |
| subscriber | 只读 | NotificationSubscriber | 是 | 通知订阅对象 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 取消订阅动作回调函数 |
### 属性
- 返回值
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ----- | ------------------------------------- | ---- | ---- | ------------------------ | void
| type | [DoNotDisturbType](#DoNotDisturbType) | 是 | 是 | 指定免打扰设置的时间类型 |
| begin | Date | 是 | 是 | 指定免打扰设置的起点时间 | - 示例
| end | Date | 是 | 是 | 指定免打扰设置的结束时间 |
```js
function unsubscribeCallback(err) {
console.info("==========================>unsubscribeCallback=======================>");
#### WantAgent接口 }
function onConsumeCallback(err, data) {
#### 导入模块 console.info("==========================>onConsumeCallback=======================>");
}
```js var subscriber = {
import WantAgent from '@ohos.wantAgent'; onConsume: onConsumeCallback
``` }
Notification.unsubscribe(subscriber, unsubscribeCallback);
#### WantAgent.getWantAgent(info: WantAgentInfo, callback: AsyncCallback<WantAgent>) ```
- 接口说明
创建WantAgent（callback形式） ## Notification.unsubscribe(subscriber: NotificationSubscriber)
- getWantAgent参数描述 - 接口说明
取消订阅（Promise形式)
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------ | ---- | ----------------------- | - unsubscribe参数描述
| info | 只读 | WantAgentInfo | 是 | WantAgent信息 |
| callback | 只读 | AsyncCallback<WantAgent> | 是 | 创建WantAgent的回调方法 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ---------------------- | ---- | ------------ |
- WantAgentInfo类型说明 | subscriber | 只读 | NotificationSubscriber | 是 | 通知订阅对象 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | - 返回值
| -------------- | -------- | ------------------------------- | ---- | ---------------------- |
| wants | 读、写 | Array<Want> | 是 | 将被执行的动作列表 | Promise\<void\>
| operationType | 读、写 | wantAgent.OperationType | 是 | 动作类型 |
| requestCode | 读、写 | number | 是 | 使用者定义的一个私有值 | - 示例
| wantAgentFlags | 读、写 | Array<wantAgent.WantAgentFlags> | 否 | 动作执行属性 |
| extraInfo | 读、写 | {[key: string]: any} | 否 | 额外数据 | ```js
function onConsumeCallback(err, data) {
- console.info("==========================>onConsumeCallback=======================>");
WantAgentFlags类型说明 }
var subscriber = {
onConsume: onConsumeCallback
| 名称 | 读写属性 | 类型 | 必填 | 描述 | };
| ------------------- | -------- | ---- | ---- | ------------------------------------------------------------ | Notification.unsubscribe(subscriber).then((void) => {
| ONE_TIME_FLAG | 只读 | enum | 否 | WantAgent仅能使用一次 | console.info("==========================>unsubscribeCallback=======================>");
| NO_BUILD_FLAG | 只读 | enum | 否 | 如果描述WantAgent对象不存在，则不创建它，直接返回null | });
| CANCEL_PRESENT_FLAG | 只读 | enum | 否 | 在生成一个新的WantAgent对象前取消已存在的一个WantAgent对象 | ```
| UPDATE_PRESENT_FLAG | 只读 | enum | 否 | 使用新的WantAgent的额外数据替换已存在的WantAgent中的额外数据 |
| CONSTANT_FLAG | 只读 | enum | 否 | WantAgent是不可变的 |
| REPLACE_ELEMENT | 只读 | enum | 否 | 当前Want中的element属性可被WantAgent.trigger()中Want的element属性取代 |
| REPLACE_ACTION | 只读 | enum | 否 | 当前Want中的action属性可被WantAgent.trigger()中Want的action属性取代 | ## Notification.enableNotification(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>)
| 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属性取代 |
设定指定包的通知使能状态（Callback形式)
- OperationType类型说明
- enableNotification参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------------- | -------- | ---- | ---- | ----------------------- | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| UNKNOWN_TYPE | 只读 | enum | 否 | 不识别的类型 | | -------- | -------- | --------------------- | ---- | -------------------- |
| START_ABILITY | 只读 | enum | 否 | 开启一个有页面的Ability | | bundle | 只读 | BundleOption | 是 | 指定包信息 |
| START_ABILITIES | 只读 | enum | 否 | 开启多个有页面的Ability | | enable | 只读 | boolean | 是 | 使能状态 |
| START_SERVICE | 只读 | enum | 否 | 开启一个无页面的ability | | callback | 只读 | AsyncCallback\<void\> | 是 | 设定通知使能回调函数 |
| SEND_COMMON_EVENT | 只读 | enum | 否 | 发送一个公共事件 |
- BundleOption类型说明
-
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
返回值为void | ------ | -------- | ------ | ---- | ------ |
| bundle | 读/写 | string | 是 | 包名 |
- 示例 | uid | 读/写 | number | 否 | 用户id |
- 返回值
```js
import wantAgent from '@ohos.wantAgent'; void
import { OperationType, Flags } from '@ohos.wantagent';
- 示例
//getWantAgent回调
function getWantAgentCallback(err, data) { ```js
console.info("==========================>getWantAgentCallback=======================>"); function enableNotificationCallback(err) {
} console.info("==========================>enableNotificationCallback=======================>");
//WantAgentInfo对象 }
var wantAgentInfo = { var bundle = {
wants: [ bundle: "bundleName1";
{ }
deviceId: "deviceId", Notification.enableNotification(bundle, false, enableNotificationCallback);
bundleName: "com.neu.setResultOnAbilityResultTest1", ```
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE", ## Notification.enableNotification(bundle: BundleOption, enable: boolean)
uri: "key={true,true,false}",
parameters: - 接口说明
{
mykey0: 2222, 设定指定包的通知使能状态（Promise形式)
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", - enableNotification参数描述
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false], | 名称 | 读写属性 | 类型 | 必填 | 描述 |
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], | ------ | -------- | ------------ | ---- | ---------- |
mykey6: true, | bundle | 只读 | BundleOption | 是 | 指定包信息 |
} | enable | 只读 | boolean | 是 | 使能状态 |
}
], - 返回值
operationType: OperationType.START_ABILITIES,
requestCode: 0, Promise\<void\>
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG]
} - 示例
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) ```js
``` var bundle = {
bundle: "bundleName1";
}
Notification.enableNotification(bundle, false).then((void) => {
#### WantAgent.getWantAgent(info: WantAgentInfo): Promise<WantAgent> console.info("==========================>enableNotificationCallback=======================>");
});
- 接口说明 ```
创建WantAgent（Promise形式）
- getWantAgent参数描述 ## Notification.isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback\<boolean\>)
- 接口说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------------- | ---- | ------------- | 获取指定包的通知使能状态（Callback形式)
| info | 只读 | WantAgentInfo | 是 | WantAgent信息 |
- isNotificationEnabled参数描述
-
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
返回值为Promise<WantAgent> | -------- | -------- | --------------------- | ---- | ------------------------ |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
- 示例 | callback | 只读 | AsyncCallback\<void\> | 是 | 获取通知使能状态回调函数 |
```js - 返回值
import wantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; void
//WantAgentInfo对象 - 示例
var wantAgentInfo = {
wants: [ ```js
{ function isNotificationEnabledCallback(err, data) {
deviceId: "deviceId", console.info("==========================>isNotificationEnabledCallback=======================>");
bundleName: "com.neu.setResultOnAbilityResultTest1", }
abilityName: "com.example.test.MainAbility", var bundle = {
action: "action1", bundle: "bundleName1";
entities: ["entity1"], }
type: "MIMETYPE", Notification.isNotificationEnabled(bundle, isNotificationEnabledCallback);
uri: "key={true,true,false}", ```
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3], ## Notification.isNotificationEnabled(bundle: BundleOption)
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss", - 接口说明
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], 获取指定包的通知使能状态（Promise形式)
mykey6: true,
} - isNotificationEnabled参数描述
}
], | 名称 | 读写属性 | 类型 | 必填 | 描述 |
operationType: OperationType.START_ABILITIES, | ------ | -------- | ------------ | ---- | ---------- |
requestCode: 0, | bundle | 只读 | BundleOption | 是 | 指定包信息 |
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG]
} - 返回值
wantAgent.getWantAgent(wantAgentInfo).then((data) => { Promise\<boolean\>
console.info("==========================>getWantAgentCallback=======================>");
}); - 示例
```
```js
var bundle = {
bundle: "bundleName1";
#### WantAgent.getBundleName(agent: WantAgent, callback: AsyncCallback<string>) }
Notification.isNotificationEnabled(bundle).then((data) => {
- 接口说明 console.info("==========================>isNotificationEnabledCallback=======================>");
});
获取WantAgent实例的包名（callback形式） ```
- getBundleName参数描述
## Notification.isNotificationEnabled(callback: AsyncCallback\<boolean\>)
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | --------------------------------- | - 接口说明
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
| callback | 只读 | AsyncCallback<string> | 是 | 获取WantAgent实例的包名的回调方法 | 获取通知使能状态（Callback形式)
- 返回值为void - isNotificationEnabled参数描述
- 示例 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | ------------------------ |
```js | callback | 只读 | AsyncCallback\<void\> | 是 | 获取通知使能状态回调函数 |
import wantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; - 返回值
//wantAgent对象 void
var WantAgent;
- 示例
//getWantAgent回调
function getWantAgentCallback(err, data) { ```js
console.info("==========================>getWantAgentCallback=======================>"); function isNotificationEnabledCallback(err, data) {
if (err.code == 0) { console.info("==========================>isNotificationEnabledCallback=======================>");
WantAgent = data; }
} else {
console.info('----getWantAgent failed!----'); Notification.isNotificationEnabled(isNotificationEnabledCallback);
} ```
}
//WantAgentInfo对象
var wantAgentInfo = {
wants: [ ## Notification.isNotificationEnabled()
{
deviceId: "deviceId", - 接口说明
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility", 获取通知使能状态（Promise形式)
action: "action1",
entities: ["entity1"], - isNotificationEnabled参数描述
type: "MIMETYPE",
uri: "key={true,true,false}", | 名称 | 读写属性 | 类型 | 必填 | 描述 |
parameters: | ------ | -------- | ------------ | ---- | ---------- |
{ | bundle | 只读 | BundleOption | 是 | 指定包信息 |
mykey0: 2222,
mykey1: [1, 2, 3], - 返回值
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss", Promise\<boolean\>
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], - 示例
mykey6: true,
} ```js
} Notification.isNotificationEnabled().then((data) => {
], console.info("==========================>isNotificationEnabledCallback=======================>");
operationType: OperationType.START_ABILITIES, });
requestCode: 0, ```
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG]
}
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) ## Notification.displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback\<void\>)
//getBundleName回调 - 接口说明
function getBundleNameCallback(err, data) {
console.info("==========================>getBundleNameCallback=======================>"); 设定指定包的角标使能状态（Callback形式)
}
wantAgent.getBundleName(WantAgent, getBundleNameCallback) - displayBadge参数描述
```
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | -------------------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
#### WantAgent.getBundleName(agent: WantAgent): Promise<string> | enable | 只读 | boolean | 是 | 使能状态 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 设定角标使能回调函数 |
- 接口说明
- 返回值
获取WantAgent实例的包名（Promise形式）
void
- getBundleName参数描述
- 示例
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ```js
| ----- | -------- | --------- | ---- | ------------- | function displayBadgeCallback(err) {
| agent | 只读 | WantAgent | 是 | WantAgent对象 | console.info("==========================>displayBadgeCallback=======================>");
}
- var bundle = {
bundle: "bundleName1";
返回值为Promise<string> }
Notification.displayBadge(bundle, false, displayBadgeCallback);
- 示例 ```
```js
import wantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; ## Notification.displayBadge(bundle: BundleOption, enable: boolean)
//wantAgent对象 - 接口说明
var WantAgent;
设定指定包的角标使能状态（Promise形式)
//WantAgentInfo对象
var wantAgentInfo = { - displayBadge参数描述
wants: [
{ | 名称 | 读写属性 | 类型 | 必填 | 描述 |
deviceId: "deviceId", | ------ | -------- | ------------ | ---- | ---------- |
bundleName: "com.neu.setResultOnAbilityResultTest1", | bundle | 只读 | BundleOption | 是 | 指定包信息 |
abilityName: "com.example.test.MainAbility", | enable | 只读 | boolean | 是 | 使能状态 |
action: "action1",
entities: ["entity1"], - 返回值
type: "MIMETYPE",
uri: "key={true,true,false}", Promise\<void\>
parameters:
{ - 示例
mykey0: 2222,
mykey1: [1, 2, 3], ```js
mykey2: "[1, 2, 3]", var bundle = {
mykey3: "ssssssssssssssssssssssssss", bundle: "bundleName1";
mykey4: [false, true, false], }
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], Notification.displayBadge(bundle, false).then((void) => {
mykey6: true, console.info("==========================>displayBadgeCallback=======================>");
} });
} ```
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] ## Notification.isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback\<boolean\>)
}
- 接口说明
wantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); 获取指定包的角标使能状态（Callback形式)
WantAgent = data;
}); - isBadgeDisplayed参数描述
wantAgent.getBundleName(WantAgent).then((data) => { | 名称 | 读写属性 | 类型 | 必填 | 描述 |
console.info("==========================>getBundleNameCallback=======================>"); | -------- | -------- | --------------------- | ---- | ------------------------ |
}); | bundle | 只读 | BundleOption | 是 | 指定包信息 |
``` | callback | 只读 | AsyncCallback\<void\> | 是 | 获取角标使能状态回调函数 |
- 返回值
#### WantAgent.getUid(agent: WantAgent, callback: AsyncCallback<number>) void
- 接口说明 - 示例
获取WantAgent实例的用户ID（callback形式） ```js
function isBadgeDisplayedCallback(err, data) {
- getUid参数描述 console.info("==========================>isBadgeDisplayedCallback=======================>");
}
var bundle = {
| 名称 | 读写属性 | 类型 | 必填 | 描述 | bundle: "bundleName1";
| -------- | -------- | --------------------- | ---- | ----------------------------------- | }
| agent | 只读 | WantAgent | 是 | WantAgent对象 | Notification.isBadgeDisplayed(bundle, isBadgeDisplayedCallback);
| callback | 只读 | AsyncCallback<number> | 是 | 获取WantAgent实例的用户ID的回调方法 | ```
- 返回值为void
- 示例 ## Notification.isBadgeDisplayed(bundle: BundleOption)
```js - 接口说明
import wantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; 获取指定包的角标使能状态（Promise形式)
//wantAgent对象 - isBadgeDisplayed参数描述
var WantAgent;
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
//getWantAgent回调 | ------ | -------- | ------------ | ---- | ---------- |
function getWantAgentCallback(err, data) { | bundle | 只读 | BundleOption | 是 | 指定包信息 |
console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) { - 返回值
WantAgent = data;
} else { Promise\<boolean\>
console.info('----getWantAgent failed!----');
} - 示例
}
//WantAgentInfo对象 ```js
var wantAgentInfo = { var bundle = {
wants: [ bundle: "bundleName1";
{ }
deviceId: "deviceId", Notification.isBadgeDisplayed(bundle).then((data) => {
bundleName: "com.neu.setResultOnAbilityResultTest1", console.info("==========================>isBadgeDisplayedCallback=======================>");
abilityName: "com.example.test.MainAbility", });
action: "action1", ```
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters: ## Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback\<void\>)
{
mykey0: 2222, - 接口说明
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", 设定指定包的通知通道状态（Callback形式)
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false], - setSlotByBundle参数描述
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true, | 名称 | 读写属性 | 类型 | 必填 | 描述 |
} | -------- | -------- | --------------------- | ---- | -------------------- |
} | bundle | 只读 | BundleOption | 是 | 指定包信息 |
], | slot | 只读 | NotificationSlot | 是 | 通知通道 |
operationType: OperationType.START_ABILITIES, | callback | 只读 | AsyncCallback\<void\> | 是 | 设定通知通道回调函数 |
requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] - 返回值
}
void
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
- 示例
//getUid回调
function getUidCallback(err, data) { ```js
console.info("==========================>getUidCallback=======================>"); function setSlotByBundleCallback(err) {
} console.info("==========================>setSlotByBundleCallback=======================>");
wantAgent.getUid(WantAgent, getUidCallback) }
``` var bundle = {
bundle: "bundleName1";
}
var notificationSlot = {
#### WantAgent.getUid(agent: WantAgent): Promise<number> type: Notification.SlotType.SOCIAL_COMMUNICATION
}
- 接口说明 Notification.setSlotByBundle(bundle, notificationSlot, setSlotByBundleCallback);
```
获取WantAgent实例的用户ID（Promise形式）
- getUid参数描述
## Notification.setSlotByBundle(bundle: BundleOption, slot: NotificationSlot)
| 名称 | 读写属性 | 类型 | 必填 | 描述 | - 接口说明
| ----- | -------- | --------- | ---- | ------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 | 设定指定包的角标使能状态（Promise形式)
- - setSlotByBundle参数描述
返回值为Promise<number> | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------ | -------- | ------------ | ---- | ---------- |
- 示例 | bundle | 只读 | BundleOption | 是 | 指定包信息 |
| enable | 只读 | boolean | 是 | 使能状态 |
```js
import wantAgent from '@ohos.wantAgent'; - 返回值
import { OperationType, Flags } from '@ohos.wantagent';
Promise\<void\>
//wantAgent对象
var WantAgent; - 示例
//WantAgentInfo对象 ```js
var wantAgentInfo = { var bundle = {
wants: [ bundle: "bundleName1";
{ }
deviceId: "deviceId", var notificationSlot = {
bundleName: "com.neu.setResultOnAbilityResultTest1", type: Notification.SlotType.SOCIAL_COMMUNICATION
abilityName: "com.example.test.MainAbility", }
action: "action1", Notification.displayBadge(bundle, notificationSlot).then((void) => {
entities: ["entity1"], console.info("==========================>setSlotByBundleCallback=======================>");
type: "MIMETYPE", });
uri: "key={true,true,false}", ```
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3], ## Notification.getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback<Array\<NotificationSlot\>>)
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss", - 接口说明
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], 获取指定包的通知通道（Callback形式)
mykey6: true,
} - getSlotsByBundle参数描述
}
], | 名称 | 读写属性 | 类型 | 必填 | 描述 |
operationType: OperationType.START_ABILITIES, | -------- | -------- | ---------------------------------------- | ---- | -------------------- |
requestCode: 0, | bundle | 只读 | BundleOption | 是 | 指定包信息 |
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] | callback | 只读 | AsyncCallback<Array\<NotificationSlot\>> | 是 | 获取通知通道回调函数 |
}
- 返回值
wantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>"); void
WantAgent = data;
}); - 示例
wantAgent.getUid(WantAgent).then((data) => { ```js
console.info("==========================>getUidCallback=======================>"); function getSlotsByBundleCallback(err, data) {
}); console.info("==========================>getSlotsByBundleCallback=======================>");
``` }
var bundle = {
bundle: "bundleName1";
}
#### WantAgent.cancel(agent: WantAgent, callback: AsyncCallback<void>) Notification.getSlotsByBundle(bundle, getSlotsByBundleCallback);
```
- 接口说明
取消WantAgent实例（callback形式）
## Notification.getSlotsByBundle(bundle: BundleOption)
- cancel参数描述
- 接口说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | 获取指定包的通知通道（Promise形式)
| -------- | -------- | ------------------- | ---- | --------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 | - getSlotsByBundle参数描述
| callback | 只读 | AsyncCallback<void> | 是 | 取消WantAgent实例的回调方法 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
- 返回值为void | ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
- 示例
- 返回值
```js
import wantAgent from '@ohos.wantAgent'; Promise<Array\<NotificationSlot\>>
import { OperationType, Flags } from '@ohos.wantagent';
- 示例
//wantAgent对象
var WantAgent; ```js
var bundle = {
//getWantAgent回调 bundle: "bundleName1";
function getWantAgentCallback(err, data) { }
console.info("==========================>getWantAgentCallback=======================>"); Notification.getSlotsByBundle(bundle).then((data) => {
if (err.code == 0) { console.info("==========================>getSlotsByBundleCallback=======================>");
WantAgent = data; });
} else { ```
console.info('----getWantAgent failed!----');
}
}
//WantAgentInfo对象 ## Notification.getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback\<number\>)
var wantAgentInfo = {
wants: [ - 接口说明
{
deviceId: "deviceId", 获取指定包的通知通道数（Callback形式)
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility", - getSlotNumByBundle参数描述
action: "action1",
entities: ["entity1"], | 名称 | 读写属性 | 类型 | 必填 | 描述 |
type: "MIMETYPE", | -------- | -------- | ------------------------- | ---- | ---------------------- |
uri: "key={true,true,false}", | bundle | 只读 | BundleOption | 是 | 指定包信息 |
parameters: | callback | 只读 | AsyncCallback\<number\> | 是 | 获取通知通道数回调函数 |
{
mykey0: 2222, - 返回值
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", void
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false], - 示例
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true, ```js
} function getSlotNumByBundle(err, data) {
} console.info("==========================>getSlotNumByBundleCallback=======================>");
], }
operationType: OperationType.START_ABILITIES, var bundle = {
requestCode: 0, bundle: "bundleName1";
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] }
} Notification.getSlotNumByBundle(bundle, getSlotNumByBundleCallback);
```
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//cancel回调
function cancelCallback(err, data) { ## Notification.getSlotNumByBundle(bundle: BundleOption)
console.info("==========================>cancelCallback=======================>");
} - 接口说明
wantAgent.cancel(WantAgent, cancelCallback)
``` 获取指定包的通知通道数（Promise形式)
- getSlotNumByBundle参数描述
#### WantAgent.cancel(agent: WantAgent): Promise<void> | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------ | -------- | ------------ | ---- | ---------- |
- 接口说明 | bundle | 只读 | BundleOption | 是 | 指定包信息 |
取消WantAgent实例（Promise形式） - 返回值
- cancel参数描述 Promise\<number\>
- 示例
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----- | -------- | --------- | ---- | ------------- | ```js
| agent | 只读 | WantAgent | 是 | WantAgent对象 | var bundle = {
bundle: "bundleName1";
- }
Notification.getSlotNumByBundle(bundle).then((data) => {
返回值为Promise<void> console.info("==========================>getSlotNumByBundleCallback=======================>");
});
- 示例 ```
```js
import wantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; ## Notification.remove(bundle: BundleOption, notificationKey: NotificationKey, callback: AsyncCallback\<void\>)
//wantAgent对象 - 接口说明
var WantAgent;
删除指定通知（Callback形式)
//WantAgentInfo对象
var wantAgentInfo = { - remove参数描述
wants: [
{ | 名称 | 读写属性 | 类型 | 必填 | 描述 |
deviceId: "deviceId", | --------------- | -------- | --------------------- | ---- | -------------------- |
bundleName: "com.neu.setResultOnAbilityResultTest1", | bundle | 只读 | BundleOption | 是 | 指定包信息 |
abilityName: "com.example.test.MainAbility", | notificationKey | 只读 | NotificationKey | 是 | 通知键值 |
action: "action1", | callback | 只读 | AsyncCallback\<void\> | 是 | 删除指定通知回调函数 |
entities: ["entity1"],
type: "MIMETYPE", - NotificationKey类型说明
uri: "key={true,true,false}",
parameters: | 名称 | 读写属性 | 类型 | 必填 | 描述 |
{ | ----- | -------- | ------ | ---- | -------- |
mykey0: 2222, | id | 读、写 | number | 是 | 通知ID |
mykey1: [1, 2, 3], | label | 读、写 | string | 否 | 通知标签 |
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss", - 返回值
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], void
mykey6: true,
} - 示例
}
], ```js
operationType: OperationType.START_ABILITIES, function removeCallback(err) {
requestCode: 0, console.info("==========================>removeCallback=======================>");
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG] }
} var bundle = {
bundle: "bundleName1";
wantAgent.getWantAgent(wantAgentInfo).then((data) => { }
console.info("==========================>getWantAgentCallback=======================>"); var notificationKey = {
WantAgent = data; id: 0;
}); label: "label";
}
wantAgent.cancel(WantAgent).then((data) => { Notification.remove(bundle, notificationKey, removeCallback);
console.info("==========================>cancelCallback=======================>"); ```
});
```
## Notification.remove(bundle: BundleOption, notificationKey: NotificationKey)
#### WantAgent.trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback<CompleteData>) - 接口说明
- 接口说明 删除指定通知（Promise形式)
主动激发WantAgent实例（callback形式） - remove参数描述
- trigger参数描述 | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------------- | -------- | --------------- | ---- | ---------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | notificationKey | 只读 | NotificationKey | 是 | 通知键值 |
| ----------- | -------- | --------------------------- | ---- | ------------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 | - 返回值
| triggerInfo | 只读 | TriggerInfo | 是 | TriggerInfo对象 |
| callback | 只读 | AsyncCallback<CompleteData> | 是 | 主动激发WantAgent实例的回调方法 | Promise\<void\>
- TriggerInfo类型说明 - 示例
| 名称 | 读写属性 | 类型 | 必填 | 描述 | ```js
| ---------- | -------- | -------------------- | ---- | ----------- | var bundle = {
| code | 读、写 | number | 是 | result code | bundle: "bundleName1";
| want | 读、写 | Want | 否 | Want | }
| permission | 读、写 | string | 否 | 权限定义 | var notificationKey = {
| extraInfo | 读、写 | {[key: string]: any} | 否 | 额外数据 | id: 0;
label: "label";
- 返回值为void }
- 示例 Notification.remove(bundle, notificationKey).then((void) => {
console.info("==========================>removeCallback=======================>");
```js });
import wantAgent from '@ohos.wantAgent'; ```
import { OperationType, Flags } from '@ohos.wantagent';
//wantAgent对象
var WantAgent; ## Notification.remove(hashCode: string, callback: AsyncCallback\<void\>)
//getWantAgent回调 - 接口说明
function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>"); 删除指定通知（Callback形式)
if (err.code == 0) {
WantAgent = data; - remove参数描述
} else {
console.info('----getWantAgent failed!----'); | 名称 | 读写属性 | 类型 | 必填 | 描述 |
} | -------- | -------- | --------------------- | ---- | -------------------- |
} | hashCode | 只读 | string | 是 | 通知唯一ID |
//WantAgentInfo对象 | callback | 只读 | AsyncCallback\<void\> | 是 | 删除指定通知回调函数 |
var wantAgentInfo = {
wants: [ - 返回值
{
deviceId: "deviceId", void
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility", - 示例
action: "action1",
entities: ["entity1"], ```js
type: "MIMETYPE", function removeCallback(err) {
uri: "key={true,true,false}", console.info("==========================>removeCallback=======================>");
parameters: }
{
mykey0: 2222, Notification.remove(hashCode, removeCallback);
mykey1: [1, 2, 3], ```
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], ## Notification.remove(hashCode: string)
mykey6: true,
} - 接口说明
}
], 删除指定通知（Promise形式)
operationType: OperationType.START_ABILITIES,
requestCode: 0, - remove参数描述
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG]
} | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------- | ---- | ---------- |
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) | hashCode | 只读 | string | 是 | 通知唯一ID |
//cancel回调 - 返回值
function triggerCallback(err, data) {
console.info("==========================>triggerCallback=======================>"); Promise\<void\>
}
wantAgent.trigger(WantAgent, triggerCallback) - 示例
```
```js
Notification.remove(hashCode).then((void) => {
console.info("==========================>removeCallback=======================>");
#### WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback<boolean>) });
```
- 接口说明
判断两个WantAgent实例是否相等（callback形式）
## Notification.removeAll(bundle: BundleOption, callback: AsyncCallback\<void\>)
- equal参数描述
- 接口说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 | 删除指定包的所有通知（Callback形式)
| ---------- | -------- | ---------------------- | ---- | --------------------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 | - removeAll参数描述
| otherAgent | 只读 | WantAgent | 是 | WantAgent对象 |
| callback | 只读 | AsyncCallback<boolean> | 是 | 判断两个WantAgent实例是否相等的回调方法 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | ---------------------------- |
- 返回值为void | bundle | 只读 | BundleOption | 是 | 指定包信息 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 删除指定包的所有通知回调函数 |
- 示例
- 返回值
```js
import wantAgent from '@ohos.wantAgent'; void
import { OperationType, Flags } from '@ohos.wantagent';
- 示例
//wantAgent对象
var WantAgent1; ```js
var WantAgent2; function removeAllCallback(err) {
console.info("==========================>removeAllCallback=======================>");
//getWantAgent回调 }
function getWantAgentCallback(err, data) { var bundle = {
console.info("==========================>getWantAgentCallback=======================>"); bundle: "bundleName1";
if (err.code == 0) { }
WantAgent1 = data; Notification.removeAll(bundle, removeAllCallback);
WantAgent2 = data; ```
} else {
console.info('----getWantAgent failed!----');
}
} ## Notification.removeAll(callback: AsyncCallback\<void\>)
//WantAgentInfo对象
var wantAgentInfo = { - 接口说明
wants: [
{ 删除所有通知（Callback形式)
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1", - removeAll参数描述
abilityName: "com.example.test.MainAbility",
action: "action1", | 名称 | 读写属性 | 类型 | 必填 | 描述 |
entities: ["entity1"], | -------- | -------- | --------------------- | ---- | -------------------- |
type: "MIMETYPE", | callback | 只读 | AsyncCallback\<void\> | 是 | 删除所有通知回调函数 |
uri: "key={true,true,false}",
parameters: - 返回值
{
mykey0: 2222, void
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]", - 示例
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false], ```js
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], function removeAllCallback(err) {
mykey6: true, console.info("==========================>removeAllCallback=======================>");
} }
}
], Notification.removeAll(removeAllCallback);
operationType: OperationType.START_ABILITIES, ```
requestCode: 0,
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG]
}
## Notification.removeAll(bundle?: BundleOption)
wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
- 接口说明
//cancel回调
function equalCallback(err, data) { 删除所有通知（Promise形式)
console.info("==========================>equalCallback=======================>");
} - removeAll参数描述
wantAgent.equal(WantAgent1, WantAgent1, equalCallback)
``` | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------ | -------- | ------------ | ---- | ---------- |
| bundle | 只读 | BundleOption | 否 | 指定包信息 |
#### WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise<boolean> - 返回值
- 接口说明 Promise\<void\>
判断两个WantAgent实例是否相等（Promise形式） - 示例
- equal参数描述 ```js
Notification.removeAll().then((void) => {
console.info("==========================>removeAllCallback=======================>");
| 名称 | 读写属性 | 类型 | 必填 | 描述 | });
| ---------- | -------- | --------- | ---- | ------------- | ```
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
| otherAgent | 只读 | WantAgent | 是 | WantAgent对象 |
- ## Notification.getAllActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>)
返回值为Promise<boolean> - 接口说明
- 示例 获取活动通知（Callback形式)
```js - getAllActiveNotifications参数描述
import wantAgent from '@ohos.wantAgent';
import { OperationType, Flags } from '@ohos.wantagent'; | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------------------------- | ---- | -------------------- |
//wantAgent对象 | callback | 只读 | AsyncCallback<Array\<NotificationRequest\>> | 是 | 获取活动通知回调函数 |
var WantAgent1;
var WantAgent2; - 返回值
//WantAgentInfo对象 void
var wantAgentInfo = {
wants: [ - 示例
{
deviceId: "deviceId", ```js
bundleName: "com.neu.setResultOnAbilityResultTest1", function getAllActiveNotificationsCallback(err, data) {
abilityName: "com.example.test.MainAbility", console.info("==========================>getAllActiveNotificationsCallback=======================>");
action: "action1", }
entities: ["entity1"],
type: "MIMETYPE", Notification.getAllActiveNotifications(getAllActiveNotificationsCallback);
uri: "key={true,true,false}", ```
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3], ## Notification.getAllActiveNotifications()
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss", - 接口说明
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], 获取活动通知（Promise形式)
mykey6: true,
} - getAllActiveNotifications参数描述
}
], 无
operationType: OperationType.START_ABILITIES,
requestCode: 0, - 返回值
wantAgentFlags:[Flags.UPDATE_PRESENT_FLAG]
} Promise\<Array\<NotificationRequest\>\>
wantAgent.getWantAgent(wantAgentInfo).then((data) => { - 示例
console.info("==========================>getWantAgentCallback=======================>");
WantAgent = data; ```js
}); Notification.getAllActiveNotifications().then((data) => {
console.info("==========================>getAllActiveNotificationsCallback=======================>");
wantAgent.equal(WantAgent1, WantAgent2).then((data) => { });
console.info("==========================>equalCallback=======================>"); ```
});
```
## Notification.getActiveNotificationCount(callback: AsyncCallback\<number\>)
#### - 接口说明
获取当前应用的活动通知数（Callback形式)
- getActiveNotificationCount参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ---------------------- | ---- | ---------------------- |
| callback | 只读 | AsyncCallback\<number\> | 是 | 获取活动通知数回调函数 |
- 返回值
void
- 示例
```js
function getActiveNotificationCountCallback(err, data) {
console.info("==========================>getActiveNotificationCountCallback=======================>");
}
Notification.getActiveNotificationCount(getActiveNotificationCountCallback);
```
## Notification.getActiveNotificationCount()
- 接口说明
获取当前应用的活动通知数（Promise形式)
- getActiveNotificationCount参数描述
无
- 返回值
返回值为Promise\<number\>
- 示例
```js
Notification.getActiveNotificationCount().then((data) => {
console.info("==========================>getActiveNotificationCountCallback=======================>");
});
```
## Notification.getActiveNotifications(callback: AsyncCallback<Array\<NotificationRequest\>>)
- 接口说明
获取当前应用的活动通知（Callback形式)
- getActiveNotifications参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------------------------- | ---- | ------------------------------ |
| callback | 只读 | AsyncCallback<Array\<NotificationRequest\>> | 是 | 获取当前应用的活动通知回调函数 |
- 返回值
void
- 示例
```js
function getActiveNotificationsCallback(err, data) {
console.info("==========================>getActiveNotificationsCallback=======================>");
}
Notification.getActiveNotifications(getActiveNotificationsCallback);
```
## Notification.getActiveNotifications()
- 接口说明
获取当前应用的活动通知（Promise形式)
- getActiveNotifications参数描述
无
- 返回值
Promise\<Array\<NotificationRequest\>\>
- 示例
```js
Notification.getActiveNotifications().then((data) => {
console.info("==========================>getActiveNotificationsCallback=======================>");
});
```
## Notification.cancelGroup(groupName: string, callback: AsyncCallback\<void\>)
- 接口说明
取消本应用指定组通知（Callback形式)
- cancelGroup参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | --------------------- | ---- | ---------------------------- |
| groupName | 只读 | string | 是 | 指定通知组名称 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 取消本应用指定组通知回调函数 |
- 返回值
void
- 示例
```js
function cancelGroupCallback(err) {
console.info("==========================>cancelGroupCallback=======================>");
}
var groupName = "GroupName";
Notification.cancelGroup(groupName, cancelGroupCallback);
```
## Notification.cancelGroup(groupName: string)
- 接口说明
取消本应用指定组通知（Promise形式)
- cancelGroup参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ------ | ---- | -------------- |
| groupName | 只读 | string | 是 | 指定通知组名称 |
- 返回值
Promise\<void\>
- 示例
```js
var groupName = "GroupName";
Notification.cancelGroup(groupName).then(() => {
console.info("==========================>cancelGroupPromise=======================>");
});
```
## Notification.removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback\<void\>)
- 接口说明
删除指定应用指定组通知（Callback形式)
- removeGroupByBundle参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | --------------------- | ---- | ---------------------------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| groupName | 只读 | string | 是 | 指定通知组名称 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 删除本应用指定组通知回调函数 |
- 返回值
void
- 示例
```js
function removeGroupByBundleCallback(err) {
console.info("==========================>removeGroupByBundleCallback=======================>");
}
var bundleOption = {bundle: "Bundle"};
var groupName = "GroupName";
Notification.removeGroupByBundle(bundleOption, groupName, removeGroupByBundleCallback);
```
## Notification.removeGroupByBundle(bundle: BundleOption, groupName: string)
- 接口说明
删除指定应用指定组通知（Promise形式)
- removeGroupByBundle参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------- | -------- | ------------ | ---- | -------------- |
| bundle | 只读 | BundleOption | 是 | 指定包信息 |
| groupName | 只读 | string | 是 | 指定通知组名称 |
- 返回值
Promise\<void\>
- 示例
```js
var bundleOption = {bundle: "Bundle"};
var groupName = "GroupName";
Notification.removeGroupByBundle(bundleOption, groupName).then(() => {
console.info("==========================>removeGroupByBundlePromise=======================>");
});
```
## Notification.setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback\<void\>)
- 接口说明
设置免打扰时间（Callback形式)
- setDoNotDisturbDate参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | ---------------------- |
| date | 只读 | DoNotDisturbDate | 是 | 免打扰时间选项 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 设置免打扰时间回调函数 |
- 返回值
void
- 示例
```js
function setDoNotDisturbDateCallback(err) {
console.info("==========================>setDoNotDisturbDateCallback=======================>");
}
var doNotDisturbDate = {
type: notification.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
}
Notification.setDoNotDisturbDate(doNotDisturbDate, setDoNotDisturbDateCallback);
```
## Notification.setDoNotDisturbDate(date: DoNotDisturbDate)
- 接口说明
设置免打扰时间接口（Promise形式)
- setDoNotDisturbDate参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ---------------- | ---- | -------------- |
| date | 只读 | DoNotDisturbDate | 是 | 免打扰时间选项 |
- 返回值
Promise\<void\>
- 示例
```js
var doNotDisturbDate = {
type: notification.DoNotDisturbType.TYPE_ONCE,
begin: new Date(),
end: new Date(2021, 11, 15, 18, 0)
}
Notification.setDoNotDisturbDate(doNotDisturbDate).then(() => {
console.info("==========================>setDoNotDisturbDatePromise=======================>");
});
```
## Notification.getDoNotDisturbDate(callback: AsyncCallback\<DoNotDisturbDate\>)
- 接口说明
查询免打扰时间接口（Callback形式)
- getDoNotDisturbDate参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------------------- | ---- | ---------------------- |
| callback | 只读 | AsyncCallback\<DoNotDisturbDate\> | 是 | 查询免打扰时间回调函数 |
- 返回值
void
- 示例
```js
function getDoNotDisturbDateCallback(err,data) {
console.info("==========================>getDoNotDisturbDateCallback=======================>");
}
Notification.getDoNotDisturbDate(getDoNotDisturbDateCallback);
```
## Notification.getDoNotDisturbDate()
- 接口说明
查询免打扰时间接口（Promise形式)
- getDoNotDisturbDate参数描述
无
- 返回值
Promise\<DoNotDisturbDate\>
- 示例
```js
Notification.getDoNotDisturbDate().then((data) => {
console.info("==========================>getDoNotDisturbDatePromise=======================>");
});
```
## Notification.supportDoNotDisturbMode(callback: AsyncCallback\<boolean\>)
- 接口说明
查询是否支持勿扰模式功能（Callback形式)
- supportDoNotDisturbMode参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ------------------------ | ---- | -------------------------------- |
| callback | 只读 | AsyncCallback\<boolean\> | 是 | 查询是否支持勿扰模式功能回调函数 |
- 返回值
void
- 示例
```js
function supportDoNotDisturbModeCallback(err,data) {
console.info("==========================>supportDoNotDisturbModeCallback=======================>");
}
Notification.supportDoNotDisturbMode(supportDoNotDisturbModeCallback);
```
## Notification.supportDoNotDisturbMode()
- 接口说明
查询是否支持勿扰模式功能（Promise形式)
- supportDoNotDisturbMode参数描述
无
- 返回值
Promise\<boolean\>
- 示例
```js
Notification.supportDoNotDisturbMode().then((data) => {
console.info("==========================>supportDoNotDisturbModePromise=======================>");
});
```
## WantAgent接口
## 导入模块
```js
import WantAgent from '@ohos.wantAgent';
```
## WantAgent.getWantAgent(info: WantAgentInfo, callback: AsyncCallback\<WantAgent\>)
- 接口说明
创建WantAgent（callback形式）
- getWantAgent参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | -------------------------- | ---- | ----------------------- |
| info | 只读 | WantAgentInfo | 是 | WantAgent信息 |
| callback | 只读 | AsyncCallback\<WantAgent\> | 是 | 创建WantAgent的回调方法 |
- WantAgentInfo类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------------- | -------- | ------------------------------- | ---- | ---------------------- |
| wants | 读、写 | Array\<Want\> | 是 | 将被执行的动作列表 |
| operationType | 读、写 | wantAgent.OperationType | 是 | 动作类型 |
| requestCode | 读、写 | number | 是 | 使用者定义的一个私有值 |
| wantAgentFlags | 读、写 | Array<wantAgent.WantAgentFlags> | 否 | 动作执行属性 |
| extraInfo | 读、写 | {[key: string]: any} | 否 | 额外数据 |
-
WantAgentFlags类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | ---- | ---- | ------------------------------------------------------------ |
| ONE_TIME_FLAG | 只读 | enum | 否 | WantAgent仅能使用一次 |
| NO_BUILD_FLAG | 只读 | enum | 否 | 如果描述WantAgent对象不存在，则不创建它，直接返回null |
| CANCEL_PRESENT_FLAG | 只读 | enum | 否 | 在生成一个新的WantAgent对象前取消已存在的一个WantAgent对象 |
| UPDATE_PRESENT_FLAG | 只读 | enum | 否 | 使用新的WantAgent的额外数据替换已存在的WantAgent中的额外数据 |
| CONSTANT_FLAG | 只读 | enum | 否 | WantAgent是不可变的 |
- OperationType类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------------- | -------- | ---- | ---- | ----------------------- |
| UNKNOWN_TYPE | 只读 | enum | 否 | 不识别的类型 |
| START_ABILITY | 只读 | enum | 否 | 开启一个有页面的Ability |
| START_ABILITIES | 只读 | enum | 否 | 开启多个有页面的Ability |
| START_SERVICE | 只读 | enum | 否 | 开启一个无页面的ability |
| SEND_COMMON_EVENT | 只读 | enum | 否 | 发送一个公共事件 |
- 返回值
void
- 示例
```js
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//getWantAgent回调
function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>");
}
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
```
## WantAgent.getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
- 接口说明
创建WantAgent（Promise形式）
- getWantAgent参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------------- | ---- | ------------- |
| info | 只读 | WantAgentInfo | 是 | WantAgent信息 |
- 返回值
Promise\<WantAgent\>
- 示例
```js
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>");
});
```
## WantAgent.getBundleName(agent: WantAgent, callback: AsyncCallback\<string\>)
- 接口说明
获取WantAgent实例的包名（callback形式）
- getBundleName参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ----------------------- | ---- | --------------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
| callback | 只读 | AsyncCallback\<string\> | 是 | 获取WantAgent实例的包名的回调方法 |
- 返回值
void
- 示例
```js
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象
var wantAgent;
//getWantAgent回调
function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) {
wantAgent = data;
} else {
console.info('----getWantAgent failed!----');
}
}
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//getBundleName回调
function getBundleNameCallback(err, data) {
console.info("==========================>getBundleNameCallback=======================>");
}
WantAgent.getBundleName(wantAgent, getBundleNameCallback)
```
## WantAgent.getBundleName(agent: WantAgent): Promise\<string\>
- 接口说明
获取WantAgent实例的包名（Promise形式）
- getBundleName参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----- | -------- | --------- | ---- | ------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
- 返回值
Promise\<string\>
- 示例
```js
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象
var wantAgent;
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>");
wantAgent = data;
});
WantAgent.getBundleName(wantAgent).then((data) => {
console.info("==========================>getBundleNameCallback=======================>");
});
```
## WantAgent.getUid(agent: WantAgent, callback: AsyncCallback\<number\>)
- 接口说明
获取WantAgent实例的用户ID（callback形式）
- getUid参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | ----------------------- | ---- | ----------------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
| callback | 只读 | AsyncCallback\<number\> | 是 | 获取WantAgent实例的用户ID的回调方法 |
- 返回值
void
- 示例
```js
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象
var wantAgent;
//getWantAgent回调
function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) {
wantAgent = data;
} else {
console.info('----getWantAgent failed!----');
}
}
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//getUid回调
function getUidCallback(err, data) {
console.info("==========================>getUidCallback=======================>");
}
WantAgent.getUid(wantAgent, getUidCallback)
```
## WantAgent.getUid(agent: WantAgent): Promise\<number\>
- 接口说明
获取WantAgent实例的用户ID（Promise形式）
- getUid参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----- | -------- | --------- | ---- | ------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
- 返回值
Promise\<number\>
- 示例
```js
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象
var wantAgent;
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>");
wantAgent = data;
});
WantAgent.getUid(wantAgent).then((data) => {
console.info("==========================>getUidCallback=======================>");
});
```
## WantAgent.getWant(agent: WantAgent, callback: AsyncCallback\<Want\>)
- 接口说明
获取WantAgent对象的want（callback形式）
- getWant参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | ------------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
| callback | 只读 | AsyncCallback\<Want\> | 是 | 获取WantAgent对象want的回调方法 |
- 返回值
void
- 示例
```js
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象
var wantAgent;
//getWantAgent回调
function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) {
wantAgent = data;
} else {
console.info('----getWantAgent failed!----');
}
}
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentWantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//getWant回调
function getWantCallback(err, data) {
console.info("==========================>getWantCallback=======================>");
}
WantAgent.getWant(wantAgent, getWantCallback)
```
## WantAgent.getWant(agent: WantAgent): Promise\<Want\>
- 接口说明
获取WantAgent对象的want（Promise形式）
- getWant参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----- | -------- | --------- | ---- | ------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
- 返回值
Promise\<Want\>
- 示例
```js
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象
var wantAgent;
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>");
wantAgent = data;
});
WantAgent.getWant(wantAgent).then((data) => {
console.info("==========================>getWantCallback=======================>");
});
```
## WantAgent.cancel(agent: WantAgent, callback: AsyncCallback\<void\>)
- 接口说明
取消WantAgent实例（callback形式）
- cancel参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| -------- | -------- | --------------------- | ---- | --------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
| callback | 只读 | AsyncCallback\<void\> | 是 | 取消WantAgent实例的回调方法 |
- 返回值
void
- 示例
```js
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象
var wantAgent;
//getWantAgent回调
function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) {
wantAgent = data;
} else {
console.info('----getWantAgent failed!----');
}
}
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//cancel回调
function cancelCallback(err, data) {
console.info("==========================>cancelCallback=======================>");
}
WantAgent.cancel(wantAgent, cancelCallback)
```
## WantAgent.cancel(agent: WantAgent): Promise\<void\>
- 接口说明
取消WantAgent实例（Promise形式）
- cancel参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----- | -------- | --------- | ---- | ------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
- 返回值
Promise\<void\>
- 示例
```js
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象
var wantAgent;
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>");
wantAgent = data;
});
WantAgent.cancel(wantAgent).then((data) => {
console.info("==========================>cancelCallback=======================>");
});
```
## WantAgent.trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\<CompleteData\>)
- 接口说明
主动激发WantAgent实例（callback形式）
- trigger参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ----------------------------- | ---- | ------------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
| triggerInfo | 只读 | TriggerInfo | 是 | TriggerInfo对象 |
| callback | 只读 | AsyncCallback\<CompleteData\> | 是 | 主动激发WantAgent实例的回调方法 |
- TriggerInfo类型说明
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | -------------------- | ---- | ----------- |
| code | 读、写 | number | 是 | result code |
| want | 读、写 | Want | 否 | Want |
| permission | 读、写 | string | 否 | 权限定义 |
| extraInfo | 读、写 | {[key: string]: any} | 否 | 额外数据 |
- 返回值
void
- 示例
```js
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象
var wantAgent;
//getWantAgent回调
function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) {
wantAgent = data;
} else {
console.info('----getWantAgent failed!----');
}
}
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//trigger回调
function triggerCallback(err, data) {
console.info("==========================>triggerCallback=======================>");
}
var triggerInfo = {
code:0
}
WantAgent.trigger(wantAgent, triggerInfo, triggerCallback)
```
## WantAgent.equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\<boolean\>)
- 接口说明
判断两个WantAgent实例是否相等（callback形式）
- equal参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | ------------------------ | ---- | --------------------------------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
| otherAgent | 只读 | WantAgent | 是 | WantAgent对象 |
| callback | 只读 | AsyncCallback\<boolean\> | 是 | 判断两个WantAgent实例是否相等的回调方法 |
- 返回值
void
- 示例
```js
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象
var wantAgent1;
var wantAgent2;
//getWantAgent回调
function getWantAgentCallback(err, data) {
console.info("==========================>getWantAgentCallback=======================>");
if (err.code == 0) {
wantAgent1 = data;
wantAgent2 = data;
} else {
console.info('----getWantAgent failed!----');
}
}
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
//equal回调
function equalCallback(err, data) {
console.info("==========================>equalCallback=======================>");
}
WantAgent.equal(wantAgent1, wantAgent2, equalCallback)
```
## WantAgent.equal(agent: WantAgent, otherAgent: WantAgent): Promise\<boolean\>
- 接口说明
判断两个WantAgent实例是否相等（Promise形式）
- equal参数描述
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------- | ---- | ------------- |
| agent | 只读 | WantAgent | 是 | WantAgent对象 |
| otherAgent | 只读 | WantAgent | 是 | WantAgent对象 |
- 返回值
Promise\<boolean\>
- 示例
```js
import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent对象
var wantAgent1;
var wantAgent2;
//WantAgentInfo对象
var wantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.neu.setResultOnAbilityResultTest1",
abilityName: "com.example.test.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo).then((data) => {
console.info("==========================>getWantAgentCallback=======================>");
wantAgent1 = data;
wantAgent2 = data;
});
WantAgent.equal(wantAgent1, wantAgent2).then((data) => {
console.info("==========================>equalCallback=======================>");
});
```
####
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md
浏览文件 @ 275e470e
# 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.
先完成此消息的编辑！
想要评论请 注册 或