Namespace:
Microsoft.Rtc.Collaboration.GroupChat.Management
Assembly: Microsoft.Rtc.Collaboration.GroupChat(in Microsoft.Rtc.Collaboration.GroupChat.dll)
Assembly: Microsoft.Rtc.Collaboration.GroupChat(in Microsoft.Rtc.Collaboration.GroupChat.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Function BeginRemoveUsersOrGroupsFromRole ( _ role As ChatRoomRole, _ categoryUri As Uri, _ principals As ICollection( Of GroupChatPrincipalSummary), _ userCallback As AsyncCallback, _ state As Object _ ) As IAsyncResult |
Visual Basic (Usage) |
---|
Dim instance As ChatRoomCategoryManagementServices Dim role As ChatRoomRole Dim categoryUri As Uri Dim principals As ICollection( Of GroupChatPrincipalSummary) Dim userCallback As AsyncCallback Dim state As Object Dim returnValue As IAsyncResult returnValue = instance. BeginRemoveUsersOrGroupsFromRole( role, _ categoryUri, principals, userCallback, _ state) |
C# |
---|
public IAsyncResult BeginRemoveUsersOrGroupsFromRole( ChatRoomRole role, Uri categoryUri, 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.
- categoryUri
- Type:
System
.
.
::
.
.
Uri
The category URI.
- principals
- Type:
System.Collections.Generic
.
.
::
.
.
ICollection
<
(Of
<
(
<'
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.
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 EndRemoveUsersOrGroupsFromRole(IAsyncResult) to complete this asynchronous operation.