js-apis-system-notification.md 2.8 KB
Newer Older
E
add doc  
ester.zhou 已提交
1 2
# Notification

3
> ![icon-note.gif]public_sys-resources/icon-note.gif) **NOTE**<br/>
E
add doc  
ester.zhou 已提交
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
> - The APIs of this module are no longer maintained since API version 7. You are advised to use [`@ohos.notification`](js-apis-notification.md).
> 
> - The initial APIs of this module are supported since API version 3. Newly added APIs will be marked with a superscript to indicate their earliest API version.


## Modules to Import


```
import notification from '@system.notification';
```

## ActionResult

**System capability**: SystemCapability.Notification.Notification

| Name       | Readable| Writable| Type                                          | Mandatory| Description                     |
| ----------- | --- | ---- | ---------------------------------------------- | ---- | ------------------------- |
| bundleName  | Yes | Yes | string                                          | Yes  | Name of the application bundle to which the notification will be redirected after being clicked.                 |
| abilityName | Yes | Yes | string                                          | Yes  | Name of the application ability to which the notification will be redirected after being clicked.|
| uri         | Yes | Yes | string                                          | No  | URI of the page to be redirected to.             |


## ShowNotificationOptions

**System capability**: SystemCapability.Notification.Notification

| Name         | Readable| Writable| Type                                          | Mandatory| Description                       |
| ------------- | --- | ---- | ---------------------------------------------- | ---- | ------------------------- |
| contentTitle  | Yes | Yes | string                                          | No  | Notification title.                 |
| contentText   | Yes | Yes | string                                          | No  | Notification content.                 |
| clickAction   | Yes | Yes | ActionResult                                    | No  | Action triggered when the notification is clicked.    |


## notification.show

show(options?: ShowNotificationOptions): void

Displays a notification.

**System capability**: SystemCapability.Notification.Notification

**Parameters**

| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| options | ShowNotificationOptions | No| Notification title.|

**Example**
```javascript
export default {    
  show() {        
    notification.show({            
      contentTitle: 'title info',            
        contentText: 'text',            
        clickAction: {                
          bundleName: 'com.example.testapp',                
          abilityName: 'notificationDemo',                
          uri: '/path/to/notification',            
         },
     });    
  },
}
;
```