ChatRoomSession.BeginGetRecentChatHistory Method

Reference

Definition

Namespace:: Microsoft.Rtc.Collaboration.PersistentChat

Assembly:: Microsoft.Rtc.Collaboration.PersistentChat.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 IAsyncResult ^ BeginGetRecentChatHistory(int number, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginGetRecentChatHistory (int number, AsyncCallback userCallback, object state);

member this.BeginGetRecentChatHistory : int * AsyncCallback * obj -> IAsyncResult

Public Function BeginGetRecentChatHistory (number As Integer, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

number: Int32

The number of messages requested.

userCallback: AsyncCallback

The callback method to be invoked when this asynchronous operation completes.

state: Object

An object to be passed back to the callback.

Returns

IAsyncResult

An IAsyncResult object that references this operation.

Exceptions

ArgumentOutOfRangeException

number is less than 1.

ChatServerConnectionException

The PersistentChatEndpoint is not established.

ChatRoomSessionStateException

The State is not Established.

InvalidOperationException

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

RealTimeException

The PersistentChatEndpoint encountered an error communicating with the persistent chat server.

Remarks

This request will be processed asynchronously. Call EndGetRecentChatHistory(IAsyncResult) to complete this asynchronous operation.

Applies to