IShowNotificationRequest
This object needs to be passed as the request object for show notification publish API.
Functions
setTitle
Function to set Title.
setTitle(title: string): void;| Parameter Name | Required? | Description |
|---|---|---|
| title | Yes | Title of the notification. |
setSummary
Function to set Summary of notification message.
setSummary(title: string): void;| Parameter Name | Required? | Description |
|---|---|---|
| summary | Yes | Summary of the notification |
setIcon
Icon of the notification as url.
setIcon(icon: string): void;| Parameter Name | Required? | Description |
|---|---|---|
| icon | No | The icon of the notification. |
setClosable
Function to set manual close functionality.
setClosable(isClosable: boolean): void;| Parameter Name | Required? | Description |
|---|---|---|
| isClosable | No | Should display close icon or not in the notification. |
setAutoTimeout
Function to set AutoTimeout. For example: 1 for 1 second, 6 for 6 seconds and so on. Notification will close automatically after this given time.
setAutoTimeout(time: number): void;| Parameter Name | Required? | Description |
|---|---|---|
| isClosable | No | Should display close icon or not in the notification. |
setType
Function to set type. Possible option are: error, warning, confirmation, info and none. Default will be Info.
setType(type: string): void;| Parameter Name | Required? | Description |
|---|---|---|
| type | No | The type of the notification. It shows corresponding icon to the given type if Icon isn't provided with setIcon. |
setActions
Function to set actions in notification. For example: [{id: 'openPage1', name: 'Open Page 1'}, {id: 'openPage2', name: 'Open Page 2'}]
setActions(actions: INotificationActionPayload[]): void;| Parameter Name | Required? | Description |
|---|---|---|
| title | Yes | The title of the notification. |