Class Notifications

Index

Constructors

constructor

Methods

create list markAllAsRead markAsRead markAsUnread notificationButton registerDevice remove unRegisterDevice

Constructors

constructor

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

Methods

create

create(notificationData: NotificationCreate): Promise<{ id: string }>
Creates a new notification in the system.
Parameters
- notificationData: NotificationCreate
Returns Promise<{ id: string }>
See
https://help.tago.io/portal/en/kb/articles/11-notification Notification
Example
If receive an error "Authorization Denied", check policy Profile / Create notification in Access Management.
```
const result = await Resources.notifications.create({ title: "System Update", message: "New features available" });
console.log(result.id); // notification-id-123
```
- Defined in modules/Resources/Notifications.ts:145

list

list(queryObj?: NotificationQuery): Promise<NotificationInfo[]>
Retrieves all notifications from the application with optional filtering.
Parameters
- OptionalqueryObj: NotificationQuery
Returns Promise<NotificationInfo[]>
See
https://help.tago.io/portal/en/kb/articles/11-notification Notification
Example
If receive an error "Authorization Denied", check policy Profile / Access notification in Access Management.
```
const result = await Resources.notifications.list({ read: false, amount: 10 });
console.log(result); // [ { id: 'notification-id-123', title: 'System Update', message: 'Features', ... } ]
```
- Defined in modules/Resources/Notifications.ts:19

markAllAsRead

markAllAsRead(): Promise<string>
Marks all notifications in the application as read.

Returns Promise<string>
See
https://help.tago.io/portal/en/kb/articles/11-notification Notification
Example
If receive an error "Authorization Denied", check policy Profile / Edit notification in Access Management.
```
const result = await Resources.notifications.markAllAsRead();
console.log(result); // All TagoIO Notification Run Successfully Updated
```
- Defined in modules/Resources/Notifications.ts:103

markAsRead

markAsRead(notificationIDS: string | string[]): Promise<string>
Marks one or multiple notifications as read.
Parameters
- notificationIDS: string | string[]
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/articles/11-notification Notification
Example
If receive an error "Authorization Denied", check policy Profile / Edit notification in Access Management.
```
// Mark single notification
await Resources.notifications.markAsRead("notification-id-123");

// Mark multiple notifications
await Resources.notifications.markAsRead(["id-1", "id-2"]);
```
- Defined in modules/Resources/Notifications.ts:46

markAsUnread

markAsUnread(notificationIDS: string | string[]): Promise<string>
Marks one or multiple notifications as unread.
Parameters
- notificationIDS: string | string[]
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/articles/11-notification Notification
Example
If receive an error "Authorization Denied", check policy Profile / Edit notification in Access Management.
```
// Mark single notification
await Resources.notifications.markAsUnread("notification-id-123");

// Mark multiple notifications
await Resources.notifications.markAsUnread(["id-1", "id-2"]);
```
- Defined in modules/Resources/Notifications.ts:76

notificationButton

notificationButton(notificationID: string, buttonID: string): Promise<string>
Records when a notification button is pressed by the user.
Parameters
- notificationID: string
- buttonID: string
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/articles/11-notification Notification
Example
If receive an error "Authorization Denied", check policy Profile / Edit notification in Access Management.
```
const result = await Resources.notifications.notificationButton("notification-123", "button-456");
console.log(result);
```
- Defined in modules/Resources/Notifications.ts:124

registerDevice

registerDevice(
deviceToken: string,
platform: "android" | "ios",
): Promise<string>
Registers a mobile device for push notifications.
Parameters
- deviceToken: string
- platform: "android" | "ios"
Returns Promise<string>
Remarks
This is used internally for mobile applications
- Defined in modules/Resources/Notifications.ts:180

remove

remove(notificationID: string): Promise<string>
Permanently deletes a notification from the system.
Parameters
- notificationID: string
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/articles/11-notification Notification
Example
If receive an error "Authorization Denied", check policy Profile / Delete notification in Access Management.
```
const result = await Resources.notifications.remove("notification-123");
console.log(result); // Successfully Removed
```
- Defined in modules/Resources/Notifications.ts:167

unRegisterDevice

unRegisterDevice(deviceToken: string): Promise<string>
Removes a mobile device from push notification service.
Parameters
- deviceToken: string
Returns Promise<string>
Remarks
This is used internally for mobile applications
- Defined in modules/Resources/Notifications.ts:197

Class Notifications

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Notifications

Methods

create

Parameters

Returns Promise<{ id: string }>

See

Example

list

Parameters

Returns Promise<NotificationInfo[]>

See

Example

markAllAsRead

Returns Promise<string>

See

Example

markAsRead

Parameters

Returns Promise<string>

See

Example

markAsUnread

Parameters

Returns Promise<string>

See

Example

notificationButton

Parameters

Returns Promise<string>

See

Example

registerDevice

Parameters

Returns Promise<string>

Remarks

remove

Parameters

Returns Promise<string>

See

Example

unRegisterDevice

Parameters

Returns Promise<string>

Remarks

Settings

On This Page