This documentation is archived and is not being maintained.

BeginBrowseChatRoomsByCriteria Method

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Browse a list of chat rooms based on a specified search criteria. The search will be performed against the chat room names, and optionally the topics and descriptions.

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

public IAsyncResult BeginBrowseChatRoomsByCriteria(
	string criteria,
	bool searchDescription,
	AsyncCallback userCallback,
	Object state
)

Parameters

criteria
Type: System.String
The search criteria.
searchDescription
Type: System.Boolean
if set to true the search will also match against the topic and description of the chat rooms.
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
[Microsoft.Rtc.Collaboration.GroupChat.ChatServerConnectionException]

Thrown when the GroupChatEndpoint is not established.

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

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

Show: