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

Delete an unwanted GroupChatFederatedUserGroup. The user invoking this method must have been granted IsUserAdministrator permission. The group cannot be deleted if there are any federated users belonging to the group. Each GroupChatFederatedUser must belong to exactly one GroupChatFederatedUserGroup. To change the user group for a federated user, see BeginMoveFederatedUser(GroupChatFederatedUser, GroupChatFederatedUserGroup, AsyncCallback, Object).

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

Syntax

'Declaration
Public Function BeginDeleteFederatedUserGroup ( _
    federatedUserGroup As GroupChatFederatedUserGroup, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As GroupChatUserAdministrationServices
Dim federatedUserGroup As GroupChatFederatedUserGroup
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginDeleteFederatedUserGroup(federatedUserGroup, _
    userCallback, state)
public IAsyncResult BeginDeleteFederatedUserGroup(
    GroupChatFederatedUserGroup federatedUserGroup,
    AsyncCallback userCallback,
    Object state
)

Parameters

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

See Also

Reference

GroupChatUserAdministrationServices Class

GroupChatUserAdministrationServices Members

Microsoft.Rtc.Collaboration.GroupChat.Management Namespace