Initiates a transfer request to the remote participant to transfer the current call to the given transfer target in Attended or Unattended type.

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

Syntax

Visual Basic (Declaration) 
Protected 
Function 
BeginTransfer ( _
	
targetUri 
As 
String, _
	
options 
As 

CallTransferOptions, _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
C# 
protected 
IAsyncResult 
BeginTransfer(
	
string 
targetUri,
	

CallTransferOptions 
options,
	
AsyncCallback 
userCallback,
	
Object 
state
)
Visual C++ 
protected:
IAsyncResult^ 
BeginTransfer(
	
String^ 
targetUri, 
	

CallTransferOptions^ 
options, 
	
AsyncCallback^ 
userCallback, 
	
Object^ 
state
)
JavaScript 
function 
beginTransfer(
targetUri, 
options, 
userCallback, 
state);

Parameters

targetUri
Type: String
The transfer target URI.
options
Type: Microsoft.Rtc.Collaboration . . :: . CallTransferOptions
Call transfer options. This parameter value can be null
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

In the Unattended type, the call is terminated as soon as the transfer request is accepted by the remote participant. In the Attended type, the call montiors the success/failure notifications from the remote regarding how the transfer is being carried out. If the transfer succeeds, this call is terminated. Otherwise, the current call is not affected.

Exceptions

Exception Condition
ArgumentNullException Thrown when the target>value is null.
ArgumentException Thrown when the

optionsparameter contains invalid or restriced signaling headers.

optionsparameter is used to override transferor value by any endpoint other than an Application Endpoint.
InvalidOperationException Thrown when the current call is not in a valid state to initiate a transfer operation.

See Also