GrooveMessages.ReadMessage Operation
Applies to: SharePoint Workspace 2010 | Visual Studio 2008
In this article
HTTP Post URL
Input Message Header
Input Message Parameters
Output Message Header
Return Value
The ReadMessage operation returns an individual message. The message is identified by the HTTP Post URL.
HTTP Post URL
The HTTP Post URL targets the message to be read. This URI can be obtained from the Read operation and other operations.
Input Message Header
GrooveRequestHeader specifies information common to all Groove Web Services, including the Groove Identity URL and the Groove Request key.
Input Message Parameters
<IncludeContent />
<IncludeAttachments />
<MarkMessagesOpened />
Element |
Data type |
Description |
|---|---|---|
IncludeContent |
xs:Boolean |
Include the content of the returned message. |
IncludeAttachments |
xs:Boolean |
Includes the attachments of the returned message. |
MarkMessagesOpened |
xs:Boolean |
If True, changes the category of New messages to Opened. This change is made immediately after the messages are read. Thus messages that were New at the time of the command are returned as New, not Opened. Generally this flag should only be set when the Read operation is used to present messages to the user. Messages with the Sent or Opened category are not affected. |
Output Message Header
GrooveResponseHeader specifies the Response key.
Return Value
<ReadMessageResult />
Element |
Data type |
Description |
|---|---|---|
ReadMessageResult |
The requested message. |
Remarks
The IncludeContent Boolean indicates whether to include the MessageContent in the returned message. The IncludeAttachment Boolean indicates whether the attachments should be retrieved. The body is always returned as plain text.
The retrieved messages can be marked as being opened by setting MarkMessageOpened to True.
Note
In the WSDL definition for this operation, the IncludeContent, IncludeAttachments, and MarkMessagesOpened parameters are defined as optional parameters. Because of a limitation in the way Groove Web Services handle optional parameters, you should always specify these optional parameters. If you do omit one parameter, you must also omit all parameters that follow the omitted one. In the .NET proxy code, you specify that optional parameters are included by setting the IncludeContentSpecified, IncludeAttachmentsSpecified, and MarkMessagesOpenedSpecified to true.