Initiates a transfer request to the remote participant.

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

Syntax

Visual Basic (Declaration) 
Public 
Function 
BeginTransfer ( _
	
targetUri 
As 
String, _
	
callTransferOptions 
As 

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

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

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

Parameters

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

Transfer the current call to the given transfer target in Attended or Unattended mode.

In Unattended type, the call is terminated as soon as the transfer request is accepted by the remote participant. In 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 else, the call is not affected. If the final notification does not arrive within MaximumTransferTime (default is 10 minutes), the transfer is automatically failed. If the transfer fails, the call is not terminated.

Exceptions

Exception Condition
ArgumentNullException Thrown when the target>value is null.
ArgumentException Thrown when the callTransferOptions>parameter is specified with unsupported headers or 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