LocalEndpoint.BeginEstablish Method (IEnumerable<SignalingHeader>, AsyncCallback, Object)
Establishes the endpoint so that it can receive incoming calls and conference invitations.
Namespace: Microsoft.Rtc.Collaboration
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginEstablish ( _
additionalHeaders As IEnumerable(Of SignalingHeader), _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As LocalEndpoint
Dim additionalHeaders As IEnumerable(Of SignalingHeader)
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginEstablish(additionalHeaders, _
userCallback, state)
public IAsyncResult BeginEstablish(
IEnumerable<SignalingHeader> additionalHeaders,
AsyncCallback userCallback,
Object state
)
Parameters
- additionalHeaders
Type: System.Collections.Generic.IEnumerable<SignalingHeader>
Collection of signaling headers to be included with Register request. Can be null.
- userCallback
Type: System.AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
Type: System.Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Return Value
Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | Thrown when the state of the platform or endpoint is not right for this operation |
| ArgumentException | Thrown when one of the additional headers is a restricted header. |
Remarks
Registration, querying for in-band provisioning data, getting Media Relay Tokens, and automatic presence publication and subscription are some of the operations performed during endpoint establishment. For ApplicationEndpoints all the operations are optional while for UserEndpoints the last two operations are optional.