GroupChatServices.BeginQueryChatHistory Method (ICollection<Uri>, String, Boolean, Boolean, AsyncCallback, Object)

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

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

Syntax

'Declaration
Public Function BeginQueryChatHistory ( _
    chatRooms As ICollection(Of Uri), _
    searchString As String, _
    exactPhrase As Boolean, _
    caseSensitive As Boolean, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As GroupChatServices
Dim chatRooms As ICollection(Of Uri)
Dim searchString As String
Dim exactPhrase As Boolean
Dim caseSensitive As Boolean
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginQueryChatHistory(chatRooms, _
    searchString, exactPhrase, caseSensitive, _
    userCallback, state)

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.

Exceptions

Remarks

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

See Also

Reference

GroupChatServices Class

GroupChatServices Members

BeginQueryChatHistory Overload

Microsoft.Rtc.Collaboration.GroupChat Namespace