js-apis-system-notification.md 2.4 KB
Newer Older
1
# @system.notification (通知消息)
Z
zengyawen 已提交
2

zyjhandsome's avatar
zyjhandsome 已提交
3
> **说明:**
Z
zengyawen 已提交
4
> - 从API Version 7 开始,该接口不再维护,推荐使用新接口[`@ohos.notification`](js-apis-notification.md)。
Z
zengyawen 已提交
5 6 7 8 9 10 11
> 
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


## 导入模块


12
```ts
Z
zengyawen 已提交
13 14 15
import notification from '@system.notification';
```

16 17 18 19
## ActionResult

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

Y
yuyaozhi 已提交
20 21 22 23 24
| 名称        | 类型                                           | 必填 | 说明                      |
| ----------- | ---------------------------------------------- | ---- | ------------------------- |
| bundleName  | string                                          | 是   | 单击通知后要重定向到的应用程序的Bundle名。                  |
| abilityName  | string                                          | 是   | 单击通知后要重定向到的应用程序的Ability名称。 |
| uri         | string                                          | 否   | 要重定向到的页面的uri。              |
25 26 27 28 29 30


## ShowNotificationOptions

**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification

Y
yuyaozhi 已提交
31 32 33 34 35
| 名称          | 类型                                           | 必填 | 说明                        |
| ------------- | ---------------------------------------------- | ---- | ------------------------- |
| contentTitle  | string                                          | 否   | 通知标题。                  |
| contentText   | string                                          | 否   | 通知内容。                  |
| clickAction   | ActionResult                                    | 否   | 通知被点击后触发的行为。     |
36

Z
zengyawen 已提交
37 38 39

## notification.show

40
show(options?: ShowNotificationOptions): void
Z
zengyawen 已提交
41 42 43 44 45 46 47 48 49

显示通知。

**系统能力:** SystemCapability.Notification.Notification

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
50
| options | ShowNotificationOptions | 否 | 通知标题。 |
Z
zengyawen 已提交
51 52

**示例:**
X
xuzhihao 已提交
53
```ts
X
xuzhihao 已提交
54
let notificationObj: notification = {
X
xuzhihao 已提交
55 56 57 58 59 60 61 62 63 64 65
  show() {
    notification.show({
      contentTitle: 'title info',
      contentText: 'text',
      clickAction: {
        bundleName: 'com.example.testapp',
        abilityName: 'notificationDemo',
        uri: '/path/to/notification'
      }
    });
  }
Z
zengyawen 已提交
66
}
X
xuzhihao 已提交
67

X
xuzhihao 已提交
68
export default notificationObj
Z
zengyawen 已提交
69
```