User Guide

25
Standard NetLinx API (SNAPI) R 1.8.0
Dialer
Component
Name: Dialer
Interface: IDialerComponent
IDialerComponent
Component Functions:
Name: Channel: Level: Command: Constant: Notes:
cycleAudibleRing() 205 DIAL_AUDIBLE_RING Momentary Function Channel: Cycle audible ring when channel is activated
cycleAutoAnswer() 204 DIAL_AUTO_ANSWER Momentary Function Channel: Cycle auto answer when channel is activated
cycleOffHook() 202 DIAL_OFF_HOOK Momentary Function Channel: Cycle hook state when channel is activated
dial(index) DIALINDEX-<index> Dial a speed dial index, where <index> is 1 to x and x is the maximum supported speed
dial index (see specific module documentation)
dial(recordID) DIALID-<id> Dial a speed dial record, where <id> is a record id returned by a speed dial search.
dialDTMF(char) DTMF-<digit> Send a DTMF tone for a character without regard for hook status
dialNumber(number) DIALNUMBER-<number> Dial a number where <number> is the number to be dialed.
flashHook() 208 DIAL_FLASH_HOOK Momentary Function Channel: Flash hook when channel is activated
getDialerStatus() ?DIALERSTATUS Querydialer status, responds with DIALERSTATUS-<status>, where <status> is DIAL-
ING,BUSY,RINGING,DISCONNECTED,NEGOTIATING,FAULT,CONNECTED
redial() 201 DIAL_REDIAL Momentary Function Channel: Redial when channel is activated
setAudibleRingOn(state) 240 DIAL_AUDIBLE_RING_O
N
Discrete Function Channel: Audible ring is on while channel is active
setAutoAnswerOn(state) 239 DIAL_AUTO_ANSWER_O
N
Discrete Function Channel: Auto answer is on while channel is active
setOffHook(state) 238 DIAL_OFF_HOOK_ON Discrete Function Channel: Hook state is off hook while channel is active
Listener
Name: Dialer Listener
Interface: IDialerComponentListener
IDialerComponentListener
Listener Functions:
Name: Channel: Level: Command: Constant: Notes:
processAudibleRingOn-
Event
240 DIAL_AUDIBLE_RING_FB Feedback Channel: Audible ring is on if channel is on
processAutoAnswerOn-
Event
239 DIAL_AUTO_ANSWER_F
B
Feedback Channel: Auto answer is on if channel is on
processDialerStatusEv-
ent
DIALERSTATUS-BUSY Dialer status changed, number being dialed is busy
processDialerStatusEv-
ent
DIALERSTATUS-CONNECTED Dialer status changed, dialer is connected