public interface MessagingSession extends OsidSession
This session provides a means to send messages.
Modifier and Type | Method and Description |
---|---|
boolean |
canSendMessages()
Tests if this user can send messages.
|
MessageList |
getUnsentMessages()
Gets all
Messages not sent by the resource related to
the authenticated agent. |
void |
sendMessage(Id messageId,
Id recipientIdList)
Sends a
Message. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSendMessages()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer message operations to
unauthorized users. false
if sending messages is not authorized,
true
otherwisemandatory
- This method must be implemented. void sendMessage(Id messageId, Id recipientIdList) throws NotFoundException, OperationFailedException, PermissionDeniedException
Message.
messageId
- the Id
of the Message
recipientIdList
- list of resource or agent recipientsNotFoundException
- messageId
is not
foundNullArgumentException
- messageId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. MessageList getUnsentMessages() throws OperationFailedException, PermissionDeniedException
Messages
not sent by the resource related to
the authenticated agent. In plenary mode, the returned list contains
all known unrad messages or an error results. Otherwise, the returned
list may contain only those messages that are accessible through this
session. Messages
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.