EndGetRecentChatHistory Method
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.
Completes the asynchronous request initiated by BeginGetRecentChatHistory(Int32, AsyncCallback, Object).
Namespace: Microsoft.Rtc.Collaboration.GroupChat
Assembly: Microsoft.Rtc.Collaboration.GroupChat (in Microsoft.Rtc.Collaboration.GroupChat.dll)
Syntax
'Declaration
Public Function EndGetRecentChatHistory ( _
asyncResult As IAsyncResult _
) As ReadOnlyCollection(Of ChatMessage)
'Usage
Dim instance As ChatRoomSession
Dim asyncResult As IAsyncResult
Dim returnValue As ReadOnlyCollection(Of ChatMessage)
returnValue = instance.EndGetRecentChatHistory(asyncResult)
public ReadOnlyCollection<ChatMessage> EndGetRecentChatHistory(
IAsyncResult asyncResult
)
Parameters
- asyncResult
Type: System.IAsyncResult
The IAsyncResult that references this operation.
Return Value
Type: System.Collections.ObjectModel.ReadOnlyCollection<ChatMessage>
A collection of the most recent chat messages from the chat room to which this session is joined.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentException | Thrown when invalid arguments are passed. |
| [Microsoft.Rtc.Collaboration.GroupChat.CommandFailedException] | Thrown when the chat server encountered an error processing the request. |
| [RealTimeException] | Thrown when the GroupChatEndpoint encounters an error communicating with the group chat server. |
| [System.InvalidOperationException] | Thrown when invoked multiple times with the same asyncResult. |