GrooveEvents.Read 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 Read operation reads events for the subscriptions created with the specified CallbackURI. The SharePoint Workspace client queues events as they are emitted from the underlying tools and objects. The Read operation returns an array containing all the events that have been emitted since the previous Read operation and removes the events from the event queue.
HTTP Post URL
The HTTP Post URL targets the service. This is a top-level HTTP Post URL that you supply directly; it is not returned as a value by another operation.
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
<CallbackURI/>
Element |
Data type |
Description |
|---|---|---|
CallbackURI |
xs:anyURI |
Identifies the subscription by the CallbackURI specified in the GrooveSubscriptions.Create or GrooveSubscriptions.CreateAggregated2 operation. The CallbackURI must start with "dpp://localhost". |
Output Message Header
GrooveResponseHeader specifies the Response key.
Return Value
<ReadResult>
<!-- Array of --> <Event />
</ReadResult>
Element |
Data type |
Description |
|---|---|---|
ReadResult |
Array of Event |
Events on the queue. The ReadResult array can contain zero or more Event objects. |
Remarks
Because events are removed from the queue as they are read, they cannot be reread. This can be a problem in the rare case of a delivery failure. So, if very reliable delivery is required in your application, use the GrooveEvents.ReadExtended operation, which has a non-destructive read option.
Note
If you are calling the Read operation in a Microsoft Visual Studio® 2008 project and get a SOAP exception when there are one or more events, check that you have included the GrooveEventData.vb or GrooveEventData.cs file in your project. See Creating Groove Web Services Projects in Visual Studio 2008 for instructions on how to add this file to your project.
See Also
Reference
GrooveSubscriptions Web Service