Interface MailboxReceiver

All Superinterfaces:
OsidReceiver

public interface MailboxReceiver extends OsidReceiver

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedChildOfMailboxes(Id notificationId, IdList mailboxIds)
    The callback for notifications of changes to children of mailbox hierarchy nodes.
    void
    changedMailboxes(Id notificationId, IdList mailboxIds)
    The callback for notification of updated mailboxes.
    void
    deletedMailboxes(Id notificationId, IdList mailboxIds)
    The callback for notification of deleted mailboxes.
    void
    newMailboxes(Id notificationId, IdList mailboxIds)
    The callback for notifications of new mailboxes.

    Methods inherited from interface OsidReceiver

    down, up
    Modifier and Type
    Method
    Description
    void
    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

    • newMailboxes

      void newMailboxes(Id notificationId, IdList mailboxIds)
      The callback for notifications of new mailboxes.
      Parameters:
      notificationId - the notification Id
      mailboxIds - the Ids of the new Mailboxes
      Compliance:
      mandatory - This method must be implemented.
    • changedMailboxes

      void changedMailboxes(Id notificationId, IdList mailboxIds)
      The callback for notification of updated mailboxes.
      Parameters:
      notificationId - the notification Id
      mailboxIds - the Ids of the updated Mailboxes
      Compliance:
      mandatory - This method must be implemented.
    • deletedMailboxes

      void deletedMailboxes(Id notificationId, IdList mailboxIds)
      The callback for notification of deleted mailboxes.
      Parameters:
      notificationId - the notification Id
      mailboxIds - the Ids of the deleted Mailboxes
      Compliance:
      mandatory - This method must be implemented.
    • changedChildOfMailboxes

      void changedChildOfMailboxes(Id notificationId, IdList mailboxIds)
      The callback for notifications of changes to children of mailbox hierarchy nodes.
      Parameters:
      notificationId - the notification Id
      mailboxIds - the Ids of the Mailboxes whose children have changed
      Compliance:
      mandatory - This method must be implemented.