ChatRoomSession.BeginQueryChatHistory method (ChatHistoryQueryOptions, AsyncCallback, Object)

Lync 2013

Queries the chat history of this chat room.

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

'Declaration
Public Function BeginQueryChatHistory ( _
	query As ChatHistoryQueryOptions, _
	userCallback As AsyncCallback, _
	state As Object _
) As IAsyncResult
'Usage
Dim instance As ChatRoomSession
Dim query As ChatHistoryQueryOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginQueryChatHistory(query, _
	userCallback, state)

Parameters

query
Type: Microsoft.Rtc.Collaboration.PersistentChat.ChatHistoryQueryOptions

The query.

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
ArgumentNullException

query is null.

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 EndQueryChatHistory(IAsyncResult) to complete this asynchronous operation.

Show: