ChatRoomSession.BeginGetRecentChatHistory method

Lync 2013

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

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

'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)

Parameters

number
Type: System.Int32

The number of messages requested.

userCallback
Type: System.AsyncCallback

The callback 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 object that references this operation.

ExceptionCondition
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.

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

Show: