Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

PersistentChatServices.BeginBrowseChatRoomsByCriteria method (String, Boolean, Boolean, Boolean, AsyncCallback, Object)

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

Namespace:  Microsoft.Rtc.Collaboration.PersistentChat
Assembly:  Microsoft.Rtc.Collaboration.PersistentChat (in Microsoft.Rtc.Collaboration.PersistentChat.dll)
public IAsyncResult BeginBrowseChatRoomsByCriteria(
	string criteria,
	bool searchDescription,
	bool matchAll,
	bool matchExactPhrase,
	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 description of the chat rooms.

matchAll
Type: System.Boolean

if [matchExactPhrase] is false, the search will return only rooms that match all search strings if this is set to [true], otherwise it will return rooms that match one or more of the search strings.

matchExactPhrase
Type: System.Boolean

If [true], the search criteria will be treated as a single search string, otherwise it will be considered a whitespace delimited set of search strings.

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
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 persistent chat server.

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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.