GroupChatServices.BeginQueryChatHistory Method (ICollection<Uri>, ChatHistoryQueryOptions, AsyncCallback, Object)
Query the chat history for the specified collection of chat rooms, using the designated EndQueryChatHistory(IAsyncResult).
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), _
query As ChatHistoryQueryOptions, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As GroupChatServices
Dim chatRooms As ICollection(Of Uri)
Dim query As ChatHistoryQueryOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginQueryChatHistory(chatRooms, _
query, userCallback, state)
public IAsyncResult BeginQueryChatHistory(
ICollection<Uri> chatRooms,
ChatHistoryQueryOptions query,
AsyncCallback userCallback,
Object state
)
Parameters
- chatRooms
Type: System.Collections.Generic.ICollection<Uri>
The chat rooms to query.
- query
Type: Microsoft.Rtc.Collaboration.GroupChat.ChatHistoryQueryOptions
The query.
- 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 |
|---|---|
| [System.ArgumentException] | Thrown when invalid arguments are passed. |
| [Microsoft.Rtc.Collaboration.GroupChat.ChatServerConnectionException] | Thrown when the GroupChatEndpoint is not established. |
| [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.