etLine.CallerID is supported by all editions of TeleTools. etLine.Call.CalledID requires TeleTools Professional or Enterprise. etLine.Call.ConnectedID, etLine.Call.RedirectionID and etLine.Call.RedirectingID requires TeleTools Enterprise.
All of the following sub-properties have the sub-sub-properties on this page:
|
Call.CalledID |
Identifies the original destination address of a call. |
|
Call.CallerID |
Identifies the originating address of a call. |
|
Call.ConnectedID |
Identifier for the party to which the call was actually connected. This may be different from the called party if the call was diverted. |
|
Call.RedirectingID |
Identifies the address that redirected the call. |
|
Call.RedirectionID |
Identifies the address to which the call was redirected. |
Each of these sub-properties has an additional set of sub-properties:
etLine.Call.<>.Blocked
etLine.Call.<>.EventFilter
etLine.Call.<>.Flags
etLine.Call.<>.FormatName
etLine.Call.<>.MaskNumber
etLine.Call.<>.Name
etLine.Call.<>.Number
etLine.Call.<>.OutOfArea
Each of these initial sub-properties has a realted etLine.Address property that indicates that possible information made available for the given telephony device:
etLine.Address.Capabilities.CalledIDFlags
etLine.Address.Capabilities.CallerIDFlags
etLine.Address.Capabilities.ConnectedIDFlags
etLine.Address.Capabilities.RedirectingIDFlags
etLine.Address.Capabilities.RedirectionIDFlags
Each of these initial sub-properties has a related event that indicates when the information in these
properties has changed. The events are as follow:
etLine.OnCalledID
etLine.OnCallerID
etLine.OnConnectedID
etLine.OnRedirectingID
etLine.OnRedirectionID
ActiveX: etLine.< >Blocked
Type: Boolean
When: Run-Time
Read/Write: Read Only
<Click
here for example>
This property indicates whether the information was blocked by the remote party. This information can also be ascertained from the etLine.Call.<>.Flags property. The information in the property is updated immediately before the related event is fired.
ActiveX: etLine.Call< >FilterEvent
Type: Boolean
When: Design-Time and Run-Time
Read/Write: Read and Write
The etLine.OnCallerID and related events will fire whenever the CallerID information changes. This
is very useful however it may be confusing.
For example the etLine.OnCallerID event may fire more than once! Before the etLine.OnOffering event fires the etLine.Call.CallerID.Flags property will have all of the flags turned off (the property will have a value of zero). The first time the etLine.OnCallerID event fires it is because the etLine.Call.CallerID.Flags property has changed to indicate that the LINECALLPARTYID_UNKNOWN or LINECALLPARTYID_UNAVAIL flags are set. A short time later the etLine.OnCallerID event fires again because the etLine.Call.CallerID.Flags property changes to indicate that the LINECALLPARTYID_NAME and LINECALLPARTYID_ADDRESS flags are set and the etLine.Call.CallerID.Name and etLine.Call.CallerID.Number properties contain information.
Setting this property to True will help to keep the etLine.OnCallerID event from firing when only the LINECALLPARTYID_UNKNOWN and/or LINECALLPARTYID_UNAVAIL flags are set. In simple terms, the etLine.CallerID will only fire once in most cases.
The default value for this property is True.
ActiveX: etLine.Call< >Flags
Type:
Integer
When: Run-Time
Read/Write: Read
Only
<Click
here for example>
This property is a bit flag that indicates what information is currently available. The information in the property is updated immediately before the related event is fired.
Use the method StringLINECALLPARTYID to decode this value.
See the property Address.Capabilities.CalledIDFlags for a list of the Line Call Party ID flags.
ActiveX: etLine.Call< >FormatName
Type: Boolean
When: Design-Time and Run-Time
Read/Write: Read and Write
When set to True, the information in the <>.Name subproperty is formatted with initial capitals.
For example, "FLINTSTONE FRED R" is converted to "Flintsone Fred R".
ActiveX: etLine.Call< >MaskNumber
Type: String
When: Design-Time and Run-Time
Read/Write: Read and Write
The information in the etLine.Call.<>.Number sub-property is formatted according to the mask.
The default value of this property will cause the etLine.Call.<>.Number to to be formatted according
to US and Canadian phone numbers; '000-000-0000;0'. In order to obtain the raw data use the following
format: ';0;*' or ''.
The etLine.Call.CallerID.MaskNumber will be applied after etLine.Device.TranslatePhoneNumber property causes the number to be unformatted.
The string consists of two fields with semicolons separating them. The first part of the mask is the mask itself. The second part is the character that determines whether the literal characters of the mask are matched to characters in the Value parameter or are inserted into the Value string.
These are the special characters used in the first field of the mask:
|
Character |
Meaning in mask |
|
! |
If a ! character appears in the mask, optional characters are represented in the returned string as leading blanks. If a ! character is not present, optional characters are represented in the returned string as trailing blanks. |
|
> |
If a > character appears in the mask, all characters that follow are in uppercase until the end of the mask or until a < character is encountered. |
|
< |
If a < character appears in the mask, all characters that follow are in lowercase until the end of the mask or until a > character is encountered. |
|
<> |
If these two characters appear together in a mask, no case checking is done and the data is formatted with the case present in the Value parameter. |
|
\ |
The character that follows a \ character is a literal character. Use this character to use any of the mask special characters as a literal. |
|
L |
The L character requires an alphabetic character only in this position. For the US, this is A-Z, a-z. |
|
l |
The l character permits only an alphabetic character in this position, but doesn't require it. |
|
A |
The A character requires an alphanumeric character only in this position. For the US, this is A-Z, a-z, 0-9. |
|
a |
The a character permits an alphanumeric character in this position, but doesn't require it. |
|
C |
The C character requires an arbitrary character in this position. |
|
c |
The c character permits an arbitrary character in this position, but doesn't require it. |
|
0 |
The 0 character requires a numeric character only in this position. |
|
9 |
The 9 character permits a numeric character in this position, but doesn't require it. |
|
# |
The # character permits a numeric character or a plus or minus sign in this position, but doesn't require it. |
|
: |
The : character separates hours, minutes, and seconds in times. If the character that separates hours, minutes, and seconds is different in the regional settings of the Control Panel, that character is substituted in the returned string. |
|
/ |
The / character separates months, days, and years in dates. If the character that separates months, days, and years is different in the regional settings of the Control Panel, that character is substituted in the returned string. |
|
; |
The ; character separates the three fields of the mask. |
|
_ |
The _ character automatically inserts spaces into the returned string. |
Any character that does not appear in the preceding table can appear in the first part of the mask as a literal character. Literal characters are inserted automatically if the second field of the mask is 0, or matched to characters in the Value parameter if the second field is any other value. The special mask characters can also appear as literal characters if preceded by a backslash character (\). The second field of the mask is a single character that indicates whether literal characters from the mask are included in the Value parameter. For example, the mask for a telephone number with area code could be the following string:
(000)_000-0000;0;*
The 0 in the second field indicates that the Value parameter should consist of the 10 digits of the phone number, rather than the 14 characters that make up the final formatted string.
A 0 in the second field indicates that literals are inserted into the Value string, any other character indicates that they should be included. The character to indicate whether literals should be included can be changed by changing the MaskNoSave typed constant that is declared in the Mask unit.
The third field of the mask is the character that appears in the returned string for blanks (characters that do not appear in Value). By default, this is the same as the character that stands for literal spaces. The two characters appear the same in the returned string.
ActiveX: etLine.Call< >Name
Type: String
When: Run-Time
Read/Write: Read Only
<Click
here for example>
Contains the name information supplyed by the switch or phone company. Not all telephony devices that supply CallerID information are capable of delivering the Name information. The etLine.Call.<>.Flags property will indicate if the information in the porperty is valid. The information in the property is updated immediately before the related event is fired.
ActiveX: etLine.Call< >Number
Type: String
When: Run-Time
Read/Write: Read Only
<Click
here for example>
Contains the phone number (Address) of the remote party. The etLine.Call.<>.Flags property will indicate if the information in the property is valid. The information in the property is updated immediately before the related event is fired.
The etLine.Call.<>.MaskNumber and etLine.Device.TranslatePhoneNumber properties control the formatting of this information.
ActiveX: etLine.Call< >OutOfArea
Type: Boolean
When: Run-Time
Read/Write: Read Only
<Click
here for example>
Indicates whether the information for the call is not available because it is not propagated all the way by the network. This information can also be ascertained from the etLine.Call.<>.Flags property. The information in the property is updated immediately before the related event is fired.
|
|