Begins the operation of establishing the instant messaging call on existing Conversation.

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

Syntax

Visual Basic (Declaration) 
Public 
Function 
BeginEstablish ( _
	
toastMessage 
As 

ToastMessage, _
	
options 
As 

CallEstablishOptions, _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
C# 
public 
IAsyncResult 
BeginEstablish(
	

ToastMessage 
toastMessage,
	

CallEstablishOptions 
options,
	
AsyncCallback 
userCallback,
	
Object 
state
)
Visual C++ 
public:
IAsyncResult^ 
BeginEstablish(
	

ToastMessage^ 
toastMessage, 
	

CallEstablishOptions^ 
options, 
	
AsyncCallback^ 
userCallback, 
	
Object^ 
state
)
JavaScript 
function 
beginEstablish(
toastMessage, 
options, 
userCallback, 
state);

Parameters

toastMessage
Type: Microsoft.Rtc.Collaboration . . :: . ToastMessage
A short message which can be displayed to the recipient upon receipt. Can be null.
options
Type: Microsoft.Rtc.Collaboration . . :: . CallEstablishOptions
Optional parameters to establish the call.
userCallback
Type: AsyncCallback
The method to be called when the asynchronous operation is completed.
state
Type: Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Return Value

An IAsyncResult that references the asynchronous operation.

Remarks

ToastMessageis specified, this will be the message that is displayed on the client when the callee is notified of an incoming call.

Exceptions

Exception Condition
ArgumentException Thrown when the

destinationUriparameter is null, empty or invalid sip URI or tel URI

optionsparameter 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.

See Also