Interface | osid.messaging.MailboxReceiver | ||
---|---|---|---|
Implements | osid.OsidReceiver | ||
Description |
The mailbox receiver is the consumer supplied interface for
receiving notifications pertaining to new, updated or deleted
| ||
Method | newMailboxes | ||
Description |
The callback for notifications of new mailboxes. | ||
Parameters | osid.id.IdList | mailboxIds | the Ids of the new Mailboxes |
Compliance | mandatory | This method must be implemented. | |
Method | newAncestorMailbox | ||
Description |
The callback for notifications of new mailbox ancestors. | ||
Parameters | osid.id.Id | mailboxId | the Id of the Mailbox |
osid.id.Id | ancestorId | the Id of the new Mailbox ancestor | |
Compliance | mandatory | This method must be implemented. | |
Method | newDescendantMailbox | ||
Description |
The callback for notifications of new mailbox descendants. | ||
Parameters | osid.id.Id | mailboxId | the Id of the Mailbox |
osid.id.Id | descendantId | the Id of the new Mailbox descendant | |
Compliance | mandatory | This method must be implemented. | |
Method | changedMailboxes | ||
Description |
The callback for notification of updated mailboxes. | ||
Parameters | osid.id.IdList | mailboxIds | the Ids of the updated Mailboxes |
Compliance | mandatory | This method must be implemented. | |
Method | deletedMailboxes | ||
Description |
The callback for notification of deleted mailboxes. | ||
Parameters | osid.id.IdList | mailboxIds | the Ids of the deleted Mailboxes |
Compliance | mandatory | This method must be implemented. | |
Method | deletedAncestorMailbox | ||
Description |
The callback for notifications of deleted mailbox ancestors. | ||
Parameters | osid.id.Id | mailboxId | the Id of the Mailbox |
osid.id.Id | ancestorId | the Id of the removed Mailbox ancestor | |
Compliance | mandatory | This method must be implemented. | |
Method | deletedDescendantMailbox | ||
Description |
The callback for notifications of deleted mailbox descendants. | ||
Parameters | osid.id.Id | mailboxId | the Id of the Mailbox |
osid.id.Id | descendantId | the Id of the removed Mailbox descendant | |
Compliance | mandatory | This method must be implemented. | |
Method | restructuredMailboxHierarchy | ||
Description |
The callback for notifications of changes to a mailbox hierarchy where the hierarchy needs to refreshed. | ||
Compliance | mandatory | This method must be implemented. |