GrooveMessages.ReadInvitations 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 ReadInvitations operation reads the invitations to Groove 2007-compatible workspaces for the account.
HTTP Post URL
The HTTP Post URL targets the service for the account. This URI is returned by the GrooveAccounts.Read2 operation in the Messages element.
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
<ReadInvitations>
<ApplicationURI />
<ReadAll />
</Read>
Element |
Data type |
Description |
|---|---|---|
ApplicationURI |
xs:anyURI |
Specifies that the ReadInvitations operation is to read invitations associated with the specified ApplicationURI. If the ApplicationURI is not specified or equals an empty string, the operation reads invitations not associated with an ApplicationURI. If the ApplicationURI has a value of "*", the operation reads invitations that are associated with any ApplicationURI and those that are not associated with an ApplicationURI. |
ReadAll |
xs:boolean |
If true, the operation reads all invitations. If false, the operation reads only new invitations. |
Output Message Header
GrooveResponseHeader specifies the Response key.
Return Value
<ReadInvitationsResult>
<!-- Array of --> <Invitation />
</ReadInvitationsResult>
Element |
Data type |
Description |
|---|---|---|
ReadInvitationsResult |
Array of Invitation |
Invitations and invitation responses returned. The ReadInvitationsResult array can contain zero or more Invitation elements. |
Remarks
The retrieved invitations are marked as being opened. This generates an internal message to the user who issued the invitation. If a message is read more than once by specifying a true value for the ReadAll parameter, SharePoint Workspace generates a message each time the invitation is read.
The returned Invitation type does not contain the message body. To read the message body, call GrooveMessages.ReadMessage using the Invitation.MessageURI element as the HTTP Post URL.
Note
User code should make no assumptions about the order of the returned invitations. The order is implementation-dependent and may change in future releases.
Note
This operation is available only on systems where Groove Web Services Version 2.1 is available. See Testing for Groove Web Services Version 2.1 for more information.
See Also
Reference
GrooveMessages.AcceptInvitation Operation
GrooveMessages.DeclineInvitation Operation
GrooveMessages.ReadMessage Operation