ChatRoomCategoryManagementServices.BeginFindUsersOrGroupsForScope Method
Finds users or user groups who are eligible for the given role on the specified category. To be eligible Member or Manager roles, a user or user group must be in scope on the category. The searchString matches against the Name of the user or user group.
Namespace: Microsoft.Rtc.Collaboration.GroupChat.Management
Assembly: Microsoft.Rtc.Collaboration.GroupChat (in Microsoft.Rtc.Collaboration.GroupChat.dll)
Syntax
'Declaration
Public Function BeginFindUsersOrGroupsForScope ( _
categoryUri As Uri, _
searchString As String, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As ChatRoomCategoryManagementServices
Dim categoryUri As Uri
Dim searchString As String
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginFindUsersOrGroupsForScope(categoryUri, _
searchString, userCallback, state)
public IAsyncResult BeginFindUsersOrGroupsForScope(
Uri categoryUri,
string searchString,
AsyncCallback userCallback,
Object state
)
Parameters
- categoryUri
Type: System.Uri
The category 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 EndFindUsersOrGroupsForScope(IAsyncResult) to complete this asynchronous operation.
See Also
Reference
ChatRoomCategoryManagementServices Class