AudioVideoCall.BeginEstablish Method (CallOrbit, CallEstablishOptions, AsyncCallback, Object)
Initiates a call retrival request to the provisioned call park server using the given orbit information.
Namespace: Microsoft.Rtc.Collaboration.AudioVideo
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginEstablish ( _
orbit As CallOrbit, _
options As CallEstablishOptions, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As AudioVideoCall
Dim orbit As CallOrbit
Dim options As CallEstablishOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginEstablish(orbit, _
options, userCallback, state)
public IAsyncResult BeginEstablish(
CallOrbit orbit,
CallEstablishOptions options,
AsyncCallback userCallback,
Object state
)
Parameters
- orbit
Type: Microsoft.Rtc.Collaboration.CallOrbit
Orbit information to use retrieve parked call. This parameter value cannot be null.
- options
Type: Microsoft.Rtc.Collaboration.CallEstablishOptions
Call establish options to be used when retrieving call from the park server. This parameter value 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 |
|---|---|
| ArgumentNullException | orbit parameter is null. |
| ArgumentException | options parameter contains invalid or restricted signaling headers. |
| InvalidOperationException | Current call is not in a valid state to initiate an establish operation. |