Contact Class

Contact Object

HomeSeer Phone keeps an internal address book that is loaded when the program is started. Each address book entry has numerous properties that can be read and set. The class name is contact, and has the following properties:

Property	Description
announcement	The announcement to play when this caller calls. Either a text-to-speech string or full path to a wav file.
announce_local_wav	Text or wave file that will be played when this caller calls. The announcement is played through HomeSeer.
answer_rings	Set to TRUE to answer this call on the answer_rings_count, else FALSE to ignore
answer_rings_count	The number of rings to answer when this caller calls
business_phone	Business phone number
business_phone_2	2nd Business phone number
cell_phone	Cell phone number
cell_phone_2	2nd Cell phone number
custom1	A custom field
custom2	A custom field
email_address	email address
email_address_2	2nd email address
email_address_3	3rd email address
FIRST	First name
LAST	Last name
company_name	Company name
home_phone	Home phone number
home_phone_2	2nd Home phone number
fax_home	Home fax phone number
fax_work	Work fax phone number
pager_phone	Pager phone number
pager_pin	Pager PIN
cid_group_category	Currently not used in HomeSeer Phone, this field can be used by scripts to control answering and voicemail functions on groups of address book entries. e.g. Enter "Family" here for all family members, and then a script can control allowing the phones to ring when a family member calls.
home_address_1 through home_address_3	Three home address fields for (typically) street address information.
home_city	Home city name
home_state_province	Home state or province
home_postal_code	Home postal code for an address
home_country	Home country name for an address
business_address_1 through business_address_3	Three business address fields for (typically) street address information.
business_city	Business city name
business_state_province	Business state or province
business_postal_code	Business postal code for an address
business_country	Business country name for an address
cid_name	Name to match in the caller ID name field when a call arrives. Some phone systems may out a special string in this field like "marketing". If this field is present and matches the caller ID name field, the address entry will match the call. This field is the "Name Matching" field on the "Phone (CID Matching)" tab in the address book.
EnableRingPattern	Supported only on the Hi-Phone device. If set to TRUE, and an incoming call matches this address book entry, the phones in the home will ring with pattern as set in the RingON, RingOFF, RingDelay properties.
RingON, RingOFF, RingDelay	Hi-Phone only. These properties specify the ring pattern when the EnableRingPattern property is set to TRUE. The times are in 1/10 of a second.
cidflags	cidflags bit definitions: CT_CIDFLAGS_BLOCKED = 1 ' callers with this CID are blocked CT_CIDFLAGS_ANNOUNCE = 2 ' this ID is announced CT_CIDFLAGS_SPARE1 = 4 ' spare, not used CT_CIDFLAGS_SPEC_ANN = 8 ' play special announcement to caller CT_CIDFLAGS_POPUP = &H10 ' pop up window with CID info CT_CIDFLAGS_PRIVATE = &H20 ' entry matches private CID calls CT_CIDFLAGS_OUTOFAREA = &H40 ' entry matches out of area calls
Misc1 through Misc6	Miscellaneous string fields for use by scripts to store information. These fields are saved in the address book file but do not appear in the user interface.
MiscNum1 through MiscNum4	Miscellaneous long integer fields for use by scripts to store information. These fields are saved in the address book file but do not appear in the user interface.
flags	flags bit definitions: CT_FLAGS_VRENABLED = 1 ' address book entry is enabled as voice command CT_FLAGS_HANGUP = 2 ' hang up after speaking announcement