etLine Methods - Call

etLine.Call.Answer

ActiveX: etLine.CallAnswer
Return: Boolean
Parameters: none
Edition: Express, Standard, Professional, Enterprise
<Click here for example>
This is the method used to answer a call after the etLine.OnOffering event fires. The telephony device must have that capability of using the TAPI lineAnswer function. Check the bit flag LINECALLFEATURE_ANSWER for the property etLine.Address.Capabilities.CallFeatures.

Note: The etLine.Call.Handle property must be set prior to using this method. If the telephony device only supports one call or you are using TeleTools Express or Standard then the etLine.Call.Handle property will be set automaticly.

Availability: This method is available when the bit flag LINECALLFEATURE_FORWARD is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: This is the lineAnswer function call.

etLine.Call.CalledID.LogProperties

Parameters: Title: String
ParentProp: String
Indent: String
This method dumps the current value of the control's Call.CalledID properties to its TeleScope.Log. This is very useful for debugging. Also see Common Methods <>.LogProperties.

etLine.Call.CallerID.LogProperties

Parameters: Title: String
ParentProp: String
Indent: String
This method dumps the current value of the control's Call.CallerID properties to its TeleScope.Log. This is very useful for debugging. Also see Common Methods <>.LogProperties.

etLine.Call.ConnectedID.LogProperties

Parameters: Title: String
ParentProp: String
Indent: String
This method dumps the current value of the control's Call.ConnectedID properties to its TeleScope.Log. This is very useful for debugging. Also see Common Methods <>.LogProperties.

etLine.Call.Dial

ActiveX: etLine.CallDial
Return: Boolean
Parameters: none
Edition: Express, Standard, Professional, Enterprise
<Click here for example>

This method dials a telephone number. The telephony device must have that capability of using the TAPI linemakeCall and lineDial functions. Check the bit flag LINECALLFEATURE_DIAL for the property etLine.Address.Capabilities.CallFeatures.

If the etLine.Device.UnformatPhoneNumber property is set to true then the following characters are removed before TAPI dials. This feature was add because some TSP can support these characters: " +()-."

Set the etLine.Call.Parameters properties prior to using this method.

To create a new call set the etLine.Call.Handle property to zero.

See the properties etLine.Call.Parameters for infomation about blocking CallerID.

Availability: This method is available when the bit flag LINEFEATURE_MAKECALL is set in the property etLine.Address.Capabilities.Features.

In TAPI terms: If a call does not exist then the lineMakeCall function is used otherwise the lineDial function is used.

etLine.Call.GatherDigits.LogProperties

Parameters: Title: String
ParentProp: String
Indent: String
This method dumps the current value of the control's Call.GatherDigits properties to its TeleScope.Log. This is very useful for debugging. Also see Common Methods <>.LogProperties.

etLine.Call.HandOff

ActiveX: etLine.CallHandOff
Return: Boolean
Parameters: Application: String
Edition: Professional, Enterprise

This allows the call to be handed off to another application. The target application must already be running and be in a state that will allow it to except the call. Once the call has been handed to another application, the etLine.Call.Owner property is set to False.

The TAPIFax sample program shows how to use this capability along with Microsoft Fax. MSFax also known as At Work Fax is available for Windows 95. Microsoft did not intend MSFax to be used with any other version of Windows.

In TAPI terms: The lineHandoff function is called.

The following example shows the call being handed off to another application when it is identified to be from a fax machine:

Visual Basic

Private Sub etLine1_OnCallMediaModeChange(ByVal CallHandle As Long)

If ((etLine1.CallMediaMode And LINEMEDIAMODE_G3FAX) <> 0) Then

etLine1.CallHandOff(TextApplication.Text)

End If

End Sub

Delphi

procedure TForm1.etLine1CallMediaModeChange(Sender: TObject; CallHandle: Integer);

begin

if (etLine1.Call.MediaMode and LINEMEDIAMODE_G3FAX) <> 0 then

etLine1.Call.HandOff(EditApplication.Text)

end;

etLine.Call.Hangup

ActiveX: etLine.CallHangup
Return: Boolean
Parameters: none
Edition: Express, Standard, Professional, Enterprise
<Click here for example>

This method hangs up the current call. The telephony device must have that capability of using the TAPI lineDrop function. Check the bit flag LINECALLFEATURE_DROP for the property etLine.Address.Capabilities.CallFeatures.

When using etPlay and/or etRecord along with etLine it is import to remember to stop playing and recording any wave files prior to hanging up a call or when the etLine.OnDisconnected event is fired. An example of this can be found in the DialAnswer sample program, see the CommandHangup_Click and etLine1_OnDisconnected subroutines.

Availability: This method is available when the bit flag LINECALLFEATURE_DROP is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: The lineDrop function is called.

etLine.Call.Hold

ActiveX: etLine.CallHold
Return: Boolean
Parameters: none
Edition: Standard, Professional, Enterprise
This function puts the call on hold. The telephony device must have that capability of using the TAPI lineHold function. Check the bit flag LINECALLFEATURE_HOLD for the property etLine.Address.Capabilities.CallFeatures.

Check the documentation for your telephony device for information on using the TAPI lineHold function when working with multiple calls.

Availability: This method is available when the bit flag LINECALLFEATURE_HOLD is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: The lineHold function is called.

etLine.Call.LogProperties

Parameters: Title: String
ParentProp: String
Indent: String
This method dumps the current value of the control's Call properties to its TeleScope.Log. This is very useful for debugging. Also see Common Methods <>.LogProperties.

etLine.Call.MonitorDigits.LogProperties

Parameters: Title: String
ParentProp: String
Indent: String
This method dumps the current value of the control's Call.MonitorDigits properties to its TeleScope.Log. This is very useful for debugging. Also see Common Methods <>.LogProperties.

etLine.Call.MonitorMediaModes.LogProperties

Parameters: Title: String
ParentProp: String
Indent: String
This method dumps the current value of the control's Call.MonitorMediaModes properties to its TeleScope.Log. This is very useful for debugging. Also see Common Methods <>.LogProperties.

etLine.Call.MonitorSilence.LogProperties

Parameters: Title: String
ParentProp: String
Indent: String
This method dumps the current value of the control's Call.MonitorSilence properties to its TeleScope.Log. This is very useful for debugging. Also see Common Methods <>.LogProperties.

etLine.Call.Parameters.LogProperties

Parameters: Title: String
ParentProp: String
Indent: String
This method dumps the current value of the control's Call.Parameters properties to its TeleScope.Log. This is very useful for debugging. Also see Common Methods <>.LogProperties.

etLine.Call.Park

ActiveX: etLine.CallSendDigits
Return: Boolean
Parameters: Digits: PhoneNumber
Edition: Professional, Enterprise

This method parks the specified call to the given PhoneNumber. The telephony device must have that capability of using the TAPI linePark function. Check the bit flag LINECALLFEATURE_PARK for the property etLine.Address.Capabilities.CallFeatures.

Availability: This method is available when the bit flag LINECALLFEATURE_PARK is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: The linePark function is called with LINEPARKMODE_DIRECTED.

etLine.Call.Pickup

ActiveX: etLine.CallPickup
Return: Boolean
Parameters: PhoneNumber: String
GroupID: String
Edition: Professional, Enterprise

This method picks up a call alerting at the PhoneNumber parameter. If the PhoneNumber is blank, a group pickup is performed. If required by the device, GroupID specifies the group identifier to which the alerting station belongs.

Example: Normally etLine will not execute any events prior to calling this method. In most cases you would hear the phone ringing somewhere else in the office and execute this method. Upon it's success a new call will be created and the etLine.OnConnected event will fire.

if not etLine1.Call.Pickup('','') then

DisplayError(etLine1.Error.Text);

Note: Some telephony devices must be configured to send the correct DTMF tones to utilize this feature. See the etLine.Device.Configure method for more information.

Availability: This method is available when the bit flag LINEADDRFEATURE_PICKUP is set in the property etLine.Address.Capabilities.Features.

In TAPI terms: The linePickup function is called.

etLine.Call.Redirect

ActiveX: etLine.CallRedirect
Return: Boolean
Parameters: PhoneNumber: String
Edition: Professional, Enterprise

This method redirects the specified offering call to the specified PhoneNumber.

Availability: This method is available when the bit flag LINECALLFEATURE_REDIRECT is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: The lineRedirect function is called.

etLine.Call.RedirectingID.LogProperties

Parameters: Title: String
ParentProp: String
Indent: String
This method dumps the current value of the control's Call.RedirectingID properties to its TeleScope.Log. This is very useful for debugging. Also see Common Methods <>.LogProperties.

etLine.Call.RedirectionID.LogProperties

Parameters: Title: String
ParentProp: String
Indent: String
This method dumps the current value of the control's Call.RedirectionID properties to its TeleScope.Log. This is very useful for debugging. Also see Common Methods <>.LogProperties.

etLine.Call.SendDigits

ActiveX: etLine.CallSendDigits
Return: Boolean
Parameters: Digits: String
Duration: Integer
Edition: Express, Standard, Professional, Enterprise
This method sends DTMF tones after the etLine.OnConnected event has been fired. The method will not create a call, see the method etLine.Call.Dial.

The telephony device must have the ability to use the TAPI lineGenerateDigits. Check the bit flag LINECALLFEATURE_GENERATEDIGITS for the property etLine.Address.Capabilities.CallFeatures.

The Digits parameter is a sting of the digits to be sent. Valid digits are "0" - "9", "A" - "D", "#" and "*". Some devices allow the flash "!" to be used with the method.

The Duration parameter is the number of milliseconds that each digit will transmitted. If this value is 0 then the device's default will be used.

Availability: This method is available when the bit flag LINECALLFEATURE_GENERATEDIGITS is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: The lineGenerateDigits function is called with the LINEDIGITMODE_DTMF parameter.

etLine.Call.SendPulseDigits

ActiveX: etLine.CallSendPulseDigits
Return: Boolean
Parameters: Digits: String
Duration: Integer
Edition: Express, Standard, Professional, Enterprise
This method sends pulse digits after the etLine.OnConnected event has been fired. The method will not create a call, see the method etLine.Call.Dial.

The telephony device must have the ability to use the TAPI lineGenerateDigits. Check the bit flag LINECALLFEATURE_GENERATEDIGITS for the property etLine.Address.Capabilities.CallFeatures.

The Digits parameter is a sting of the digits to be sent. Valid digits are "0" - "9". Some devices allow the flash "!" to be used with the method.

The Duration parameter is the number of milliseconds that each digit will transmitted. If this value is 0 then the device's default will be used.

Availability: This method is available when the bit flag LINECALLFEATURE_GENERATEDIGITS is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: The lineGenerateDigits function is called with the LINEDIGITMODE_PULSE parameter.

etLine.Call.SendTone

ActiveX: etLine.CallSendTone
Return: Boolean
Parameters: Tone: Integer
Duration: Integer
Edition: Standard, Professional, Enterprise
This method sends a non-DTMF tone after the OnConnected event has fired. The telephony device must have the ability to use the TAPI lineGenerateTone. Check the bit flag LINECALLFEATURE_GENERATETONE for the property etLine.Address.Capabilities.CallFeatures.

The device must have the ability to send the tone identified in the Tone parameter, check the bit flags LINETONEMODE_xxx for the property etLine.Device.Capabilities.Tones.

The Duration parameter indicates the length of time in milliseconds that the tone is to be played.

If a tone is currently playing and a subsequent tone is sent, then the first tone is stopped. Use the tone LINETONEMODE_NONE to stop playing a tone without starting a new tone.

See the property Device.Tone for a list of available tone.

Availability: This method is available when the bit flag LINECALLFEATURE_GENERATETONE is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: The lineGenerateTone function is called.

etLine.Call.Transfer

ActiveX: etLine.CallTransfer
Return: Boolean
Parameters: none
Edition: Standard, Professional, Enterprise
This method blind-transfers a call. The telephony device must have the ability to use the TAPI lineBlindTransfer function.

The telephone line must be capable of transferring a call, for example a PBX, Centrex or in some cases "Call Waiting/Three Way Calling" services from a local phone company can support this.

Prior to calling this method the number to be transferred to must be put in the etLine.Call.PhoneNumber property.

In many cases the telephony device must be configured to perform this operation properly. See the "Configuring Your Telephony Device" topic in the "Getting Started" section.

Modems do not have this capability although in many cases the flash commands can be used to perform a transfer, see the etLine.Call.SendDigits method.

Availability: This method is available when the bit flag LINECALLFEATURE_BLINDTRANSFER is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: The lineBlindTransfer function is called.

etLine.Call.Unhold

ActiveX: etLine.CallUnhold
Return: Boolean
Parameters: none
Edition: Standard, Professional, Enterprise
This method removes a call from on-hold. The telephony device must have that capability of using the TAPI lineUnhold function. Check the bit flag LINECALLFEATURE_UNHOLD for the property etLine.Address.Capabilities.CallFeatures.

Check the documentation for your telephony device for information on using the TAPI lineUnhold function when working with multiple calls.

Availability: This method is available when the bit flag LINECALLFEATURE_HOLD is set in the property etLine.Address.Capabilities.CallFeatures.

In TAPI terms: The lineUnhold function is called.

etLine.Call.Unpark

ActiveX: etLine.CallUnpark
Return: Boolean
Parameters: PhoneNumber: String
Edition: Professional, Enterprise

This method retrieves the call parked at the specified phone number.
The telephony device must have that capability of using the TAPI lineUnpark function.

Check the documentation for your telephony device for information on using the TAPI lineUnpark function when working with multiple calls.

Availability: Some devices that support etLine.Call.Park also support etLine.Unpark.

In TAPI terms: The lineUnpark function is called.