| Interface | osid.messaging.MessagingSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides a means to send messages. | ||
| Method | canSendMessages | ||
| Description |
Tests if this user can send messages. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known lookup methods in this
session will result in a | ||
| Return | boolean | false if sending messages is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | sendMessage | ||
| Description |
Sends a | ||
| Parameters | osid.id.Id | messageId | the Id of the Message |
osid.id.Id | recipientIdList | list of resource or agent recipients | |
| Errors | NOT_FOUND | messageId is not found | |
| NULL_ARGUMENT | messageId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getUnsentMessages | ||
| Description |
Gets all | ||
| Return | osid.messaging.MessageList | a list of unsent Messages | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |