ChatRoomManagementServices.BeginAddUsersOrGroupsToRole method

Lync 2013

Adds the specified collection of users or user groups to the role on the chat room.

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

public IAsyncResult BeginAddUsersOrGroupsToRole(
	ChatRoomRole role,
	Uri chatRoomUri,
	ICollection<PersistentChatPrincipalSummary> principals,
	AsyncCallback userCallback,
	Object state
)

Parameters

role
Type: Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomRole

The role to which the users and user groups will be added.

chatRoomUri
Type: System.Uri

The chat room URI.

principals
Type: System.Collections.Generic.ICollection<PersistentChatPrincipalSummary>

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.

ExceptionCondition
ArgumentException

chatRoomUri is not a valid chat room URI.

ArgumentNullException

chatRoomUri or principals is null.

ArgumentOutOfRangeException

role has value Creator

ChatServerConnectionException

The PersistentChatEndpoint is not established.

InvalidOperationException

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

RealTimeException

The PersistentChatEndpoint encountered an error communicating with the chat server.

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). This request will be processed asynchronously. See EndAddUsersOrGroupsToRole(IAsyncResult) to complete this asynchronous operation.

Show: