ChatRoomManagementServices.BeginFindUsersOrGroupsForRole method

Finds users or user groups who are eligible for the given role on the specified chat room.

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

public IAsyncResult BeginFindUsersOrGroupsForRole(
	ChatRoomRole role,
	Uri chatRoomUri,
	string searchString,
	AsyncCallback userCallback,
	Object state
)

Parameters

role
Type: Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomRole

The role for which eligible users are being searched.

chatRoomUri
Type: System.Uri

The chat room URI.

searchString
Type: System.String

The search string by which eligible users will be filtered.

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
ArgumentException

searchString is null or empty, chatRoomUri is not a valid chat room URI.

ArgumentOutOfRangeException

role has value Creator

ArgumentNullException

chatRoomUri is null.

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.

The searchString parameter value matches against the Name of the user or user group. To be eligible for Member or Manager roles, a user or user group must be in scope on the category. To be eligible for Presenter, the principal must already be a member of the chat room. This request will be processed asynchronously. See EndFindUsersOrGroupsForRole(IAsyncResult) to complete this asynchronous operation.

Show:
© 2014 Microsoft