ChatRoomManagementServices.BeginAddUsersOrGroupsToRole Method

Adds the specified collection of users or user groups to the role on the chat room. All principals must meet eligibility requirements to be added to a role. To find eligible principals for a role, use BeginFindUsersOrGroupsForRole(ChatRoomRole, Uri, String, AsyncCallback, Object).

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


Public Function BeginAddUsersOrGroupsToRole ( _
    role As ChatRoomRole, _
    chatRoomUri As Uri, _
    principals As ICollection(Of GroupChatPrincipalSummary), _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
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.BeginAddUsersOrGroupsToRole(role, _
    chatRoomUri, principals, userCallback, _
public IAsyncResult BeginAddUsersOrGroupsToRole(
    ChatRoomRole role,
    Uri chatRoomUri,
    ICollection<GroupChatPrincipalSummary> principals,
    AsyncCallback userCallback,
    Object state


  • 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.


Exception Condition

Thrown when invalid arguments are passed.


Thrown when the GroupChatEndpoint is not established.


Thrown when the chat server connection is not in a valid state to send the command.


Thrown when the GroupChatEndpoint encounters an error communicating with the group chat server.


This request will be processed asynchronously. See EndAddUsersOrGroupsToRole(IAsyncResult) to complete this asynchronous operation.

See Also


ChatRoomManagementServices Class

ChatRoomManagementServices Members

Microsoft.Rtc.Collaboration.GroupChat.Management Namespace