PersistentChatServices.BeginBrowseChatRoomsByFilterCriteria method

Lync 2013

Browse a list of chat rooms based on a set of filter criteria

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

public IAsyncResult BeginBrowseChatRoomsByFilterCriteria(
	string searchTerms,
	bool searchDesc,
	string member,
	string manager,
	Uri categoryUri,
	Nullable<Guid> addinGuid,
	bool disabled,
	Nullable<ChatRoomPrivacy> privacy,
	Nullable<ChatRoomBehavior> behavior,
	Nullable<bool> invitations,
	bool searchInvitiations,
	int maxResults,
	AsyncCallback userCallback,
	Object state
)

Parameters

searchTerms
Type: System.String

The terms to search in the name for

searchDesc
Type: System.Boolean

Bool deciding whether to search in the description as well as name

member
Type: System.String

Look for all rooms that have this principal as a member

manager
Type: System.String

Look for all rooms that have this principal as a manager

categoryUri
Type: System.Uri

Search for rooms under this category

addinGuid
Type: System.Nullable<Guid>

Search for rooms with this add-in

disabled
Type: System.Boolean

Search for rooms with this disabled setting

privacy
Type: System.Nullable<ChatRoomPrivacy>

Search for rooms with this privacy setting

behavior
Type: System.Nullable<ChatRoomBehavior>

Search for rooms with this behavior setting

invitations
Type: System.Nullable<Boolean>

Search for rooms with this invitations setting (null => inherit)

searchInvitiations
Type: System.Boolean

Determines if we search using the invitations settings

maxResults
Type: System.Int32

The max number of results returned

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

This request will be processed asynchronously. See EndBrowseChatRoomsByFilterCriteria(IAsyncResult) to complete this asynchronous operation. If a parameter is null, then we do not search under that paramter. The only exceptions are searchDesc, which is false to not search description, and invitations, which uses the searchInvitations parameter to determine when to search invitations

Show: