OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.MessagingSession
Implementsosid.OsidSession
Description

This session provides a means to send messages.

MethodcanSendMessages
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer message operations to unauthorized users.

Returnboolean false if sending messages is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodsendMessage
Description

Sends a Message.

Parametersosid.id.IdmessageIdthe Id of the Message
osid.id.IdrecipientIdListlist of resource or agent recipients
ErrorsNOT_FOUND messageId is not found
NULL_ARGUMENT messageId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetUnsentMessages
Description

Gets all 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.

Returnosid.messaging.MessageLista list of unsent Messages
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.