ChatRoomSession.BeginQueryChatHistory method (String, Boolean, Boolean, AsyncCallback, Object)

Query the chat history of this chat room.

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

public IAsyncResult BeginQueryChatHistory(
	string searchString,
	bool exactPhrase,
	bool caseSensitive,
	AsyncCallback userCallback,
	Object state
)

Parameters

searchString
Type: System.String

The search string.

exactPhrase
Type: System.Boolean

if this is 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 this is set to true, treat the search as case sensitive.

userCallback
Type: System.AsyncCallback

The callback 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 object that references this operation.

ExceptionCondition
ArgumentNullException

searchString is null.

ChatServerConnectionException

The PersistentChatEndpoint is not established.

ChatRoomSessionStateException

The State 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 persistent chat server.

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

Show:
© 2014 Microsoft