GroupChatEndpoint.BeginEstablish Method

Establish a connection with the Group Chat server.

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

Syntax

'Declaration
Public Function BeginEstablish ( _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As GroupChatEndpoint
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginEstablish(userCallback, _
    state)
public IAsyncResult BeginEstablish(
    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
[Microsoft.Rtc.Collaboration.GroupChat.ChatServerConnectionException]

Thrown if the Lookup Server URI is invalid.

[RealTimeException]

Thrown if the session encounters an error communicating with Office Communications Server.

ArgumentException

Thrown when invalid arguments are passed.

[System.InvalidOperationException]

Thrown when the endpoint is not in a valid state. An endpoint can only be established once, and cannot be reused after being terminated.

Remarks

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

See Also

Reference

GroupChatEndpoint Class

GroupChatEndpoint Members

Microsoft.Rtc.Collaboration.GroupChat Namespace