This documentation is archived and is not being maintained.

BeginCreateFederatedUserGroup Method

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Create a new GroupChatFederatedUserGroup. The user invoking this method must have been granted IsUserAdministrator permission.

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

public IAsyncResult BeginCreateFederatedUserGroup(
	string name,
	AsyncCallback userCallback,
	Object state
)

Parameters

name
Type: System.String
The name of the new user group.
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

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.

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

Show: