ChatRoomManagementServices.BeginRemoveUsersOrGroupsFromRole Method
Removes the specified collection of users or user groups from the role on the chat room.
Assembly: Microsoft.Rtc.Collaboration.GroupChat (in Microsoft.Rtc.Collaboration.GroupChat.dll)
public IAsyncResult BeginRemoveUsersOrGroupsFromRole(
ChatRoomRole role,
Uri chatRoomUri,
ICollection<GroupChatPrincipalSummary> principals,
AsyncCallback userCallback,
Object state
)
Parameters
- role
- Type: Microsoft.Rtc.Collaboration.GroupChat.ChatRoomRole
The role from which the users and user groups will be removed.
- chatRoomUri
- Type: System.Uri
The chat room URI.
- principals
- Type: System.Collections.Generic.ICollection<GroupChatPrincipalSummary>
A collection of users and user groups to remove from the specified role.
- 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.
| 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. |
This request will be processed asynchronously. See EndRemoveUsersOrGroupsFromRole(IAsyncResult) to complete this asynchronous operation.
