Class Notifications

Hierarchy

TagoIOModule<GenericModuleParams>
- Notifications

Index

Constructors

Methods

create list markAllAsRead markAsRead markAsUnread notificationButton registerDevice remove unRegisterDevice

Constructors

constructor

new Notifications(params): Notifications
Parameters
- params: GenericModuleParams
Returns Notifications
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:79

Methods

create

create(notificationData): Promise<{
id: string;
}>
Create a notification
Parameters
- notificationData: NotificationCreate
  
  Notification Object
Returns Promise<{
id: string;
}>
Example
```
notificationData: [
  {
    title: "My notification title",
    message: "My notification message"
  }
]
```
- Defined in modules/Resources/Notifications.ts:104

list

list(queryObj?): Promise<NotificationInfo[]>
Retrieves a list with all actions from the account
Parameters
- Optional queryObj: NotificationQuery
  
  Search query params
Returns Promise<NotificationInfo[]>
- Defined in modules/Resources/Notifications.ts:11

markAllAsRead

markAllAsRead(): Promise<string>
Mark all notifications as read

Returns Promise<string>
- Defined in modules/Resources/Notifications.ts:68

markAsRead

markAsRead(notificationIDS): Promise<string>
Mark notifications as read
Parameters
- notificationIDS: string | string[]
  
  An array of ids or a single id
Returns Promise<string>
- Defined in modules/Resources/Notifications.ts:27

markAsUnread

markAsUnread(notificationIDS): Promise<string>
Mark notifications as unread
Parameters
- notificationIDS: string | string[]
  
  An array of ids or a single id
Returns Promise<string>
- Defined in modules/Resources/Notifications.ts:48

notificationButton

notificationButton(notificationID, buttonID): Promise<string>
Acknowledge notification button pressed
Parameters
- notificationID: string
  
  ID of the notification
- buttonID: string
  
  ID of the button
Returns Promise<string>
- Defined in modules/Resources/Notifications.ts:82

registerDevice

registerDevice(deviceToken, platform): Promise<string>
Register device Token on Push Notification Service
Parameters
- deviceToken: string
  
  Device token
- platform: "android" | "ios"
  
  Platform of device
Returns Promise<string>
- Defined in modules/Resources/Notifications.ts:132

remove

remove(notificationID): Promise<string>
Remove a notification
Parameters
- notificationID: string
  
  Notification identification
Returns Promise<string>
- Defined in modules/Resources/Notifications.ts:118

unRegisterDevice

unRegisterDevice(deviceToken): Promise<string>
Unregister device Token on Push Notification Service
Parameters
- deviceToken: string
  
  Device token
Returns Promise<string>
- Defined in modules/Resources/Notifications.ts:149