Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
SearchConversation Class
SearchConversation Methods
AddParticipantAddresses Method
ClearLocalAttachmentData Method
CreateMessage Method
GetSearchMessages Method
IsParticipantActive Method
Leave Method
MarkAllContentAsRead Method
RemoveMessage Method
RemoveParticipantAddresses Method
RetrieveMessages Method
RetrieveMessagesAfter Method
RetrieveMessagesBefore Method
SetLastAccessTime Method
SetSensitivity Method
SetSubject Method
SetType Method
Start Method

SearchConversation RetrieveMessages Method

Starts the retrieval of messages associated with this conversation. This initial retrieval represents the most recent messages in the conversation and is limited to a maximum number that is specified by the messaging server. This is not necessarily the entire historical message content of the conversation.

Namespace: Avaya.ClientServices
Assembly: AvayaClientServices (in AvayaClientServices.dll) Version: 592.1.30.0
Syntax
C#
Copy

    public override void RetrieveMessages(
    	MessageRetrievalWatcher watcher
    )

#### Parameters

watcher
  Type: Avaya.ClientServices
  MessageRetrievalWatcher
  A MessageRetrievalWatcher 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 begins the retrieval of the dynamically-updated collection of messages associated with this conversation. Normally the client application will only need to call this method once to install a watcher object to monitor the initial download of messages and then continue to watch for updates to the collection.

If older messages are required to be downloaded, the RetrieveMessagesBefore(UInt32, Message) and/or RetrieveMessagesAfter(UInt32, Message) methods can be used to retrieve additional message history. Note however that RetrieveMessages must be called first to install the MessageRetrievalWatcher object that will monitor the retrieval, since these other methods work on a shared collection managed internally by the Conversation object. The application should use the DataRetrievalCollectionChanged event on the supplied watcher object to build up and maintain a local collection of messages associated with this conversation.

When using these message retrieval methods, it is important to note that there can only be a single retrieval operation in progress at any given time. If there is a retrieval operation in progress when once of these three message retrieval methods are called, the currently running retrieval will be cancelled before starting the next operation.

If the client application calls this method additional times, no actual download of messages from the server occurs, but the watcher events that report progress will fire (i.e. "progress" and "done" events). However, no additions to the message 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 message object collection and will never receive any additional updates.

See Also

#### Reference

SearchConversation Class
Avaya.ClientServices Namespace
SearchConversation
RetrieveMessagesBefore(UInt32, Message)
SearchConversation
RetrieveMessagesAfter(UInt32, Message)

© 2017 Avaya LLC. All Rights Reserved.