ChatRoomCategoryManagementServices.BeginAddUsersOrGroupsToRole Method
Adds the specified collection of users or user groups to the Member or Manager role on the given category. 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)
Syntax
'Declaration
Public Function BeginAddUsersOrGroupsToRole ( _
role As ChatRoomRole, _
categoryUri As Uri, _
principalsToAdd As ICollection(Of GroupChatPrincipalSummary), _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As ChatRoomCategoryManagementServices
Dim role As ChatRoomRole
Dim categoryUri As Uri
Dim principalsToAdd As ICollection(Of GroupChatPrincipalSummary)
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginAddUsersOrGroupsToRole(role, _
categoryUri, principalsToAdd, userCallback, _
state)
public IAsyncResult BeginAddUsersOrGroupsToRole(
ChatRoomRole role,
Uri categoryUri,
ICollection<GroupChatPrincipalSummary> principalsToAdd,
AsyncCallback userCallback,
Object state
)
Parameters
- role
Type: Microsoft.Rtc.Collaboration.GroupChat.ChatRoomRole
The role to which the users and user groups will be added.
- categoryUri
Type: System.Uri
The category URI.
- principalsToAdd
Type: System.Collections.Generic.ICollection<GroupChatPrincipalSummary>
A collection of users and user groups to add to 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 EndAddUsersOrGroupsToRole(IAsyncResult) to complete this asynchronous operation.
See Also
Reference
ChatRoomCategoryManagementServices Class