Skip to content

D
Docs

yang2765 / Docs
与 Fork 源项目一致

Fork自 OpenHarmony / Docs

通知 1
Star 0
Fork 0
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

提交 9c49ac6e 编写于 作者: X xuzhihao
浏览文件
操作

Fix issues of CommonEvent & Notification 

Signed-off-by: Nxuzhihao <xuzhihao16@huawei.com>
上级 78e4ae97
隐藏空白更改
内联 并排
Showing with 55 addition and 45 deletion
zh-cn/application-dev/reference/apis/js-apis-commonEventData.md
浏览文件 @ 9c49ac6e
......@@ -5,12 +5,12 @@
## CommonEventData
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | -------------------- | ---- | ------------------------------------------------------- |
| event | 只读 | string | 是 | 表示当前接收的公共事件名称 |
| bundleName | 只读 | string | 否 | 表示包名称 |
| code | 只读 | number | 否 | 表示公共事件的结果代码，用于传递int类型的数据 |
| data | 只读 | string | 否 | 表示公共事件的自定义结果数据，用于传递string类型的数据< |
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 |
\ No newline at end of file
| event | 只读 | string | 是 | 表示当前接收的公共事件名称。 |
| bundleName | 只读 | string | 否 | 表示包名称。 |
| code | 只读 | number | 否 | 表示公共事件的结果代码，用于传递int类型的数据。 |
| data | 只读 | string | 否 | 表示公共事件的自定义结果数据，用于传递string类型的数据。 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-commonEventPublishData.md
浏览文件 @ 9c49ac6e
......@@ -5,15 +5,15 @@
## CommonEventPublishData
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------------------- | -------- | -------------------- | ---- | ---------------------------- |
| bundleName | 只读 | string | 否 | 表示包名称 |
| code | 只读 | number | 否 | 表示公共事件的结果代码 |
| data | 只读 | string | 否 | 表示公共事件的自定义结果数据 |
| subscriberPermissions | 只读 | Array\<string> | 否 | 表示订阅者的权限 |
| isOrdered | 只读 | boolean | 否 | 表示是否是有序事件 |
| isSticky | 只读 | boolean | 否 | 表示是否是粘性事件 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 |
| bundleName | 只读 | string | 否 | 表示包名称。 |
| code | 只读 | number | 否 | 表示公共事件的结果代码。 |
| data | 只读 | string | 否 | 表示公共事件的自定义结果数据。 |
| subscriberPermissions | 只读 | Array\<string> | 否 | 表示订阅者的权限。 |
| isOrdered | 只读 | boolean | 否 | 表示是否是有序事件。 |
| isSticky | 只读 | boolean | 否 | 表示是否是粘性事件。 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息。 |
zh-cn/application-dev/reference/apis/js-apis-commonEventSubscribeInfo.md
浏览文件 @ 9c49ac6e
......@@ -5,12 +5,12 @@
## CommonEventSubscribeInfo
**系统能力：**以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | -------------- | ---- | ------------------------------------------------------------ |
| events | 只读 | Array\<string> | 是 | 表示要发送的公共事件 |
| publisherPermission | 只读 | string | 否 | 表示发布者的权限 |
| publisherDeviceId | 只读 | string | 否 | 表示设备ID，该值必须是同一ohos网络上的现有设备ID |
| events | 只读 | Array\<string> | 是 | 表示要发送的公共事件。 |
| publisherPermission | 只读 | string | 否 | 表示发布者的权限。 |
| publisherDeviceId | 只读 | string | 否 | 表示设备ID，该值必须是同一ohos网络上的现有设备ID。 |
| userId | 只读 | number | 否 | 表示用户ID。此参数是可选的，默认值当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。 |
| priority | 只读 | number | 否 | 表示订阅者的优先级。值的范围是-100到1000 |
\ No newline at end of file
| priority | 只读 | number | 否 | 表示订阅者的优先级。值的范围是-100到1000。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-commonEventSubscriber.md
浏览文件 @ 9c49ac6e
......@@ -17,7 +17,7 @@ getCode(callback: AsyncCallback\<number>): void
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<number> | 是 | 公共事件的结果代码 |
| callback | AsyncCallback\<number> | 是 | 公共事件的结果代码。 |
**示例：**
......@@ -104,7 +104,7 @@ setCode(code: number): Promise\<void>
| 参数名 | 类型 | 必填 | 描述 |
| ------ | ------ | ---- | ------------------ |
| code | number | 是 | 公共事件的结果代码 |
| code | number | 是 | 公共事件的结果代码。 |
**示例：**
......@@ -160,7 +160,7 @@ getData(): Promise\<string>
| 类型 | 说明 |
| ---------------- | ------------------ |
| Promise\<string> | 公共事件的结果数据 |
| Promise\<string> | 公共事件的结果数据。 |
**示例：**
......@@ -186,8 +186,8 @@ setData(data: string, callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| data | string | 是 | 公共事件的结果数据 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
| data | string | 是 | 公共事件的结果数据。 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 |
**示例：**
......@@ -472,7 +472,7 @@ clearAbortCommonEvent(callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 |
**示例：**
......@@ -522,7 +522,7 @@ getAbortCommonEvent(callback: AsyncCallback\<boolean>): void
| 参数名 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 表示当前有序公共事件是否取消的状态 |
| callback | AsyncCallback\<boolean> | 是 | 表示当前有序公共事件是否取消的状态。 |
**示例：**
......@@ -552,7 +552,7 @@ getAbortCommonEvent(): Promise\<boolean>
| 类型 | 说明 |
| ----------------- | ---------------------------------- |
| Promise\<boolean> | 表示当前有序公共事件是否取消的状态 |
| Promise\<boolean> | 表示当前有序公共事件是否取消的状态。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-notification.md
浏览文件 @ 9c49ac6e
......@@ -186,7 +186,7 @@ Notification.cancel(0, "label", cancelCallback)
## Notification.cancel
cancel(id：number, label? ：string): Promise\<void\>
cancel(id：number, label?：string): Promise\<void\>
取消与指定id相匹配的已发布通知,label可以指定也可以不指定（Promise形式)。
......@@ -2562,7 +2562,7 @@ Notification.getDeviceRemindType()
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ----- | ---- | --- | ------ | ---- | -------- |
| id | 是 | 是 | number | 是 | 通知ID。 |
| label | 是 | 是 | string | 否 | 通知标签。< |
| label | 是 | 是 | string | 否 | 通知标签。 |
## SlotType
......
zh-cn/application-dev/reference/apis/js-apis-notificationFlags.md
浏览文件 @ 9c49ac6e
......@@ -13,7 +13,7 @@
| -------------- | --- | --------------------------------- |
| TYPE_NONE | 0 | 默认标志。 |
| TYPE_OPEN | 1 | 通知标志打开。 |
| TYPE_CLOSE | 2 | 通知标志打开。 |
| TYPE_CLOSE | 2 | 通知标志关闭。 |
## NotificationFlags
......
zh-cn/application-dev/reference/apis/js-apis-notificationSubscriber.md
浏览文件 @ 9c49ac6e
......@@ -101,7 +101,7 @@ onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap))
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------ | ---- | -------------------------- |
| data | [NotificationSortingMap](#notificationsortingmap) | 是 | |
| data | [NotificationSortingMap](#notificationsortingmap) | 是 | 回调返回接收到的通知信息。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-system-notification.md
浏览文件 @ 9c49ac6e
......@@ -13,10 +13,31 @@
import notification from '@system.notification';
```
## ActionResult
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ----------- | --- | ---- | ---------------------------------------------- | ---- | ------------------------- |
| bundleName | 是 | 是 | string | 是 | 单击通知后要重定向到的应用程序的Bundle名。 |
| abilityName | 是 | 是 | string | 是 | 单击通知后要重定向到的应用程序的Ability名称。 |
| uri | 是 | 是 | string | 否 | 要重定向到的页面的uri。 |
## ShowNotificationOptions
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ------------- | --- | ---- | ---------------------------------------------- | ---- | ------------------------- |
| contentTitle | 是 | 是 | string | 否 | 通知标题。 |
| contentText | 是 | 是 | string | 否 | 通知内容。 |
| clickAction | 是 | 是 | ActionResult | 否 | 通知被点击后触发的行为。 |
## notification.show
show(contentTitle: string, contentText: string, clickAction: ActionInfo): void
show(options?: ShowNotificationOptions): void
显示通知。
......@@ -26,21 +47,10 @@ show(contentTitle: string, contentText: string, clickAction: ActionInfo): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| contentTitle | string | 否 | 通知标题。 |
| contentText | string | 否 | 通知内容。 |
| clickAction | ActionInfo | 否 | 通知点击后触发的动作。 |
**表1** ActionInfo
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| bundleName | string | 是 | 点击通知后要跳转到的应用的bundleName |
| abilityName | string | 是 | 点击通知后要跳转到的应用的abilityName |
| uri | string | 是 | 要跳转到的uri，可以是下面的两种格式：<br/>-&nbsp;页面绝对路径，由配置文件中pages列表提供，例如：<br/>&nbsp;&nbsp;-&nbsp;pages/index/index<br/>&nbsp;&nbsp;-&nbsp;pages/detail/detail<br/>-&nbsp;特殊的，如果uri的值是"/"，则跳转到首页。 |
| options | ShowNotificationOptions | 否 | 通知标题。 |
**示例：**
```
```javascript
export default {
show() {
notification.show({
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或