PersistentChatServices.BeginQueryChatHistory method (ICollection<Uri>, String, Boolean, Boolean, AsyncCallback, Object)

Lync 2013

Query the chat history for the specified collection of chat rooms, using the designated search string and match options.

Namespace:  Microsoft.Rtc.Collaboration.PersistentChat
Assembly:  Microsoft.Rtc.Collaboration.PersistentChat (in Microsoft.Rtc.Collaboration.PersistentChat.dll)

public IAsyncResult BeginQueryChatHistory(
	ICollection<Uri> chatRooms,
	string searchString,
	bool exactPhrase,
	bool caseSensitive,
	AsyncCallback userCallback,
	Object state
)

Parameters

chatRooms
Type: System.Collections.Generic.ICollection<Uri>

The chat rooms to query.

searchString
Type: System.String

The search string.

exactPhrase
Type: System.Boolean

if set to [true] the search string is treated as an exact phrase; Otherwise, the search string is treated as a collection of words to match, and any single word match yields a message in the results.

caseSensitive
Type: System.Boolean

if set to [true] treat the search as case sensitive.

userCallback
Type: System.AsyncCallback

The method to be invoked when this asynchronous operation completes.

state
Type: System.Object

An object to be passed back to the callback.

Return value

Type: System.IAsyncResult
An IAsyncResult that references this operation.

ExceptionCondition
ArgumentException

chatRooms collection is null or empty.

ChatServerConnectionException

The PersistentChatEndpoint is not established.

InvalidOperationException

The chat server connection is not in a valid state to send the command.

RealTimeException

The PersistentChatEndpoint encountered an error communicating with the chat server.

This request will be processed asynchronously. See EndQueryChatHistory(IAsyncResult) to complete this asynchronous operation.

Show:
© 2015 Microsoft