Class Notifications

Hierarchy

TagoIOModule<GenericModuleParams>
- Notifications

Index

Constructors

constructor

Methods

Constructors

constructor

new Notifications(params: GenericModuleParams): Notifications

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

Methods

create

create(notificationData: NotificationCreate): Promise<{ id: string }>

- Defined in src/modules/Account/Notifications.ts:104
Create a notification
example
```
notificationData: [
  {
    title: "My notification title",
    message: "My notification message"
  }
]
```
Parameters
- notificationData: NotificationCreate
  
  Notification Object
Returns Promise<{ id: string }>

list

list(queryObj?: NotificationQuery): Promise<NotificationInfo[]>

- Defined in src/modules/Account/Notifications.ts:11
Retrieves a list with all actions from the account

Parameters
- Optional queryObj: NotificationQuery
  
  Search query params
Returns Promise<NotificationInfo[]>

markAllAsRead

markAllAsRead(): Promise<string>

- Defined in src/modules/Account/Notifications.ts:68
Mark all notifications as read

Returns Promise<string>

markAsRead

markAsRead(notificationIDS: string | string[]): Promise<string>

- Defined in src/modules/Account/Notifications.ts:27
Mark notifications as read

Parameters
- notificationIDS: string | string[]
  
  An array of ids or a single id
Returns Promise<string>

markAsUnread

markAsUnread(notificationIDS: string | string[]): Promise<string>

- Defined in src/modules/Account/Notifications.ts:48
Mark notifications as unread

Parameters
- notificationIDS: string | string[]
  
  An array of ids or a single id
Returns Promise<string>

notificationButton

notificationButton(notificationID: string, buttonID: string): Promise<string>

- Defined in src/modules/Account/Notifications.ts:82
Acknowledge notification button pressed

Parameters
- notificationID: string
  
  ID of the notification
- buttonID: string
  
  ID of the button
Returns Promise<string>

registerDevice

registerDevice(deviceToken: string, platform: "android" | "ios"): Promise<string>

- Defined in src/modules/Account/Notifications.ts:132
Register device Token on Push Notification Service

Parameters
- deviceToken: string
  
  Device token
- platform: "android" | "ios"
  
  Platform of device
Returns Promise<string>

remove

remove(notificationID: string): Promise<string>

- Defined in src/modules/Account/Notifications.ts:118
Remove a notification

Parameters
- notificationID: string
  
  Notification identification
Returns Promise<string>

unRegisterDevice

unRegisterDevice(deviceToken: string): Promise<string>

- Defined in src/modules/Account/Notifications.ts:149
Unregister device Token on Push Notification Service

Parameters
- deviceToken: string
  
  Device token
Returns Promise<string>