Skip to main content
Version: Current

notifications

  • ListNotificationsOptions​

    Defines an interface that represents the options for a list action.

    Members​

    • endpoint? string​

      The HTTP endpoint that the request should interface with.

    • sort? ("ascending" | "descending")​

      The order that items should be sorted in.

      • "ascending" means that the items should be sorted in alphebatically ascending order by address.
      • "descending" means that the items should be sorted in alphebatically descending order by address.

  • NotificationRecord​

    Defines a record that represents a notification. That is, a way for users to be notified of something.

    Members​

    • address string​

      The address of the record.

    • description string​

      The description of the notification.

    • markers string[]​

      The markers that are associated with the record.

  • SendNotificationOptions​

    Defines an interface that represents the options for sending a notification.

    Members​

    • endpoint? string​

      The HTTP endpoint that the request should interface with.

    • topic? string​

      The topic that the notification is for. Topics can be used to replace existing notifications with a new notification.