TagoIO SDK for JavaScript and TypeScript
    Preparing search index...

    Class Notifications

    Hierarchy

    Index

    Constructors

    constructor

    Methods

    create list markAllAsRead markAsRead markAsUnread notificationButton registerDevice remove unRegisterDevice

    Constructors

    Methods

    • Returns Promise<string>

      Marks all notifications in the application as read.

      https://help.tago.io/portal/en/kb/articles/11-notification Notification

      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

    • Parameters

      • notificationIDS: string | string[]

      Returns Promise<string>

      Marks one or multiple notifications as read.

      https://help.tago.io/portal/en/kb/articles/11-notification Notification

      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"]);

    • Parameters

      • notificationIDS: string | string[]

      Returns Promise<string>

      Marks one or multiple notifications as unread.

      https://help.tago.io/portal/en/kb/articles/11-notification Notification

      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"]);

    • Parameters

      • notificationID: string
      • buttonID: string

      Returns Promise<string>

      Records when a notification button is pressed by the user.

      https://help.tago.io/portal/en/kb/articles/11-notification Notification

      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);

    • Parameters

      • deviceToken: string
      • platform: "android" | "ios"

      Returns Promise<string>

      Registers a mobile device for push notifications.

      This is used internally for mobile applications

    • Parameters

      • notificationID: string

      Returns Promise<string>

      Permanently deletes a notification from the system.

      https://help.tago.io/portal/en/kb/articles/11-notification Notification

      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

    • Parameters

      • deviceToken: string

      Returns Promise<string>

      Removes a mobile device from push notification service.

      This is used internally for mobile applications

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods