Share via


ChatRoomSession.BeginGetRecentChatHistory Method

Returns the requested number of recent chat messages for this chat room, up to the server limit.

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

Syntax

'Declaration
Public Function BeginGetRecentChatHistory ( _
    number As Integer, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As ChatRoomSession
Dim number As Integer
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginGetRecentChatHistory(number, _
    userCallback, state)
public IAsyncResult BeginGetRecentChatHistory(
    int number,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • number
    Type: System.Int32
    The number of messages requested.
  • 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 EndGetRecentChatHistory(IAsyncResult) to complete this asynchronous operation.

See Also

Reference

ChatRoomSession Class

ChatRoomSession Members

Microsoft.Rtc.Collaboration.GroupChat Namespace