Interface MessageReceiver

All Superinterfaces:
OsidReceiver
public interface MessageReceiver extends OsidReceiver

The message receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Message objects.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedMessages(Id notificationId, IdList messageIds)
    The callback for notification of updated messages.
    void
    deletedMessages(Id notificationId, IdList messageIds)
    the callback for notification of deleted messages.
    void
    newMessages(Id notificationId, IdList messageIds)
    The callback for notifications of new messages.

    Methods inherited from interface OsidReceiver

    down, up
    Modifier and Type
    Method
    Description
    void
    down()
    The callback for notifications that the notification bus is not operating.
    void
    up()
    The callback for notifications that the notification bus is operational.

  • Method Details

    • newMessages

      void newMessages(Id notificationId, IdList messageIds)
      The callback for notifications of new messages.
      Parameters:
      notificationId - the notification Id
      messageIds - the Ids of the new Messages
      Compliance:
      mandatory - This method must be implemented.

    • changedMessages

      void changedMessages(Id notificationId, IdList messageIds)
      The callback for notification of updated messages.
      Parameters:
      notificationId - the notification Id
      messageIds - the Ids of the updated Messages
      Compliance:
      mandatory - This method must be implemented.

    • deletedMessages

      void deletedMessages(Id notificationId, IdList messageIds)
      the callback for notification of deleted messages.
      Parameters:
      notificationId - the notification Id
      messageIds - the Ids of the deleted Messages
      Compliance:
      mandatory - This method must be implemented.