Share via

ChatRoomManagementServices.BeginRegisterAddIn Method

  • Article

Registers a new add-in with the server, making it available for use in chat rooms.

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

Syntax

'Declaration
Public Function BeginRegisterAddIn ( _
    newAddIn As GroupChatAddInSettings, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As ChatRoomManagementServices
Dim newAddIn As GroupChatAddInSettings
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginRegisterAddIn(newAddIn, _
    userCallback, state)

public IAsyncResult BeginRegisterAddIn(
    GroupChatAddInSettings newAddIn,
    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 EndRegisterAddIn(IAsyncResult) to complete this asynchronous operation.

See Also

Reference

ChatRoomManagementServices Class

ChatRoomManagementServices Members

Microsoft.Rtc.Collaboration.GroupChat.Management Namespace