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)

Syntax

Visual Basic (Declaration)
Public 
Function 
BeginBrowseChatRoomsByCriteria ( _
	
criteria 
As 
String, _
	
searchDescription 
As 
Boolean, _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
Visual Basic (Usage)
Dim 
instance 
As 

GroupChatServices
Dim 
criteria 
As 
String
Dim 
searchDescription 
As 
Boolean
Dim 
userCallback 
As 
AsyncCallback
Dim 
state 
As 
Object
Dim 
returnValue 
As 
IAsyncResult

returnValue = instance.
BeginBrowseChatRoomsByCriteria(
criteria, _
	
searchDescription, 
userCallback, _
	
state)
C#
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.

Exceptions

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

Remarks

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

See Also