TapiCallCompleteTransfer Method |
Completes the transfer of the call to the party connected in the consultation call.
Namespace: Traysoft.AddTapiAssembly: Traysoft.AddTapi (in Traysoft.AddTapi.dll) Version: 6.0.0.1110
Syntax public TapiCall CompleteTransfer(
TapiCall consultationCall,
bool as3WayConference
)
Public Function CompleteTransfer (
consultationCall As TapiCall,
as3WayConference As Boolean
) As TapiCall
public:
TapiCall^ CompleteTransfer(
TapiCall^ consultationCall,
bool as3WayConference
)
Parameters
- consultationCall
- Type: Traysoft.AddTapiTapiCall
TapiCall object that represents a connection with the destination of the transfer.
Usually this is a call object returned from SetupTransfer.
- as3WayConference
- Type: SystemBoolean
Specifies how the initiated transfer request is to be resolved. If true, the transfer
is resolved by establishing a three-way conference between the application, the party connected
to the initial call, and the party connected to the consultation call. A conference call is
created when this option is selected. If false, the transfer is resolved by
transferring the initial call to the consultation call. Both calls will become idle
to the application.
Return Value
Type:
TapiCallA newly created conference call if
as3WayConference parameter is
true,
null (
Nothing in Visual Basic) otherwise.
Exceptions Exception | Condition |
---|
TapiException | The transfer was not completed because a TAPI error occurred. |
Remarks
This operation completes the transfer of the original call, to the party currently connected
by consultationCall. The consultation call is typically dialed on the consultation
call returned from SetupTransfer, but it can be any call to which
the switch is capable of transferring the call.
The transfer request can be resolved either as a transfer or as a three-way conference call.
When resolved as a transfer, the parties connected by the call and consultationCall
are connected to each other, and both this call and consultationCall are typically
cleared from the application's line and transition to the idle state.
When resolved as a conference, all three parties enter into a conference call.
Both existing calls remain valid but transition to the Conferenced
state. A conference call is created and returned, and it transitions to
the Connected state.
The application can also transfer calls in a single step, without having to deal
with the intervening consultation call, by using Transfer(String).
See Also