MessagingServiceRetrieveActiveConversations Method |
Performs a retrieval of all active conversations for the currently logged in user and watches for changes to this collection.
Namespace:
Avaya.ClientServices
Assembly:
AvayaClientServices (in AvayaClientServices.dll) Version: 550.0.60.0
Syntaxpublic void RetrieveActiveConversations(
ConversationRetrievalWatcher watcher
)
Parameters
- watcher
- Type: Avaya.ClientServicesConversationRetrievalWatcher
A ConversationRetrievalWatcher object, created by the application, to track the progress of the requested
operation. Prior to calling this method, the application should have installed event handlers on the
watcher object for the events it is interested in. A value of null will remove any
currently installed watcher object, stopping all events from being sent to the previous watcher object.
Remarks
This method retrieves the dynamically-updated collection of conversations that are associated with the currently
logged in user.
Normally the client application will only need to call this method once to install a
watcher
object to monitor the initial download of conversations and then continue to watch for updates to the collection.
If the client application calls this method additional times, no actual download of conversations from the server
occurs, but the watcher events that report progress will fire (i.e. "progress" and "done" events).
However, no additions to the conversation collection will occur as a result of the subsequent calls.
If a different watcher object is supplied in a subsequent call, the previous watcher object is "unlinked" from
the underlying conversation object collection and will never receive any additional updates.
To determine when it is appropriate to call the RetrieveActiveConversations method, the client application
should query the RetrieveConversationCapability property.
See Also