Hierarchy

Constructors

Methods

  • Parameters

    Returns Promise<{
        id: string;
    }>

    Description

    Creates a new notification in the system.

    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
  • Returns Promise<string>

    Description

    Marks all notifications in the application as read.

    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
  • Parameters

    • notificationIDS: string | string[]

    Returns Promise<string>

    Description

    Marks one or multiple notifications as read.

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

    • notificationIDS: string | string[]

    Returns Promise<string>

    Description

    Marks one or multiple notifications as unread.

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

    • notificationID: string
    • buttonID: string

    Returns Promise<string>

    Description

    Records when a notification button is pressed by the user.

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

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

    Returns Promise<string>

    Description

    Registers a mobile device for push notifications.

    Note

    This is used internally for mobile applications

  • Parameters

    • notificationID: string

    Returns Promise<string>

    Description

    Permanently deletes a notification from the system.

    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
  • Parameters

    • deviceToken: string

    Returns Promise<string>

    Description

    Removes a mobile device from push notification service.

    Note

    This is used internally for mobile applications