Notification#
| Name | Mandatory | Type | Description |
|---|
id | yes | Int | Id of the notification |
isRead | yes | Bool | Whether the notification is read |
title | yes | String | Title of the notificaton |
message | yes | String | Message of the notificaton |
link | yes | String | Check out Notification's link more details |
sender | yes | String | Sender service of the notification |
createdAt | yes | DateTime | Created time of the notification |
updatedAt | yes | String | Last updated time service of the notification |
imageUrl | no | String | Image url of the notication |
Notification's link#
link is formatted as a JSON string of an object containing additional information for the message to:
- Show more details about in-app notifications.
- Define the corresponding action when clicking on the notification on the application.
The information is defined by the services, that will send notifications to the app, with the object format as below.
| Name | Mandatory | Type | Description | Example |
|---|
| type | yes | String | Type of the notification | "noti" |
| data | yes | Object | Corresponding data with type | |
Object data for type = "noti": used to open deeplink when clicking the notifications.
| Name | Mandatory | type | Description | Example |
|---|
| deeplink | yes | String | Link to the corresponding web/screen of the notification | https://terra.teko.vn/ |
For example:
{\"type\":\"noti\",\"data\":{\"deeplink\": \"https://terra.teko.vn\"}}
Notification List Result#
| Name | Mandatory | Type | Description |
|---|
notifications | yes | List<Notification> | Notification List |
unreadNotificationsCount | yes | Bool | The number of unread notification in the all notifications |
pagination | no | Pagination | Pagination info |
Pagination#
| Name | Mandatory | Type | Description |
|---|
totalItems | yes | Int | The number of total items |
currentPage | yes | Int | Current page |
pageSize | yes | Int | Page size |