PersistentChatServices.BeginQueryChatHistory method (ICollection<Uri>, ChatHistoryQueryOptions, AsyncCallback, Object)

Lync 2013

Query the chat history for the specified collection of chat rooms, using the designated ChatHistoryQueryOptions.

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

'Declaration
Public Function BeginQueryChatHistory ( _
	chatRooms As ICollection(Of Uri), _
	query As ChatHistoryQueryOptions, _
	userCallback As AsyncCallback, _
	state As Object _
) As IAsyncResult
'Usage
Dim instance As PersistentChatServices
Dim chatRooms As ICollection(Of Uri)
Dim query As ChatHistoryQueryOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

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

Parameters

chatRooms
Type: System.Collections.Generic.ICollection<Uri>

The chat rooms to query.

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

The query.

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.

ExceptionCondition
ArgumentNullException

query is null.

ArgumentException

chatRooms collection is null or empty.

ChatServerConnectionException

The PersistentChatEndpoint 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 chat server.

This request will be processed asynchronously. See EndQueryChatHistory(IAsyncResult) to complete this asynchronous operation.

Show:
© 2015 Microsoft