Finds users or user groups who are eligible for the given role on the specified chat room. The searchString 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.

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

Syntax

Visual Basic (Declaration) 
Public 
Function 
BeginFindUsersOrGroupsForRole ( _
	
role 
As 

ChatRoomRole, _
	
chatRoomUri 
As 
Uri, _
	
searchString 
As 
String, _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
Visual Basic (Usage) 
Dim 
instance 
As 

ChatRoomManagementServices
Dim 
role 
As 
ChatRoomRole
Dim 
chatRoomUri 
As 
Uri
Dim 
searchString 
As 
String
Dim 
userCallback 
As 
AsyncCallback
Dim 
state 
As 
Object
Dim 
returnValue 
As 
IAsyncResult

returnValue = instance.
BeginFindUsersOrGroupsForRole(
role, _
	
chatRoomUri, 
searchString, 
userCallback, _
	
state)
C# 
public 
IAsyncResult 
BeginFindUsersOrGroupsForRole(
	
ChatRoomRole

role,
	
Uri 
chatRoomUri,
	
string 
searchString,
	
AsyncCallback 
userCallback,
	
Object 
state
)

Parameters

role
Type: Microsoft.Rtc.Collaboration.GroupChat . . :: . . 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.

Exceptions

Exception Condition
ArgumentException

Thrown when invalid arguments are passed.
[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 EndFindUsersOrGroupsForRole(IAsyncResult) to complete this asynchronous operation.

See Also