Removes the specified collection of users or user groups from the role on 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 
BeginRemoveUsersOrGroupsFromRole (
_
	
role 
As 

ChatRoomRole, _
	
chatRoomUri 
As 
Uri, _
	
principals 
As 
ICollection(
Of 

GroupChatPrincipalSummary), _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
Visual Basic (Usage) 
Dim 
instance 
As 

ChatRoomManagementServices
Dim 
role 
As 
ChatRoomRole
Dim 
chatRoomUri 
As 
Uri
Dim 
principals 
As 
ICollection(
Of 

GroupChatPrincipalSummary)
Dim 
userCallback 
As 
AsyncCallback
Dim 
state 
As 
Object
Dim 
returnValue 
As 
IAsyncResult

returnValue = instance.
BeginRemoveUsersOrGroupsFromRole(
role, _
	
chatRoomUri, 
principals, 
userCallback, _
	
state)
C# 
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 < (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.

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 EndRemoveUsersOrGroupsFromRole(IAsyncResult) to complete this asynchronous operation.

See Also