Request that the MCU initiate a call to the supplied destination URI.

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

Syntax

Visual Basic (Declaration) 
Protected 
Function 
BeginDialOut ( _
	
destinationUri 
As 
String, _
	
mcuDialOutOptions 
As 

McuDialOutOptions, _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
C# 
protected 
IAsyncResult 
BeginDialOut(
	
string 
destinationUri,
	

McuDialOutOptions 
mcuDialOutOptions,
	
AsyncCallback 
userCallback,
	
Object 
state
)
Visual C++ 
protected:
IAsyncResult^ 
BeginDialOut(
	
String^ 
destinationUri, 
	

McuDialOutOptions^ 
mcuDialOutOptions, 
	
AsyncCallback^ 
userCallback, 
	
Object^ 
state
)
JavaScript 
function 
beginDialOut(
destinationUri, 
mcuDialOutOptions, 
userCallback, 
state);

Parameters

destinationUri
Type: String
The URI of the entity to call.
mcuDialOutOptions
Type: Microsoft.Rtc.Collaboration . . :: . McuDialOutOptions
Optional parameters to customize the dial-out request.
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

The appearance of the dialed-out to endpoint in the conference roster can be customized by supplying a participant URI and display name in the mcuDialOutOptions object. The MCU may not honor the settings if the asserted identity of the dialed-out to endpoint was communicated to the MCU during the dial-out operation.

Exceptions

Exception Condition
InvalidOperationException Thrown when the parent ConferenceSession is not in a valid state or the conference does not support the corresponding MCU type.
ArgumentNullException Thrown when the supplied destinationUri is null.
ArgumentException Thrown when the supplied destinationUri is invalid.
Microsoft.Rtc.Signaling . . :: . RealTimeInvalidOperationException Thrown when the parent ConferenceSession is reconnecting (FailureReason will be set to InvalidOperationReason.RetryableOperation).

See Also