Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 a3ded774 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!2007 api文档修改 

Merge pull request !2007 from xzz_0810/master
上级 cdcaf98e cfedb144
显示空白变更内容
内联 并排
Showing with 473 addition and 289 deletion
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
浏览文件 @ a3ded774
...@@ -476,6 +476,10 @@ queryAbilityByWant(want: Want, bundleFlags: number, userId: number, callback: As ...@@ -476,6 +476,10 @@ queryAbilityByWant(want: Want, bundleFlags: number, userId: number, callback: As
以异步方法根据给定的意图获取Ability信息，使用callback形式返回结果。 以异步方法根据给定的意图获取Ability信息，使用callback形式返回结果。
**系统能力：**
SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
...@@ -509,6 +513,10 @@ queryAbilityByWant(want: Want, bundleFlags: number, callback: AsyncCallback<Arra ...@@ -509,6 +513,10 @@ queryAbilityByWant(want: Want, bundleFlags: number, callback: AsyncCallback<Arra
以异步方法根据给定的意图获取Ability信息，使用callback形式返回结果。 以异步方法根据给定的意图获取Ability信息，使用callback形式返回结果。
**系统能力：**
SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
...@@ -699,6 +707,10 @@ getNameForUid(uid: number): Promise\<string> ...@@ -699,6 +707,10 @@ getNameForUid(uid: number): Promise\<string>
以异步方法通过uid获取对应的包名，使用Promise形式返回结果。 以异步方法通过uid获取对应的包名，使用Promise形式返回结果。
**系统能力：**
SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
...@@ -728,6 +740,10 @@ getNameForUid(uid: number, callback: AsyncCallback<string>): void; ...@@ -728,6 +740,10 @@ getNameForUid(uid: number, callback: AsyncCallback<string>): void;
以异步方法通过uid获取对应的包名，使用callback形式返回结果。 以异步方法通过uid获取对应的包名，使用callback形式返回结果。
**系统能力：**
SystemCapability.BundleManager.BundleFramework
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
...@@ -748,9 +764,10 @@ bundle.getNameForUid(uid, (err, data) => { ...@@ -748,9 +764,10 @@ bundle.getNameForUid(uid, (err, data) => {
}) })
``` ```
## ElementName ## ElementName
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | ------------------------------------------------------------ | | ----------- | -------- | ------ | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 | | deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
...@@ -761,6 +778,8 @@ bundle.getNameForUid(uid, (err, data) => { ...@@ -761,6 +778,8 @@ bundle.getNameForUid(uid, (err, data) => {
## InstallStatus ## InstallStatus
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------- | -------- | ---------------- | ---- | ------------------------------------------------------------ | | ------------- | -------- | ---------------- | ---- | ------------------------------------------------------------ |
| status | 只读 | InstallErrorCode | 是 | 安装结果code<br/>SUCCESS = 0<br/>STATUS_INSTALL_FAILURE = 1<br/>STATUS_INSTALL_FAILURE_ABORTED = 2,<br/>STATUS_INSTALL_FAILURE_INVALID = 3<br/>STATUS_INSTALL_FAILURE_CONFLICT = 4<br/>STATUS_INSTALL_FAILURE_STORAGE = 5<br/>STATUS_INSTALL_FAILURE_INCOMPATIBLE = 6<br/>STATUS_UNINSTALL_FAILURE = 7<br>STATUS_UNINSTALL_FAILURE_BLOCKED = 8<br/>STATUS_UNINSTALL_FAILURE_ABORTED = 9<br/>STATUS_UNINSTALL_FAILURE_CONFLICT = 10<br/>STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT = 0x0B<br/>STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED = 0x0C<br/>STATUS_RECOVER_FAILURE_INVALID = 0x0D<br/>STATUS_ABILITY_NOT_FOUND = 0x40<br/>STATUS_BMS_SERVICE_ERROR = 0x41<br/>STATUS_FAILED_NO_SPACE_LEFT = 0x42<br/>STATUS_GRANT_REQUEST_PERMISSIONS_FAILED = 0x43<br/>STATUS_INSTALL_PERMISSION_DENIED = 0x44<br/>STATUS_UNINSTALL_PERMISSION_DENIED = 0x45 | | status | 只读 | InstallErrorCode | 是 | 安装结果code<br/>SUCCESS = 0<br/>STATUS_INSTALL_FAILURE = 1<br/>STATUS_INSTALL_FAILURE_ABORTED = 2,<br/>STATUS_INSTALL_FAILURE_INVALID = 3<br/>STATUS_INSTALL_FAILURE_CONFLICT = 4<br/>STATUS_INSTALL_FAILURE_STORAGE = 5<br/>STATUS_INSTALL_FAILURE_INCOMPATIBLE = 6<br/>STATUS_UNINSTALL_FAILURE = 7<br>STATUS_UNINSTALL_FAILURE_BLOCKED = 8<br/>STATUS_UNINSTALL_FAILURE_ABORTED = 9<br/>STATUS_UNINSTALL_FAILURE_CONFLICT = 10<br/>STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT = 0x0B<br/>STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED = 0x0C<br/>STATUS_RECOVER_FAILURE_INVALID = 0x0D<br/>STATUS_ABILITY_NOT_FOUND = 0x40<br/>STATUS_BMS_SERVICE_ERROR = 0x41<br/>STATUS_FAILED_NO_SPACE_LEFT = 0x42<br/>STATUS_GRANT_REQUEST_PERMISSIONS_FAILED = 0x43<br/>STATUS_INSTALL_PERMISSION_DENIED = 0x44<br/>STATUS_UNINSTALL_PERMISSION_DENIED = 0x45 |
...@@ -769,6 +788,8 @@ bundle.getNameForUid(uid, (err, data) => { ...@@ -769,6 +788,8 @@ bundle.getNameForUid(uid, (err, data) => {
包的标志 包的标志
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ------ | ------ | ------ | | ------ | ------ | ------ |
| GET_BUNDLE_DEFAULT | 0x00000000 | 获取默认的应用信息 | | GET_BUNDLE_DEFAULT | 0x00000000 | 获取默认的应用信息 |
...@@ -788,6 +809,8 @@ bundle.getNameForUid(uid, (err, data) => { ...@@ -788,6 +809,8 @@ bundle.getNameForUid(uid, (err, data) => {
包的选项 包的选项
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ | ------ |
| userId | number | 是 | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 | | userId | number | 是 | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
...@@ -796,6 +819,8 @@ bundle.getNameForUid(uid, (err, data) => { ...@@ -796,6 +819,8 @@ bundle.getNameForUid(uid, (err, data) => {
应用包的信息 应用包的信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ | ------ |
| name | string | 是 | 否 | 应用包的名称 | | name | string | 是 | 否 | 应用包的名称 |
...@@ -826,6 +851,8 @@ bundle.getNameForUid(uid, (err, data) => { ...@@ -826,6 +851,8 @@ bundle.getNameForUid(uid, (err, data) => {
应用程序信息 应用程序信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ | ------ |
| name | string | 是 | 否 | 应用程序的名称 | | name | string | 是 | 否 | 应用程序的名称 |
...@@ -854,6 +881,8 @@ bundle.getNameForUid(uid, (err, data) => { ...@@ -854,6 +881,8 @@ bundle.getNameForUid(uid, (err, data) => {
应用程序的模块信息 应用程序的模块信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ | ------ |
| moduleName | string | 是 | 否 | 模块名称 | | moduleName | string | 是 | 否 | 模块名称 |
...@@ -863,6 +892,8 @@ bundle.getNameForUid(uid, (err, data) => { ...@@ -863,6 +892,8 @@ bundle.getNameForUid(uid, (err, data) => {
自定义元数据 自定义元数据
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ------ | ---- | ---- | ---------------- | | ----- | ------ | ---- | ---- | ---------------- |
| name | string | 是 | 是 | 自定义元数据名称 | | name | string | 是 | 是 | 自定义元数据名称 |
...@@ -874,6 +905,8 @@ bundle.getNameForUid(uid, (err, data) => { ...@@ -874,6 +905,8 @@ bundle.getNameForUid(uid, (err, data) => {
Hap模块信息 Hap模块信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ | ------ |
| name | string | 是 | 否 | 模块名称 | | name | string | 是 | 否 | 模块名称 |
...@@ -897,6 +930,8 @@ Hap模块信息 ...@@ -897,6 +930,8 @@ Hap模块信息
应用运行时需向系统申请的权限集合的详细信息 应用运行时需向系统申请的权限集合的详细信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ | ------ |
| name | string | 是 | 是 | 需要使用的权限名称 | | name | string | 是 | 是 | 需要使用的权限名称 |
...@@ -907,6 +942,8 @@ Hap模块信息 ...@@ -907,6 +942,8 @@ Hap模块信息
描述权限使用的场景和时机 描述权限使用的场景和时机
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ | ------ |
| abilities | Array<string> | 是 | 是 | 使用到该权限的Ability集合 | | abilities | Array<string> | 是 | 是 | 使用到该权限的Ability集合 |
...@@ -917,6 +954,8 @@ Hap模块信息 ...@@ -917,6 +954,8 @@ Hap模块信息
Ability信息 Ability信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ | | ------ | ------ | ------ | ------ | ------ |
| bundleName | string | 是 | 否 | 应用包名 | | bundleName | string | 是 | 否 | 应用包名 |
...@@ -951,6 +990,8 @@ Ability信息 ...@@ -951,6 +990,8 @@ Ability信息
Ability类型 Ability类型
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ------- | ---- | --------------------------- | | ------- | ---- | --------------------------- |
| UNKNOWN | 无 | 未知Ability类型 | | UNKNOWN | 无 | 未知Ability类型 |
...@@ -962,6 +1003,8 @@ Ability类型 ...@@ -962,6 +1003,8 @@ Ability类型
屏幕显示方向 屏幕显示方向
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ------------- | ---- | ------------------------ | | ------------- | ---- | ------------------------ |
| UNSPECIFIED | 无 | 屏幕方向--不指定 | | UNSPECIFIED | 无 | 屏幕方向--不指定 |
...@@ -973,6 +1016,8 @@ Ability类型 ...@@ -973,6 +1016,8 @@ Ability类型
启动模式 启动模式
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ----------- | ---- | ------------------- | | ----------- | ---- | ------------------- |
| SINGLETON | 0 | Ability只有一个示例 | | SINGLETON | 0 | Ability只有一个示例 |
...@@ -982,6 +1027,8 @@ Ability类型 ...@@ -982,6 +1027,8 @@ Ability类型
Ability的子类型 Ability的子类型
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ----------- | ---- | ----------------------------- | | ----------- | ---- | ----------------------------- |
| UNSPECIFIED | 0 | 未定义Ability子类型 | | UNSPECIFIED | 0 | 未定义Ability子类型 |
......
zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md
浏览文件 @ a3ded774
...@@ -191,11 +191,12 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want ...@@ -191,11 +191,12 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
- **参数**： - **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context | Context | 是 | 应用运行的上下文 | | context | Context | 是 | 应用运行的上下文 |
| bgMode | BackgroundMode | 是 | 向系统申请的后台模式 | | bgMode | BackgroundMode | 是 | 向系统申请的后台模式 |
| wantAgent | [WantAgent](js-apis-notification.md#WantAgent接口) | 是 | 通知参数，用于指定长时任务通知点击跳转的界面 | | wantAgent | [WantAgent](js-apis-notification.md#WantAgent接口) | 是 | 通知参数，用于指定长时任务通知点击跳转的界面 |
- **返回值** - **返回值**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -295,14 +296,16 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(() ...@@ -295,14 +296,16 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(()
## BackgroundMode <sup>8+</sup> ## BackgroundMode <sup>8+</sup>
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
| 参数名 | 参数值 | 描述 | | 参数名 | 参数值 | 描述 |
| ----------------------- | -------- | -------- | | ----------------------- | -------- | -------- |
| DATA_TRANSFER | 1 | 数据传输<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask | | DATA_TRANSFER | 1 | 数据传输 |
| AUDIO_PLAYBACK | 2 | 音频播放<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask | | AUDIO_PLAYBACK | 2 | 音频播放 |
| AUDIO_RECORDING | 3 | 录音<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask | | AUDIO_RECORDING | 3 | 录音 |
| LOCATION | 4 | 定位导航<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask | | LOCATION | 4 | 定位导航 |
| BLUETOOTH_INTERACTION | 5 | 蓝牙相关<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask | | BLUETOOTH_INTERACTION | 5 | 蓝牙相关 |
| MULTI_DEVICE_CONNECTION | 6 | 多设备互联<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask | | MULTI_DEVICE_CONNECTION | 6 | 多设备互联 |
| WIFI_INTERACTION | 7 | WLAN相关（系统保留）<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask | | WIFI_INTERACTION | 7 | WLAN相关（系统保留） |
| VOIP | 8 | 音视频通话（系统保留）<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask | | VOIP | 8 | 音视频通话（系统保留） |
| TASK_KEEPING | 9 | 计算任务（仅供PC使用）<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask | | TASK_KEEPING | 9 | 计算任务（仅供PC使用） |
\ No newline at end of file \ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-commonEvent.md
浏览文件 @ a3ded774
...@@ -251,8 +251,8 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca ...@@ -251,8 +251,8 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca
```js ```js
//公共事件相关信息 //公共事件相关信息
var options = { var options = {
code: 0; //公共事件的初始代码 code: 0, //公共事件的初始代码
data: "initial data";//公共事件的初始数据 data: "initial data",//公共事件的初始数据
} }
//发布公共事件回调 //发布公共事件回调
...@@ -541,34 +541,40 @@ CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack); ...@@ -541,34 +541,40 @@ CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);
## CommonEventPublishData ## CommonEventPublishData
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------------------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | | --------------------- | -------- | -------------------- | ---- | ---------------------------- |
| bundleName | 只读 | string | 否 | 表示包名称<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | bundleName | 只读 | string | 否 | 表示包名称 |
| code | 只读 | number | 否 | 表示公共事件的结果代码<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | code | 只读 | number | 否 | 表示公共事件的结果代码 |
| data | 只读 | string | 否 | 表示公共事件的自定义结果数据<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | data | 只读 | string | 否 | 表示公共事件的自定义结果数据 |
| subscriberPermissions | 只读 | Array\<string> | 否 | 表示订阅者的权限<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | subscriberPermissions | 只读 | Array\<string> | 否 | 表示订阅者的权限 |
| isOrdered | 只读 | boolean | 否 | 表示是否是有序事件<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | isOrdered | 只读 | boolean | 否 | 表示是否是有序事件 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 |
## CommonEventSubscribeInfo ## CommonEventSubscribeInfo
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | -------------- | ---- | ------------------------------------------------------------ | | ------------------- | -------- | -------------- | ---- | ------------------------------------------------------------ |
| events | 只读 | Array\<string> | 是 | 表示要发送的公共事件<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | events | 只读 | Array\<string> | 是 | 表示要发送的公共事件 |
| publisherPermission | 只读 | string | 否 | 表示发布者的权限<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | publisherPermission | 只读 | string | 否 | 表示发布者的权限 |
| publisherDeviceId | 只读 | string | 否 | 表示设备ID，该值必须是同一ohos网络上的现有设备ID<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | publisherDeviceId | 只读 | string | 否 | 表示设备ID，该值必须是同一ohos网络上的现有设备ID |
| userId | 只读 | number | 否 | 表示用户ID。此参数是可选的，默认值当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | userId | 只读 | number | 否 | 表示用户ID。此参数是可选的，默认值当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。 |
| priority | 只读 | number | 否 | 表示订阅者的优先级。值的范围是-100到1000<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | priority | 只读 | number | 否 | 表示订阅者的优先级。值的范围是-100到1000 |
## CommonEventData ## CommonEventData
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | | ---------- | -------- | -------------------- | ---- | ------------------------------------------------------- |
| event | 只读 | string | 是 | 表示当前接收的公共事件名称<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | event | 只读 | string | 是 | 表示当前接收的公共事件名称 |
| bundleName | 只读 | string | 否 | 表示包名称<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | bundleName | 只读 | string | 否 | 表示包名称 |
| code | 只读 | number | 否 | 表示公共事件的结果代码，用于传递int类型的数据<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | code | 只读 | number | 否 | 表示公共事件的结果代码，用于传递int类型的数据 |
| data | 只读 | string | 否 | 表示公共事件的自定义结果数据，用于传递string类型的数据<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | data | 只读 | string | 否 | 表示公共事件的自定义结果数据，用于传递string类型的数据< |
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息<br/>**系统能力**：SystemCapability.Notification.CommonEvent | | parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 |
## CommonEventSubscriber ## CommonEventSubscriber
......
zh-cn/application-dev/reference/apis/js-apis-environment.md
浏览文件 @ a3ded774
...@@ -11,16 +11,16 @@ ...@@ -11,16 +11,16 @@
import environment from '@ohos.environment'; import environment from '@ohos.environment';
``` ```
## 系统能力
SystemCapability.FileManagement.File.Environment
## environment.getStorageDataDir ## environment.getStorageDataDir
getStorageDataDir():Promise&lt;string&gt; getStorageDataDir():Promise&lt;string&gt;
异步方法获取内存存储根目录，以promise形式返回结果。 异步方法获取内存存储根目录，以promise形式返回结果。
- 系统能力：
SystemCapability.FileManagement.File.Environment
- 返回值： - 返回值：
| 类型 | 说明 | | 类型 | 说明 |
...@@ -43,6 +43,10 @@ getStorageDataDir(callback:AsyncCallback&lt;string&gt;):void ...@@ -43,6 +43,10 @@ getStorageDataDir(callback:AsyncCallback&lt;string&gt;):void
异步方法获取内存存储根目录，以callback形式返回结果。 异步方法获取内存存储根目录，以callback形式返回结果。
- 系统能力：
SystemCapability.FileManagement.File.Environment
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -63,6 +67,10 @@ getUserDataDir():Promise&lt;string&gt; ...@@ -63,6 +67,10 @@ getUserDataDir():Promise&lt;string&gt;
异步方法获取公共文件根目录，以promise形式返回结果。 异步方法获取公共文件根目录，以promise形式返回结果。
- 系统能力：
SystemCapability.FileManagement.File.Environment
- 返回值： - 返回值：
| 类型 | 说明 | | 类型 | 说明 |
...@@ -85,6 +93,10 @@ getUserDataDir(callback:AsyncCallback&lt;string&gt;): void ...@@ -85,6 +93,10 @@ getUserDataDir(callback:AsyncCallback&lt;string&gt;): void
异步方法获取公共文件根目录，以callback形式返回结果。 异步方法获取公共文件根目录，以callback形式返回结果。
- 系统能力：
SystemCapability.FileManagement.File.Environment
- 参数： - 参数：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
......
zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md
浏览文件 @ a3ded774
...@@ -23,16 +23,16 @@ createFormBindingData(obj?: Object | string): FormBindingData ...@@ -23,16 +23,16 @@ createFormBindingData(obj?: Object | string): FormBindingData
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------- | ---- | ------------------------------------------------------------ | | ------ | -------------- | ---- | ------------------------------------------------------------ |
| obj | Object或string | 否 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。 | | obj | Object或string | 否 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------- | --------------------------------------- | | ----------------------------------- | --------------------------------------- |
| [FormBindingData](#formbindingdata) | 根据传入数据创建的FormBindingData对象。 | | [FormBindingData](#formbindingdata) | 根据传入数据创建的FormBindingData对象。 |
**示例：** **示例：**
......
zh-cn/application-dev/reference/apis/js-apis-notification.md
浏览文件 @ a3ded774
...@@ -1999,15 +1999,17 @@ Notification.show(options); ...@@ -1999,15 +1999,17 @@ Notification.show(options);
## NotificationSubscriber ## NotificationSubscriber
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ------------------------------------------------------------ | ---- | --- | -------- | ---- | -------------------------- | | ------------------------------------------------------------ | ---- | --- | -------- | ---- | -------------------------- |
| onConsume?:(data: [SubscribeCallbackData](#subscribecallbackdata)) | 是 | 否 | function | 否 | 接收通知回调函数。<br/>**系统能力**：SystemCapability.Notification.Notification | | onConsume?:(data: [SubscribeCallbackData](#subscribecallbackdata)) | 是 | 否 | function | 否 | 接收通知回调函数。 |
| onCancel?:(data: [SubscribeCallbackData](#subscribecallbackdata)) | 是 | 否 | function | 否 | 删除通知回调函数。<br/>**系统能力**：SystemCapability.Notification.Notification | | onCancel?:(data: [SubscribeCallbackData](#subscribecallbackdata)) | 是 | 否 | function | 否 | 删除通知回调函数。 |
| onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap)) | 是 | 否 | function | 否 | 更新通知排序回调函数。<br/>**系统能力**：SystemCapability.Notification.Notification | | onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap)) | 是 | 否 | function | 否 | 更新通知排序回调函数。 |
| onConnect?:() | 是 | 否 | function | 否 | 注册订阅回调函数。<br/>**系统能力**：SystemCapability.Notification.Notification | | onConnect?:() | 是 | 否 | function | 否 | 注册订阅回调函数。 |
| onDisconnect?:() | 是 | 否 | function | 否 | 取消订阅回调函数。<br/>**系统能力**：SystemCapability.Notification.Notification | | onDisconnect?:() | 是 | 否 | function | 否 | 取消订阅回调函数。 |
| onDestroy?:() | 是 | 否 | function | 否 | 服务失联回调函数。<br/>**系统能力**：SystemCapability.Notification.Notification | | onDestroy?:() | 是 | 否 | function | 否 | 服务失联回调函数。 |
| onDoNotDisturbDateChange?:(mode: Notification.[DoNotDisturbDate](#donotdisturbdate)) | 是 | 否 | function | 否 | 免打扰时间选项变更回调函数。<br/>**系统能力**：SystemCapability.Notification.Notification | | onDoNotDisturbDateChange?:(mode: Notification.[DoNotDisturbDate](#donotdisturbdate)) | 是 | 否 | function | 否 | 免打扰时间选项变更回调函数。 |
### onEnabledNotificationChanged ### onEnabledNotificationChanged
...@@ -2055,248 +2057,285 @@ Notification.subscribe(subscriber, subscribeCallback); ...@@ -2055,248 +2057,285 @@ Notification.subscribe(subscriber, subscribeCallback);
## SubscribeCallbackData ## SubscribeCallbackData
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| --------------- | ---- | --- | ------------------------------------------------- | ---- | -------- | | --------------- | ---- | --- | ------------------------------------------------- | ---- | -------- |
| request | 是 | 否 | [NotificationRequest](#notificationrequest) | 是 | 通知内容。<br/>**系统能力**：SystemCapability.Notification.Notification | | request | 是 | 否 | [NotificationRequest](#notificationrequest) | 是 | 通知内容。 |
| sortingMap | 是 | 否 | [NotificationSortingMap](#notificationsortingmap) | 否 | 排序信息。<br/>**系统能力**：SystemCapability.Notification.Notification | | sortingMap | 是 | 否 | [NotificationSortingMap](#notificationsortingmap) | 否 | 排序信息。 |
| reason | 是 | 否 | number | 否 | 删除原因。<br/>**系统能力**：SystemCapability.Notification.Notification | | reason | 是 | 否 | number | 否 | 删除原因。 |
| sound | 是 | 否 | string | 否 | 通知声音。<br/>**系统能力**：SystemCapability.Notification.Notification | | sound | 是 | 否 | string | 否 | 通知声音。 |
| vibrationValues | 是 | 否 | Array\<number\> | 否 | 通知震动。<br/>**系统能力**：SystemCapability.Notification.Notification | | vibrationValues | 是 | 否 | Array\<number\> | 否 | 通知震动。 |
。<br/>**系统能力**：SystemCapability.Notification.Notification
## NotificationSortingMap ## NotificationSortingMap
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| -------------- | ---- | --- | ------------------------------------------------------------ | ---- | ---------------- | | -------------- | ---- | --- | ------------------------------------------------------------ | ---- | ---------------- |
| sortings | 是 | 否 | {[key: string]: [NotificationSorting](#notificationsorting)} | 是 | 通知排序信息数组。<br/>**系统能力**：SystemCapability.Notification.Notification | | sortings | 是 | 否 | {[key: string]: [NotificationSorting](#notificationsorting)} | 是 | 通知排序信息数组。 |
| sortedHashCode | 是 | 否 | Array\<string\> | 是 | 通知唯一标识数组。<br/>**系统能力**：SystemCapability.Notification.Notification | | sortedHashCode | 是 | 否 | Array\<string\> | 是 | 通知唯一标识数组。 |
## NotificationSorting ## NotificationSorting
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| -------- | ---- | --- | ------------------------------------- | ---- | ------------ | | -------- | ---- | --- | ------------------------------------- | ---- | ------------ |
| slot | 是 | 否 | [NotificationSlot](#notificationslot) | 是 | 通知通道内容。<br/>**系统能力**：SystemCapability.Notification.Notification | | slot | 是 | 否 | [NotificationSlot](#notificationslot) | 是 | 通知通道内容。 |
| hashCode | 是 | 否 | string | 是 | 通知唯一标识。<br/>**系统能力**：SystemCapability.Notification.Notification | | hashCode | 是 | 否 | string | 是 | 通知唯一标识。 |
| ranking | 是 | 否 | number | 是 | 通知排序序号。<br/>**系统能力**：SystemCapability.Notification.Notification | | ranking | 是 | 否 | number | 是 | 通知排序序号。 |
## DoNotDisturbDate ## DoNotDisturbDate
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 描述 | | 名称 | 可读 | 可写 | 类型 | 描述 |
| ----- | ---- | --- | ------------------------------------- | ------------------------ | | ----- | ---- | --- | ------------------------------------- | ------------------------ |
| type | 是 | 否 | [DoNotDisturbType](#donotdisturbtype) | 指定免打扰设置的时间类型。<br/>**系统能力**：SystemCapability.Notification.Notification | | type | 是 | 否 | [DoNotDisturbType](#donotdisturbtype) | 指定免打扰设置的时间类型。 |
| begin | 是 | 否 | Date | 指定免打扰设置的起点时间。<br/>**系统能力**：SystemCapability.Notification.Notification | | begin | 是 | 否 | Date | 指定免打扰设置的起点时间。 |
| end | 是 | 否 | Date | 指定免打扰设置的终点时间。<br/>**系统能力**：SystemCapability.Notification.Notification | | end | 是 | 否 | Date | 指定免打扰设置的终点时间。 |
## DoNotDisturbType ## DoNotDisturbType
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------ | ---------------- | ---------------------------------------- | | ------------ | ---------------- | ------------------------------------------ |
| TYPE_NONE | DoNotDisturbType | 非通知勿扰类型。<br/>**系统能力**：SystemCapability.Notification.Notification | | TYPE_NONE | DoNotDisturbType | 非通知勿扰类型。 |
| TYPE_ONCE | DoNotDisturbType | 以设置时间段(只看小时和分钟)一次执行勿扰。<br/>**系统能力**：SystemCapability.Notification.Notification | | TYPE_ONCE | DoNotDisturbType | 以设置时间段(只看小时和分钟)一次执行勿扰。 |
| TYPE_DAILY | DoNotDisturbType | 以设置时间段(只看小时和分钟)每天执行勿扰。<br/>**系统能力**：SystemCapability.Notification.Notification | | TYPE_DAILY | DoNotDisturbType | 以设置时间段(只看小时和分钟)每天执行勿扰。 |
| TYPE_CLEARLY | DoNotDisturbType | 以设置时间段(明确年月日时分)执行勿扰。<br/>**系统能力**：SystemCapability.Notification.Notification | | TYPE_CLEARLY | DoNotDisturbType | 以设置时间段(明确年月日时分)执行勿扰。 |
## EnabledNotificationCallbackData ## EnabledNotificationCallbackData
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ------ | ---- | --- | ------- | ---- | ---------------- | | ------ | ---- | --- | ------- | ---- | ---------------- |
| bundle | 是 | 否 | string | 否 | 应用的包名。<br/>**系统能力**：SystemCapability.Notification.Notification | | bundle | 是 | 否 | string | 否 | 应用的包名。 |
| uid | 是 | 否 | number | 否 | 应用的uid。<br/>**系统能力**：SystemCapability.Notification.Notification | | uid | 是 | 否 | number | 否 | 应用的uid。 |
| enable | 是 | 否 | boolean | 否 | 应用通知使能状态。<br/>**系统能力**：SystemCapability.Notification.Notification | | enable | 是 | 否 | boolean | 否 | 应用通知使能状态。 |
## NotificationRequest ## NotificationRequest
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| --------------------- | ---- | --- | --------------------------------------------- | ---- | -------------------------- | | --------------------- | ---- | --- | --------------------------------------------- | ---- | -------------------------- |
| content | 是 | 是 | [NotificationContent](#notificationcontent) | 是 | 通知内容。<br/>**系统能力**：SystemCapability.Notification.Notification | | content | 是 | 是 | [NotificationContent](#notificationcontent) | 是 | 通知内容。 |
| id | 是 | 是 | number | 否 | 通知ID。<br/>**系统能力**：SystemCapability.Notification.Notification | | id | 是 | 是 | number | 否 | 通知ID。 |
| slotType | 是 | 是 | [SlotType](#slottype) | 否 | 通道类型。<br/>**系统能力**：SystemCapability.Notification.Notification | | slotType | 是 | 是 | [SlotType](#slottype) | 否 | 通道类型。 |
| isOngoing | 是 | 是 | boolean | 否 | 是否进行时通知。<br/>**系统能力**：SystemCapability.Notification.Notification | | isOngoing | 是 | 是 | boolean | 否 | 是否进行时通知。 |
| isUnremovable | 是 | 是 | boolean | 否 | 是否可移除。<br/>**系统能力**：SystemCapability.Notification.Notification | | isUnremovable | 是 | 是 | boolean | 否 | 是否可移除。 |
| deliveryTime | 是 | 是 | number | 否 | 通知发送时间。<br/>**系统能力**：SystemCapability.Notification.Notification | | deliveryTime | 是 | 是 | number | 否 | 通知发送时间。 |
| tapDismissed | 是 | 是 | boolean | 否 | 通知是否自动清除。<br/>**系统能力**：SystemCapability.Notification.Notification | | tapDismissed | 是 | 是 | boolean | 否 | 通知是否自动清除。 |
| autoDeletedTime | 是 | 是 | number | 否 | 自动清除的时间。<br/>**系统能力**：SystemCapability.Notification.Notification | | autoDeletedTime | 是 | 是 | number | 否 | 自动清除的时间。 |
| wantAgent | 是 | 是 | WantAgent | 否 | 点击跳转的WantAgent。<br/>**系统能力**：SystemCapability.Notification.Notification | | wantAgent | 是 | 是 | WantAgent | 否 | 点击跳转的WantAgent。 |
| extraInfo | 是 | 是 | {[key: string]: any} | 否 | 扩展参数。<br/>**系统能力**：SystemCapability.Notification.Notification | | extraInfo | 是 | 是 | {[key: string]: any} | 否 | 扩展参数。 |
| color | 是 | 是 | number | 否 | 通知背景颜色。<br/>**系统能力**：SystemCapability.Notification.Notification | | color | 是 | 是 | number | 否 | 通知背景颜色。 |
| colorEnabled | 是 | 是 | boolean | 否 | 通知背景颜色是否使能。<br/>**系统能力**：SystemCapability.Notification.Notification | | colorEnabled | 是 | 是 | boolean | 否 | 通知背景颜色是否使能。 |
| isAlertOnce | 是 | 是 | boolean | 否 | 设置是否仅有一次此通知警报。<br/>**系统能力**：SystemCapability.Notification.Notification | | isAlertOnce | 是 | 是 | boolean | 否 | 设置是否仅有一次此通知警报。 |
| isStopwatch | 是 | 是 | boolean | 否 | 是否显示已用时间。<br/>**系统能力**：SystemCapability.Notification.Notification | | isStopwatch | 是 | 是 | boolean | 否 | 是否显示已用时间。 |
| isCountDown | 是 | 是 | boolean | 否 | 是否显示倒计时时间。<br/>**系统能力**：SystemCapability.Notification.Notification | | isCountDown | 是 | 是 | boolean | 否 | 是否显示倒计时时间。 |
| isFloatingIcon | 是 | 是 | boolean | 否 | 是否显示状态栏图标。<br/>**系统能力**：SystemCapability.Notification.Notification | | isFloatingIcon | 是 | 是 | boolean | 否 | 是否显示状态栏图标。 |
| label | 是 | 是 | string | 否 | 通知标签。<br/>**系统能力**：SystemCapability.Notification.Notification | | label | 是 | 是 | string | 否 | 通知标签。 |
| badgeIconStyle | 是 | 是 | number | 否 | 通知角标类型。<br/>**系统能力**：SystemCapability.Notification.Notification | | badgeIconStyle | 是 | 是 | number | 否 | 通知角标类型。 |
| showDeliveryTime | 是 | 是 | boolean | 否 | 是否显示分发时间。<br/>**系统能力**：SystemCapability.Notification.Notification | | showDeliveryTime | 是 | 是 | boolean | 否 | 是否显示分发时间。 |
| actionButtons | 是 | 是 | Array\<[NotificationActionButton](#notificationactionbutton)\> | 否 | 通知按钮，最多两个按钮。<br/>**系统能力**：SystemCapability.Notification.Notification | | actionButtons | 是 | 是 | Array\<[NotificationActionButton](#notificationactionbutton)\> | 否 | 通知按钮，最多两个按钮。 |
| smallIcon | 是 | 是 | PixelMap | 否 | 通知小图标。<br/>**系统能力**：SystemCapability.Notification.Notification | | smallIcon | 是 | 是 | PixelMap | 否 | 通知小图标。 |
| largeIcon | 是 | 是 | PixelMap | 否 | 通知大图标。<br/>**系统能力**：SystemCapability.Notification.Notification | | largeIcon | 是 | 是 | PixelMap | 否 | 通知大图标。 |
| creatorBundleName | 是 | 否 | string | 否 | 创建通知的包名。<br/>**系统能力**：SystemCapability.Notification.Notification | | creatorBundleName | 是 | 否 | string | 否 | 创建通知的包名。 |
| creatorUid | 是 | 否 | number | 否 | 创建通知的UID。<br/>**系统能力**：SystemCapability.Notification.Notification | | creatorUid | 是 | 否 | number | 否 | 创建通知的UID。 |
| creatorPid | 是 | 否 | number | 否 | 创建通知的PID。<br/>**系统能力**：SystemCapability.Notification.Notification | | creatorPid | 是 | 否 | number | 否 | 创建通知的PID。 |
| hashCode | 是 | 否 | string | 否 | 通知唯一标识。<br/>**系统能力**：SystemCapability.Notification.Notification | | hashCode | 是 | 否 | string | 否 | 通知唯一标识。 |
| classification | 是 | 是 | string | 否 | 通知分类。<br/>**系统能力**：SystemCapability.Notification.Notification | | classification | 是 | 是 | string | 否 | 通知分类。 |
| groupName | 是 | 是 | string | 否 | 组通知名称。<br/>**系统能力**：SystemCapability.Notification.Notification | | groupName | 是 | 是 | string | 否 | 组通知名称。 |
| template<sup>8+</sup> | 是 | 是 | [NotificationTemplate](#notificationtemplate) | 否 | 通知模板。<br/>**系统能力**：SystemCapability.Notification.Notification | | template<sup>8+</sup> | 是 | 是 | [NotificationTemplate](#notificationtemplate) | 否 | 通知模板。 |
## NotificationSlot ## NotificationSlot
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| -------------------- | ---- | --- | --------------------- | ---- | ------------------------------------------ | | -------------------- | ---- | --- | --------------------- | ---- | ------------------------------------------ |
| type | 是 | 是 | [SlotType](#slottype) | 是 | 通道类型。<br/>**系统能力**：SystemCapability.Notification.Notification | | type | 是 | 是 | [SlotType](#slottype) | 是 | 通道类型。 |
| level | 是 | 是 | number | 否 | 通知级别，不设置则根据通知渠道类型有默认值。<br/>**系统能力**：SystemCapability.Notification.Notification | | level | 是 | 是 | number | 否 | 通知级别，不设置则根据通知渠道类型有默认值。 |
| desc | 是 | 是 | string | 否 | 通知渠道描述信息。<br/>**系统能力**：SystemCapability.Notification.Notification | | desc | 是 | 是 | string | 否 | 通知渠道描述信息。 |
| badgeFlag | 是 | 是 | boolean | 否 | 是否显示角标。<br/>**系统能力**：SystemCapability.Notification.Notification | | badgeFlag | 是 | 是 | boolean | 否 | 是否显示角标。 |
| bypassDnd | 是 | 是 | boolean | 否 | 置是否在系统中绕过免打扰模式。<br/>**系统能力**：SystemCapability.Notification.Notification | | bypassDnd | 是 | 是 | boolean | 否 | 置是否在系统中绕过免打扰模式。 |
| lockscreenVisibility | 是 | 是 | boolean | 否 | 在锁定屏幕上显示通知的模式。<br/>**系统能力**：SystemCapability.Notification.Notification | | lockscreenVisibility | 是 | 是 | boolean | 否 | 在锁定屏幕上显示通知的模式。 |
| vibrationEnabled | 是 | 是 | boolean | 否 | 是否可振动。<br/>**系统能力**：SystemCapability.Notification.Notification | | vibrationEnabled | 是 | 是 | boolean | 否 | 是否可振动。 |
| sound | 是 | 是 | string | 否 | 通知提示音。<br/>**系统能力**：SystemCapability.Notification.Notification | | sound | 是 | 是 | string | 否 | 通知提示音。 |
| lightEnabled | 是 | 是 | boolean | 否 | 是否闪灯。<br/>**系统能力**：SystemCapability.Notification.Notification | | lightEnabled | 是 | 是 | boolean | 否 | 是否闪灯。 |
| lightColor | 是 | 是 | number | 否 | 通知灯颜色。<br/>**系统能力**：SystemCapability.Notification.Notification | | lightColor | 是 | 是 | number | 否 | 通知灯颜色。 |
| vibrationValues | 是 | 是 | Array\<number\> | 否 | 通知振动样式。<br/>**系统能力**：SystemCapability.Notification.Notification | | vibrationValues | 是 | 是 | Array\<number\> | 否 | 通知振动样式。 |
## NotificationContent ## NotificationContent
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ----------- | ---- | --- | ------------------------------------------------------------ | ---- | ------------------ | | ----------- | ---- | --- | ------------------------------------------------------------ | ---- | ------------------ |
| contentType | 是 | 是 | [ContentType](#contenttype) | 是 | 通知内容类型。<br/>**系统能力**：SystemCapability.Notification.Notification | | contentType | 是 | 是 | [ContentType](#contenttype) | 是 | 通知内容类型。 |
| normal | 是 | 是 | [NotificationBasicContent](#notificationbasiccontent) | 否 | 基本类型通知内容。<br/>**系统能力**：SystemCapability.Notification.Notification | | normal | 是 | 是 | [NotificationBasicContent](#notificationbasiccontent) | 否 | 基本类型通知内容。 |
| longText | 是 | 是 | [NotificationLongTextContent](#notificationlongtextcontent) | 否 | 长文本类型通知内容。<br/>**系统能力**：SystemCapability.Notification.Notification | | longText | 是 | 是 | [NotificationLongTextContent](#notificationlongtextcontent) | 否 | 长文本类型通知内容。 |
| multiLine | 是 | 是 | [NotificationMultiLineContent](#notificationmultilinecontent) | 否 | 多行类型通知内容。<br/>**系统能力**：SystemCapability.Notification.Notification | | multiLine | 是 | 是 | [NotificationMultiLineContent](#notificationmultilinecontent) | 否 | 多行类型通知内容。 |
| picture | 是 | 是 | [NotificationPictureContent](#notificationpicturecontent) | 否 | 图片类型通知内容。<br/>**系统能力**：SystemCapability.Notification.Notification | | picture | 是 | 是 | [NotificationPictureContent](#notificationpicturecontent) | 否 | 图片类型通知内容。 |
## ContentType ## ContentType
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| --------------------------------- | ----------- | ---------------- | | --------------------------------- | ----------- | ------------------ |
| NOTIFICATION_CONTENT_BASIC_TEXT | ContentType | 普通类型通知。<br/>**系统能力**：SystemCapability.Notification.Notification | | NOTIFICATION_CONTENT_BASIC_TEXT | ContentType | 普通类型通知。 |
| NOTIFICATION_CONTENT_LONG_TEXT | ContentType | 长文本类型通知。<br/>**系统能力**：SystemCapability.Notification.Notification | | NOTIFICATION_CONTENT_LONG_TEXT | ContentType | 长文本类型通知。 |
| NOTIFICATION_CONTENT_PICTURE | ContentType | 图片类型通知。<br/>**系统能力**：SystemCapability.Notification.Notification | | NOTIFICATION_CONTENT_PICTURE | ContentType | 图片类型通知。 |
| NOTIFICATION_CONTENT_CONVERSATION | ContentType | 社交类型通知。<br/>**系统能力**：SystemCapability.Notification.Notification | | NOTIFICATION_CONTENT_CONVERSATION | ContentType | 社交类型通知。 |
| NOTIFICATION_CONTENT_MULTILINE | ContentType | 多行文本类型通知。<br/>**系统能力**：SystemCapability.Notification.Notification | | NOTIFICATION_CONTENT_MULTILINE | ContentType | 多行文本类型通知。 |
## NotificationBasicContent ## NotificationBasicContent
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| -------------- | ---- |--- | ------ | ---- | -------------------------------- | | -------------- | ---- | ---- | ------ | ---- | ---------------------------------- |
| title | 是 | 是 | string | 是 | 通知标题。<br/>**系统能力**：SystemCapability.Notification.Notification | | title | 是 | 是 | string | 是 | 通知标题。 |
| text | 是 | 是 | string | 是 | 通知内容。<br/>**系统能力**：SystemCapability.Notification.Notification | | text | 是 | 是 | string | 是 | 通知内容。 |
| additionalText | 是 | 是 | string | 是 | 通知次要内容，是对通知内容的补充。<br/>**系统能力**：SystemCapability.Notification.Notification | | additionalText | 是 | 是 | string | 是 | 通知次要内容，是对通知内容的补充。 |
## NotificationLongTextContent ## NotificationLongTextContent
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| -------------- | ---- | --- | ------ | ---- | -------------------------------- | | -------------- | ---- | --- | ------ | ---- | -------------------------------- |
| title | 是 | 是 | string | 是 | 通知标题。<br/>**系统能力**：SystemCapability.Notification.Notification | | title | 是 | 是 | string | 是 | 通知标题。 |
| text | 是 | 是 | string | 是 | 通知内容。<br/>**系统能力**：SystemCapability.Notification.Notification | | text | 是 | 是 | string | 是 | 通知内容。 |
| additionalText | 是 | 是 | string | 是 | 通知次要内容，是对通知内容的补充。<br/>**系统能力**：SystemCapability.Notification.Notification | | additionalText | 是 | 是 | string | 是 | 通知次要内容，是对通知内容的补充。 |
| longText | 是 | 是 | string | 是 | 通知的长文本。<br/>**系统能力**：SystemCapability.Notification.Notification | | longText | 是 | 是 | string | 是 | 通知的长文本。 |
| briefText | 是 | 是 | string | 是 | 通知概要内容，是对通知内容的总结。<br/>**系统能力**：SystemCapability.Notification.Notification | | briefText | 是 | 是 | string | 是 | 通知概要内容，是对通知内容的总结。 |
| expandedTitle | 是 | 是 | string | 是 | 通知展开时的标题。<br/>**系统能力**：SystemCapability.Notification.Notification | | expandedTitle | 是 | 是 | string | 是 | 通知展开时的标题。 |
## NotificationMultiLineContent ## NotificationMultiLineContent
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| -------------- | --- | --- | --------------- | ---- | -------------------------------- | | -------------- | --- | --- | --------------- | ---- | -------------------------------- |
| title | 是 | 是 | string | 是 | 通知标题。<br/>**系统能力**：SystemCapability.Notification.Notification | | title | 是 | 是 | string | 是 | 通知标题。 |
| text | 是 | 是 | string | 是 | 通知内容。<br/>**系统能力**：SystemCapability.Notification.Notification | | text | 是 | 是 | string | 是 | 通知内容。 |
| additionalText | 是 | 是 | string | 是 | 通知次要内容，是对通知内容的补充。<br/>**系统能力**：SystemCapability.Notification.Notification | | additionalText | 是 | 是 | string | 是 | 通知次要内容，是对通知内容的补充。 |
| briefText | 是 | 是 | string | 是 | 通知概要内容，是对通知内容的总结。<br/>**系统能力**：SystemCapability.Notification.Notification | | briefText | 是 | 是 | string | 是 | 通知概要内容，是对通知内容的总结。 |
| longTitle | 是 | 是 | string | 是 | 通知展开时的标题。<br/>**系统能力**：SystemCapability.Notification.Notification | | longTitle | 是 | 是 | string | 是 | 通知展开时的标题。 |
| lines | 是 | 是 | Array\<String\> | 是 | 通知的多行文本。<br/>**系统能力**：SystemCapability.Notification.Notification | | lines | 是 | 是 | Array\<String\> | 是 | 通知的多行文本。 |
## NotificationPictureContent ## NotificationPictureContent
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| -------------- | ---- | --- | -------------- | ---- | -------------------------------- | | -------------- | ---- | --- | -------------- | ---- | -------------------------------- |
| title | 是 | 是 | string | 是 | 通知标题。<br/>**系统能力**：SystemCapability.Notification.Notification | | title | 是 | 是 | string | 是 | 通知标题。 |
| text | 是 | 是 | string | 是 | 通知内容。<br/>**系统能力**：SystemCapability.Notification.Notification | | text | 是 | 是 | string | 是 | 通知内容。 |
| additionalText | 是 | 是 | string | 是 | 通知次要内容，是对通知内容的补充。<br/>**系统能力**：SystemCapability.Notification.Notification | | additionalText | 是 | 是 | string | 是 | 通知次要内容，是对通知内容的补充。 |
| briefText | 是 | 是 | string | 是 | 通知概要内容，是对通知内容的总结。<br/>**系统能力**：SystemCapability.Notification.Notification | | briefText | 是 | 是 | string | 是 | 通知概要内容，是对通知内容的总结。 |
| expandedTitle | 是 | 是 | string | 是 | 通知展开时的标题。<br/>**系统能力**：SystemCapability.Notification.Notification | | expandedTitle | 是 | 是 | string | 是 | 通知展开时的标题。 |
| picture | 是 | 是 | image.PixelMap | 是 | 通知的图片内容。<br/>**系统能力**：SystemCapability.Notification.Notification | | picture | 是 | 是 | image.PixelMap | 是 | 通知的图片内容。 |
## BundleOption ## BundleOption
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ------ | ---- | --- | ------ | ---- | ------ | | ------ | ---- | --- | ------ | ---- | ------ |
| bundle | 是 | 是 | string | 是 | 包名。<br/>**系统能力**：SystemCapability.Notification.Notification | | bundle | 是 | 是 | string | 是 | 包名。 |
| uid | 是 | 是 | number | 否 | 用户id。<br/>**系统能力**：SystemCapability.Notification.Notification | | uid | 是 | 是 | number | 否 | 用户id。 |
## NotificationKey ## NotificationKey
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ----- | ---- | --- | ------ | ---- | -------- | | ----- | ---- | --- | ------ | ---- | -------- |
| id | 是 | 是 | number | 是 | 通知ID。<br/>**系统能力**：SystemCapability.Notification.Notification | | id | 是 | 是 | number | 是 | 通知ID。 |
| label | 是 | 是 | string | 否 | 通知标签。<br/>**系统能力**：SystemCapability.Notification.Notification | | label | 是 | 是 | string | 否 | 通知标签。< |
## SlotType ## SlotType
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| -------------------- | -------- | -------- | | -------------------- | -------- | ---------- |
| SOCIAL_COMMUNICATION | SlotType | 社交类型。<br/>**系统能力**：SystemCapability.Notification.Notification | | SOCIAL_COMMUNICATION | SlotType | 社交类型。 |
| SERVICE_INFORMATION | SlotType | 服务类型。<br/>**系统能力**：SystemCapability.Notification.Notification | | SERVICE_INFORMATION | SlotType | 服务类型。 |
| CONTENT_INFORMATION | SlotType | 内容类型。<br/>**系统能力**：SystemCapability.Notification.Notification | | CONTENT_INFORMATION | SlotType | 内容类型。 |
| OTHER_TYPES | SlotType | 其他类型。<br/>**系统能力**：SystemCapability.Notification.Notification | | OTHER_TYPES | SlotType | 其他类型。 |
## NotificationActionButton ## NotificationActionButton
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| --------- | --- | ---- | ----------------------------------------------- | ---- | ------------------------- | | --------- | --- | ---- | ----------------------------------------------- | ---- | ------------------------- |
| title | 是 | 是 | string | 是 | 按钮标题。<br/>**系统能力**：SystemCapability.Notification.Notification | | title | 是 | 是 | string | 是 | 按钮标题。 |
| wantAgent | 是 | 是 | WantAgent | 是 | 点击按钮时触发的WantAgent。<br/>**系统能力**：SystemCapability.Notification.Notification | | wantAgent | 是 | 是 | WantAgent | 是 | 点击按钮时触发的WantAgent。 |
| extras | 是 | 是 | Array\<String\> | 否 | 按钮扩展信息。<br/>**系统能力**：SystemCapability.Notification.Notification | | extras | 是 | 是 | Array\<String\> | 否 | 按钮扩展信息。 |
| icon | 是 | 是 | image.PixelMap | 否 | 按钮图标。<br/>**系统能力**：SystemCapability.Notification.Notification | | icon | 是 | 是 | image.PixelMap | 否 | 按钮图标。 |
| userInput | 是 | 是 | [NotificationUserInput](#notificationuserinput) | 否 | 用户输入对象实例。<br/>**系统能力**：SystemCapability.Notification.Notification | | userInput | 是 | 是 | [NotificationUserInput](#notificationuserinput) | 否 | 用户输入对象实例。 |
## NotificationUserInput ## NotificationUserInput
**系统能力：**SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| -------- | --- | ---- | ------ | ---- | ----------------------------- | | -------- | --- | ---- | ------ | ---- | ----------------------------- |
| inputKey | 是 | 是 | string | 是 | 用户输入时用于标识此输入的key。<br/>**系统能力**：SystemCapability.Notification.Notification | | inputKey | 是 | 是 | string | 是 | 用户输入时用于标识此输入的key。 |
## NotificationSubscribeInfo ## NotificationSubscribeInfo
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ----------- | --- | ---- | --------------- | ---- | ------------------------------- | | ----------- | --- | ---- | --------------- | ---- | ------------------------------- |
| bundleNames | 是 | 是 | Array\<string\> | 否 | 指定订阅哪些包名的APP发来的通知。<br/>**系统能力**：SystemCapability.Notification.Notification | | bundleNames | 是 | 是 | Array\<string\> | 否 | 指定订阅哪些包名的APP发来的通知。 |
| userId | 是 | 是 | number | 否 | 指定订阅哪个用户下发来的通知。<br/>**系统能力**：SystemCapability.Notification.Notification | | userId | 是 | 是 | number | 否 | 指定订阅哪个用户下发来的通知。 |
...@@ -2304,30 +2343,36 @@ Notification.subscribe(subscriber, subscribeCallback); ...@@ -2304,30 +2343,36 @@ Notification.subscribe(subscriber, subscribeCallback);
模板信息 模板信息
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ---- | ---------------------- | ---- | ---- | -------- | | ---- | ---------------------- | ---- | ---- | ---------- |
| name | string | 是 | 是 | 模板名称。<br/>**系统能力**：SystemCapability.Notification.Notification | | name | string | 是 | 是 | 模板名称。 |
| data | {[key:string]: Object} | 是 | 是 | 模板数据。<br/>**系统能力**：SystemCapability.Notification.Notification | | data | {[key:string]: Object} | 是 | 是 | 模板数据。 |
## ActionResult ## ActionResult
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------ | ---------- | ---- | ---- | -------- | | ------------ | ---------- | ---- | ---- | -------- |
| bundleName | string | 是 | 是 | 点击通知后重定向应用的包名。<br/>**系统能力**：SystemCapability.Notification.Notification | | bundleName | string | 是 | 是 | 点击通知后重定向应用的包名。 |
| abilityName | string | 是 | 是 | 点击通知后重定向应用的的Ability名称。<br/>**系统能力**：SystemCapability.Notification.Notification | | abilityName | string | 是 | 是 | 点击通知后重定向应用的的Ability名称。 |
| uri | string | 是 | 是 | 要重定向到的页面的Uri。<br/>**系统能力**：SystemCapability.Notification.Notification | | uri | string | 是 | 是 | 要重定向到的页面的Uri。 |
## ShowNotificationOptions ## ShowNotificationOptions
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------ | ---------- | ---- | ---- | -------- | | ------------ | ---------- | ---- | ---- | -------- |
| contentTitle | string | 是 | 是 | 通知的标题。<br/>**系统能力**：SystemCapability.Notification.Notification | | contentTitle | string | 是 | 是 | 通知的标题。 |
| contentText | string | 是 | 是 | 通知的内容。<br/>**系统能力**：SystemCapability.Notification.Notification | | contentText | string | 是 | 是 | 通知的内容。 |
| clickAction | ActionResult | 是 | 是 | 点击通知后触发的动作。<br/>**系统能力**：SystemCapability.Notification.Notification | | clickAction | ActionResult | 是 | 是 | 点击通知后触发的动作。 |
...@@ -3244,45 +3289,53 @@ WantAgent.equal(wantAgent1, wantAgent2).then((data) => { ...@@ -3244,45 +3289,53 @@ WantAgent.equal(wantAgent1, wantAgent2).then((data) => {
## WantAgentInfo ## WantAgentInfo
**系统能力：**以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| -------------- | --- | ---- | ------------------------------- | ---- | ---------------------- | | -------------- | --- | ---- | ------------------------------- | ---- | ---------------------- |
| wants | 是 | 是 | Array\<Want\> | 是 | 将被执行的动作列表。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | wants | 是 | 是 | Array\<Want\> | 是 | 将被执行的动作列表。 |
| operationType | 是 | 是 | wantAgent.OperationType | 是 | 动作类型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | operationType | 是 | 是 | wantAgent.OperationType | 是 | 动作类型。 |
| requestCode | 是 | 是 | number | 是 | 使用者定义的一个私有值。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | requestCode | 是 | 是 | number | 是 | 使用者定义的一个私有值。 |
| wantAgentFlags | 是 | 是 | Array<wantAgent.WantAgentFlags> | 否 | 动作执行属性。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | wantAgentFlags | 是 | 是 | Array<wantAgent.WantAgentFlags> | 否 | 动作执行属性。 |
| extraInfo | 是 | 是 | {[key: string]: any} | 否 | 额外数据。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | extraInfo | 是 | 是 | {[key: string]: any} | 否 | 额外数据。 |
## WantAgentFlags ## WantAgentFlags
**系统能力：**以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------------- | -------------- | ------------------------------------------------------------ | | ------------------- | -------------- | ------------------------------------------------------------ |
| ONE_TIME_FLAG | WantAgentFlags | WantAgent仅能使用一次。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | ONE_TIME_FLAG | WantAgentFlags | WantAgent仅能使用一次。 |
| NO_BUILD_FLAG | WantAgentFlags | 如果描述WantAgent对象不存在，则不创建它，直接返回null。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | NO_BUILD_FLAG | WantAgentFlags | 如果描述WantAgent对象不存在，则不创建它，直接返回null。 |
| CANCEL_PRESENT_FLAG | WantAgentFlags | 在生成一个新的WantAgent对象前取消已存在的一个WantAgent对象。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | CANCEL_PRESENT_FLAG | WantAgentFlags | 在生成一个新的WantAgent对象前取消已存在的一个WantAgent对象。 |
| UPDATE_PRESENT_FLAG | WantAgentFlags | 使用新的WantAgent的额外数据替换已存在的WantAgent中的额外数据。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | UPDATE_PRESENT_FLAG | WantAgentFlags | 使用新的WantAgent的额外数据替换已存在的WantAgent中的额外数据。 |
| CONSTANT_FLAG | WantAgentFlags | WantAgent是不可变的。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | CONSTANT_FLAG | WantAgentFlags | WantAgent是不可变的。 |
## OperationType ## OperationType
**系统能力：**以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ----------------- | ------------- | ----------------------- | | ----------------- | ------------- | ------------------------- |
| UNKNOWN_TYPE | OperationType | 不识别的类型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | UNKNOWN_TYPE | OperationType | 不识别的类型。 |
| START_ABILITY | OperationType | 开启一个有页面的Ability。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | START_ABILITY | OperationType | 开启一个有页面的Ability。 |
| START_ABILITIES | OperationType | 开启多个有页面的Ability。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | START_ABILITIES | OperationType | 开启多个有页面的Ability。 |
| START_SERVICE | OperationType | 开启一个无页面的ability。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | START_SERVICE | OperationType | 开启一个无页面的ability。 |
| SEND_COMMON_EVENT | OperationType | 发送一个公共事件。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | SEND_COMMON_EVENT | OperationType | 发送一个公共事件。 |
## TriggerInfo ## TriggerInfo
**系统能力：**以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ---------- | --- | ---- | -------------------- | ---- | ----------- | | ---------- | --- | ---- | -------------------- | ---- | ----------- |
| code | 是 | 是 | number | 是 | result code。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | code | 是 | 是 | number | 是 | result code。 |
| want | 是 | 是 | Want | 否 | Want。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | want | 是 | 是 | Want | 否 | Want。 |
| permission | 是 | 是 | string | 否 | 权限定义。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | permission | 是 | 是 | string | 否 | 权限定义。 |
| extraInfo | 是 | 是 | {[key: string]: any} | 否 | 额外数据。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | | extraInfo | 是 | 是 | {[key: string]: any} | 否 | 额外数据。 |
zh-cn/application-dev/reference/apis/js-apis-reminderAgent.md
浏览文件 @ a3ded774
...@@ -11,11 +11,6 @@ import reminderAgent from'@ohos.reminderAgent'; ...@@ -11,11 +11,6 @@ import reminderAgent from'@ohos.reminderAgent';
``` ```
## 系统能力
SystemCapability.Notification.ReminderAgent
## 权限 ## 权限
ohos.permission.PUBLISH_AGENT_REMINDER ohos.permission.PUBLISH_AGENT_REMINDER
...@@ -27,6 +22,10 @@ publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback&lt;number& ...@@ -27,6 +22,10 @@ publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback&lt;number&
发布一个后台代理提醒，使用callback方式实现异步调用。 发布一个后台代理提醒，使用callback方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -54,6 +53,10 @@ publishReminder(reminderReq: ReminderRequest): Promise&lt;number&gt; ...@@ -54,6 +53,10 @@ publishReminder(reminderReq: ReminderRequest): Promise&lt;number&gt;
发布一个后台代理提醒，使用Promise方式实现异步调用。 发布一个后台代理提醒，使用Promise方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -86,6 +89,10 @@ cancelReminder(reminderId: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -86,6 +89,10 @@ cancelReminder(reminderId: number, callback: AsyncCallback&lt;void&gt;): void
取消指定id的提醒，使用callback方式实现异步调用。 取消指定id的提醒，使用callback方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -111,6 +118,10 @@ cancelReminder(reminderId: number): Promise&lt;void&gt; ...@@ -111,6 +118,10 @@ cancelReminder(reminderId: number): Promise&lt;void&gt;
取消指定id的提醒，使用Promise方式实现异步调用。 取消指定id的提醒，使用Promise方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -142,6 +153,10 @@ getValidReminders(callback: AsyncCallback&lt;Array&lt;ReminderRequest&gt;&gt;): ...@@ -142,6 +153,10 @@ getValidReminders(callback: AsyncCallback&lt;Array&lt;ReminderRequest&gt;&gt;):
获取当前应用已设置的所有有效（未过期）的提醒，使用callback方式实现异步调用。 获取当前应用已设置的所有有效（未过期）的提醒，使用callback方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -183,6 +198,10 @@ getValidReminders(): Promise&lt;Array&lt;ReminderRequest&gt;&gt; ...@@ -183,6 +198,10 @@ getValidReminders(): Promise&lt;Array&lt;ReminderRequest&gt;&gt;
获取当前应用已设置的所有有效（未过期）的提醒，使用Promise方式实现异步调用。 获取当前应用已设置的所有有效（未过期）的提醒，使用Promise方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
...@@ -224,6 +243,10 @@ cancelAllReminders(callback: AsyncCallback&lt;void&gt;): void ...@@ -224,6 +243,10 @@ cancelAllReminders(callback: AsyncCallback&lt;void&gt;): void
取消当前应用所有的提醒，使用callback方式实现异步调用。 取消当前应用所有的提醒，使用callback方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -244,6 +267,10 @@ cancelAllReminders(): Promise&lt;void&gt; ...@@ -244,6 +267,10 @@ cancelAllReminders(): Promise&lt;void&gt;
取消当前应用所有的提醒，使用Promise方式实现异步调用。 取消当前应用所有的提醒，使用Promise方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
...@@ -264,6 +291,10 @@ addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback&lt;void&gt;) ...@@ -264,6 +291,10 @@ addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback&lt;void&gt;)
添加一个NotificationSlot，使用callback方式实现异步调用。 添加一个NotificationSlot，使用callback方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -293,6 +324,10 @@ addNotificationSlot(slot: NotificationSlot): Promise&lt;void&gt; ...@@ -293,6 +324,10 @@ addNotificationSlot(slot: NotificationSlot): Promise&lt;void&gt;
添加一个NotificationSlot，使用Promise方式实现异步调用。 添加一个NotificationSlot，使用Promise方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -327,6 +362,10 @@ removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback& ...@@ -327,6 +362,10 @@ removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback&
删除目标NotificationSlot，使用callback方式实现异步调用。 删除目标NotificationSlot，使用callback方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -352,6 +391,10 @@ removeNotificationSlot(slotType: notification.SlotType): Promise&lt;void&gt; ...@@ -352,6 +391,10 @@ removeNotificationSlot(slotType: notification.SlotType): Promise&lt;void&gt;
删除目标NotificationSlot，使用Promise方式实现异步调用。 删除目标NotificationSlot，使用Promise方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -380,6 +423,8 @@ export default { ...@@ -380,6 +423,8 @@ export default {
按钮的类型。 按钮的类型。
- 系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| ACTION_BUTTON_TYPE_CLOSE | 0 | 表示关闭提醒的按钮。 | | ACTION_BUTTON_TYPE_CLOSE | 0 | 表示关闭提醒的按钮。 |
...@@ -390,6 +435,8 @@ export default { ...@@ -390,6 +435,8 @@ export default {
提醒的类型。 提醒的类型。
- 系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| REMINDER_TYPE_TIMER | 0 | 表示提醒类型：倒计时。 | | REMINDER_TYPE_TIMER | 0 | 表示提醒类型：倒计时。 |
...@@ -401,6 +448,8 @@ export default { ...@@ -401,6 +448,8 @@ export default {
用于设置弹出的提醒通知信息上显示的按钮类型和标题。 用于设置弹出的提醒通知信息上显示的按钮类型和标题。
- 系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| title | string | 是 | 按钮显示的标题。 | | title | string | 是 | 按钮显示的标题。 |
...@@ -411,6 +460,8 @@ export default { ...@@ -411,6 +460,8 @@ export default {
点击提醒通知后跳转的目标ability信息。 点击提醒通知后跳转的目标ability信息。
- 系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pkgName | string | 是 | 指明点击提醒通知栏后跳转的目标hap包名。 | | pkgName | string | 是 | 指明点击提醒通知栏后跳转的目标hap包名。 |
...@@ -421,6 +472,8 @@ export default { ...@@ -421,6 +472,8 @@ export default {
提醒到达时自动拉起的目标ability信息。 提醒到达时自动拉起的目标ability信息。
- 系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pkgName | string | 是 | 指明提醒到达时自动拉起的目标hap包名（如果设备在使用中，则只弹出通知横幅框）。 | | pkgName | string | 是 | 指明提醒到达时自动拉起的目标hap包名（如果设备在使用中，则只弹出通知横幅框）。 |
...@@ -431,6 +484,8 @@ export default { ...@@ -431,6 +484,8 @@ export default {
提醒实例对象，用于设置提醒类型、响铃时长等具体信息。 提醒实例对象，用于设置提醒类型、响铃时长等具体信息。
- 系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| reminderType | ReminderType | 是 | 指明提醒类型。 | | reminderType | ReminderType | 是 | 指明提醒类型。 |
...@@ -454,6 +509,8 @@ ReminderRequestCalendar extends ReminderRequest ...@@ -454,6 +509,8 @@ ReminderRequestCalendar extends ReminderRequest
日历实例对象，用于设置提醒的时间。 日历实例对象，用于设置提醒的时间。
- 系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| dateTime | [LocalDateTime](#localdatetime) | 是 | 指明提醒的目标时间。 | | dateTime | [LocalDateTime](#localdatetime) | 是 | 指明提醒的目标时间。 |
...@@ -467,6 +524,8 @@ ReminderRequestAlarm extends ReminderRequest ...@@ -467,6 +524,8 @@ ReminderRequestAlarm extends ReminderRequest
闹钟实例对象，用于设置提醒的时间。 闹钟实例对象，用于设置提醒的时间。
- 系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| hour | number | 是 | 指明提醒的目标时刻。 | | hour | number | 是 | 指明提醒的目标时刻。 |
...@@ -480,6 +539,8 @@ ReminderRequestTimer extends ReminderRequest ...@@ -480,6 +539,8 @@ ReminderRequestTimer extends ReminderRequest
倒计时实例对象，用于设置提醒的时间。 倒计时实例对象，用于设置提醒的时间。
- 系统能力：SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| triggerTimeInSeconds | number | 是 | 指明倒计时的秒数。 | | triggerTimeInSeconds | number | 是 | 指明倒计时的秒数。 |
...@@ -489,6 +550,8 @@ ReminderRequestTimer extends ReminderRequest ...@@ -489,6 +550,8 @@ ReminderRequestTimer extends ReminderRequest
用于日历类提醒设置时指定时间信息。 用于日历类提醒设置时指定时间信息。
- 系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| year | number | 是 | 年 | | year | number | 是 | 年 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或