public interface MailboxNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Mailbox
objects. This session is intended for consumers
needing to synchronize their message with this service without the use of
polling. Notifications are cancelled when this session is closed.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForMailboxNotifications()
Tests if this user can register for
Mailbox
notifications. |
void |
registerForChangedMailbox(Id mailboxId)
Registers for notification of an updated mailbox.
|
void |
registerForChangedMailboxes()
Registers for notification of updated mailboxes.
|
void |
registerForDeletedMailbox(Id mailboxId)
Registers for notification of a deleted mailbox.
|
void |
registerForDeletedMailboxAncestors(Id mailboxId)
Registers for notification if an ancestor is removed from the
specified mailbox in the mailbox hierarchy.
|
void |
registerForDeletedMailboxDescendants(Id mailboxId)
Registers for notification if a descendant is removed from fthe
specified mailbox in the mailbox hierarchy.
|
void |
registerForDeletedMailboxes()
Registers for notification of deleted mailboxes.
|
void |
registerForNewMailboxAncestors(Id mailboxId)
Registers for notification if an ancestor is added to the specified
mailbox in the mailbox hierarchy.
|
void |
registerForNewMailboxDescendants(Id mailboxId)
Registers for notification if a descendant is added to the specified
mailbox in the mailbox hierarchy.
|
void |
registerForNewMailboxes()
Register for notifications of new mailboxes.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForMailboxNotifications()
Mailbox
notifications. A return of true does not guarantee successful
authorization. A return of false indicates that it is known all
methods in this session will result in a PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer notification operations. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void registerForNewMailboxes() throws OperationFailedException, PermissionDeniedException
MailboxReceiver.newMailboxes()
is invoked when a new
Mailbox
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewMailboxAncestors(Id mailboxId) throws OperationFailedException, PermissionDeniedException
MailboxReceiver.newMailboxAncestor()
is invoked when the
specified mailbox experiences an addition in ancestry.mailboxId
- the Id
of the mailbox to monitorNullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewMailboxDescendants(Id mailboxId) throws OperationFailedException, PermissionDeniedException
MailboxReceiver.newMailboxDescendant()
is invoked when the
specified mailbox experiences an addition in descendants.mailboxId
- the Id
of the mailbox to monitorNullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedMailboxes() throws OperationFailedException, PermissionDeniedException
MailboxReceiver.changedMailboxes()
is invoked when a mailbox
is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedMailbox(Id mailboxId) throws OperationFailedException, PermissionDeniedException
MailboxReceiver.changedMailboxes()
is invoked when the
specified mailbox is changed.mailboxId
- the Id
of the Mailbox to monitorNullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedMailboxes() throws OperationFailedException, PermissionDeniedException
MailboxReceiver.deletedMailboxes()
is invoked when a mailbox
is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedMailbox(Id mailboxId) throws OperationFailedException, PermissionDeniedException
MailboxReceiver.deletedMailboxes()
is invoked when the
specified mailbox is deleted.mailboxId
- the Id
of the Mailbox
to monitorNullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedMailboxAncestors(Id mailboxId) throws OperationFailedException, PermissionDeniedException
MailboxReceiver.deletedMailboxAncestor()
is invoked when the
specified mailbox experiences a removal of an ancestor.mailboxId
- the Id
of the mailbox to monitorNullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedMailboxDescendants(Id mailboxId) throws OperationFailedException, PermissionDeniedException
MailboxReceiver.deletedMailboxDescednant()
is invoked when the
specified mailbox experiences a removal of one of its descdendents.mailboxId
- the Id
of the mailbox to monitorNullArgumentException
- mailboxId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.