BeginQueryChatHistory Method (String, Boolean, Boolean, AsyncCallback, Object)

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Query the history of chat on this chat room.

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

Syntax

'Declaration
Public Function BeginQueryChatHistory ( _
    searchString As String, _
    exactPhrase As Boolean, _
    caseSensitive As Boolean, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As ChatRoomSession
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(searchString, _
    exactPhrase, caseSensitive, userCallback, _
    state)
public IAsyncResult BeginQueryChatHistory(
    string searchString,
    bool exactPhrase,
    bool caseSensitive,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • 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

Exception Condition
ArgumentException

Thrown when invalid arguments are passed.

[Microsoft.Rtc.Collaboration.GroupChat.ChatServerConnectionException]

Thrown when the GroupChatEndpoint is not established.

[Microsoft.Rtc.Collaboration.GroupChat.ChatRoomSessionStateException]

Thrown when the ChatRoomSession is not joined.

[System.InvalidOperationException]

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

[RealTimeException]

Thrown when the GroupChatEndpoint encounters an error communicating with the group chat server.

Remarks

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

See Also

Reference

ChatRoomSession Class

ChatRoomSession Members

BeginQueryChatHistory Overload

Microsoft.Rtc.Collaboration.GroupChat Namespace