AMX CAFE DUET STANDARD NETLINX API (SNAPI) DEVICES Instruction Manual page 296

Standard netlinx api (snapi) r 1.8.0 devices
Table of Contents

Advertisement

Video Conferencer Functions (Cont.)
Name
queryDB(si)
queryDB(si)
searchDB(sr)
updateRecord(sdr)
processCloseEvent(String)
processDeleteRecordEvent(boolean,String)
processEndOfSetEvent(String)
292
Component
Channel Level Command
IPhonebookComponent
IPhonebookComponent
IPhonebookComponent
IPhonebookComponent
IPhonebookComponentListener
IPhonebookComponentListener
IPhonebookComponentListener
Constant
PHONEBOOKPREV-
<key>[,<count>]
PHONEBOOKRE-
FRESH-
<key>[,<count>]
PHONEBOOK-
SEARCH-
<key>,ID=<id>
PHONEBOOKUP-
DATE-
<id>,<name>,<num-
ber>
PHONEBOOKCLOS-
ESEARCH-<key>
PHONEBOOKDE-
LETE-<id>,<success>
PHONEBOOKEND-
<key>
Notes
Request previous <count> records for the
phonebook search associated with search
key <key>. If <count> is not present, it is
assumed to be 1. Responses with
PHONEBOOKPREV-<key>,<count>,<posi-
tion> where <key> is the search key,
<count> is the number of records to expect
and <position> is the position of the first
record to be returned between 1 through
the total number of records.
Refresh <count> records starting with the
last starting position used with a PHONE-
BOOKNEXT or PHONEBOOKPREV com-
mand for the phonebook search associated
with search key <key>. If <count> is not
present, it is assumed to be 1. Responses
with PHONEBOOKNEXT-
<key>,<count>,<position> where <key> is
the search key, <count> is the number of
records to expect and <position> is the
position of the first record to be returned
between 1 through the total number of
records.
Search the phonebook database for
records with ID equal to <id>. If <id> is "*",
all records are returned. <key> is a search
key used in other search operations, such
as closeSearchDB(). It can be any string
you like, such as a panel device number or
internal key that makes sense for your pro-
gram. All future DB operation associated
with this search will reference this key
value.
Update phonebook record with index/id of
<id>, where <name> is the new name and
<number> is the new number
The search associated with search key
<key> have been closed. No more opera-
tions can be performed against this search.
Phonebook record with index/id of <id> was
deleted if <success> is 1, otherwise delete
failed.
End of search set was reached for search
with search key <key>
Standard NetLinx API (SNAPI) R 1.8.0

Advertisement

Table of Contents
loading

This manual is also suitable for:

Cafe duet

Table of Contents