Edit

Call.BeginTransfer Method

  • Reference

Definition

Namespace:
Microsoft.Rtc.Collaboration
Assembly:
Microsoft.Rtc.Collaboration.dll

Overloads

BeginTransfer(Call, CallTransferOptions, AsyncCallback, Object)

Initiates a transfer request to the remote participant of the current call to replace another existing call in Attended type.
BeginTransfer(String, CallTransferOptions, AsyncCallback, Object)

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

BeginTransfer(Call, CallTransferOptions, AsyncCallback, Object)

Initiates a transfer request to the remote participant of the current call to replace another existing call in Attended type.

protected:
 IAsyncResult ^ BeginTransfer(Microsoft::Rtc::Collaboration::Call ^ callToReplace, Microsoft::Rtc::Collaboration::CallTransferOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);
protected IAsyncResult BeginTransfer (Microsoft.Rtc.Collaboration.Call callToReplace, Microsoft.Rtc.Collaboration.CallTransferOptions options, AsyncCallback userCallback, object state);
member this.BeginTransfer : Microsoft.Rtc.Collaboration.Call * Microsoft.Rtc.Collaboration.CallTransferOptions * AsyncCallback * obj -> IAsyncResult
Protected Function BeginTransfer (callToReplace As Call, options As CallTransferOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

callToReplace
Call

The call to be replaced.

options
CallTransferOptions

Call transfer options. This parameter can be null.

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

ArgumentNullException

Thrown when the callToReplace value is null.

ArgumentException

options parameter contains invalid or restricted headers or contains null or unsupported MIME part headers. options parameter is used to override transferor value by any endpoint other than an ApplicationEndpointoptions parameter is of type Unattended.

InvalidOperationException

Thrown when the callToReplace is not in Established Current call is not in a valid state to initiate a transfer operation.

Remarks

This is a Supervised transfer since the operation involves another call and it waits for success/failure notifications from the remote regarding how the transfer is being carried out on the remote side. When the transfer is noted as successful by the existing remote participant, the current call is terminated. If it fails, the current call is not affected.

If callToReplace is passed as the instance of the call initiating the transfer, then this would be considered as the self-transfer.

Applies to

BeginTransfer(String, CallTransferOptions, AsyncCallback, Object)

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

protected:
 IAsyncResult ^ BeginTransfer(System::String ^ targetUri, Microsoft::Rtc::Collaboration::CallTransferOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);
protected IAsyncResult BeginTransfer (string targetUri, Microsoft.Rtc.Collaboration.CallTransferOptions options, AsyncCallback userCallback, object state);
member this.BeginTransfer : string * Microsoft.Rtc.Collaboration.CallTransferOptions * AsyncCallback * obj -> IAsyncResult
Protected Function BeginTransfer (targetUri As String, options As CallTransferOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

targetUri
String

The transfer target URI.

options
CallTransferOptions

Call transfer options. This parameter value can be null

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

ArgumentNullException

Thrown when the targetUri value is null.

ArgumentException

options parameter contains invalid or restricted signaling headers. options parameter is used to override transferor value by any endpoint other than an ApplicationEndpoint.

InvalidOperationException

Thrown when the current call is not in a valid state to initiate a transfer 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.

Applies to