Call.BeginEstablish Method

Definition

Namespace:

Microsoft.Rtc.Collaboration

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

BeginEstablish(AsyncCallback, Object)	Establishes an outgoing call.
BeginEstablish(CallEstablishOptions, AsyncCallback, Object)	Establishes an outgoing call with given options.
BeginEstablish(String, CallEstablishOptions, AsyncCallback, Object)	Establishes an outgoing call.

BeginEstablish(AsyncCallback, Object)

Establishes an outgoing call.

public:
 IAsyncResult ^ BeginEstablish(AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginEstablish (AsyncCallback userCallback, object state);

member this.BeginEstablish : AsyncCallback * obj -> IAsyncResult

Public Function BeginEstablish (userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

InvalidOperationException

Thrown when the call is not in valid state to perform this operation or does not have valid media provider to bind to.

BeginEstablish(CallEstablishOptions, AsyncCallback, Object)

Establishes an outgoing call with given options.

public:
 IAsyncResult ^ BeginEstablish(Microsoft::Rtc::Collaboration::CallEstablishOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginEstablish (Microsoft.Rtc.Collaboration.CallEstablishOptions options, AsyncCallback userCallback, object state);

member this.BeginEstablish : Microsoft.Rtc.Collaboration.CallEstablishOptions * AsyncCallback * obj -> IAsyncResult

Public Function BeginEstablish (options As CallEstablishOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

options

CallEstablishOptions

Optional parameters to establish the call.

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

ArgumentException

Thrown when the options parameter contains invalid or restricted signaling headers. Also thrown when the call is used as a third party call controller with custom MIME parts or with early media support.

InvalidOperationException

Thrown when the call is not in valid state to perform this operation or does not have valid media provider to bind to.

BeginEstablish(String, CallEstablishOptions, AsyncCallback, Object)

Establishes an outgoing call.

public:
 IAsyncResult ^ BeginEstablish(System::String ^ destinationUri, Microsoft::Rtc::Collaboration::CallEstablishOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginEstablish (string destinationUri, Microsoft.Rtc.Collaboration.CallEstablishOptions options, AsyncCallback userCallback, object state);

member this.BeginEstablish : string * Microsoft.Rtc.Collaboration.CallEstablishOptions * AsyncCallback * obj -> IAsyncResult

Public Function BeginEstablish (destinationUri As String, options As CallEstablishOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

destinationUri

String

The destination URI for the call.

options

CallEstablishOptions

The optional parameters to be used when establishing the call.

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

ArgumentException

destinationUri parameter is null, empty or invalid sip URI or tel URI. options parameter contains invalid or restricted signaling headers.

The call is used as a third party call controller with custom MIME parts or with early media support.

InvalidOperationException

Thrown when the call is not in valid state to perform this operation or does not have valid media provider to bind to.