The ReturnValue
property returned by a synchronous GetList
call
and by callback
for
an asynchronous GetList
call is an iterator containing
the requested contact information. Each item (object) in the iterator corresponds
to one contact, contact group, or contacts database, depending on what
type of contact information was requested:
Table: ReturnValue properties for a contact describes the information returned per contact. The contact details are contained in one or more keys, with each key representing a specific piece of information.
Table: ReturnValue properties for a contact group describes the information returned per contact group.
Table: ReturnValue properties for a contacts database describes the information returned per contacts database.
Property |
Description |
Type |
---|---|---|
|
Unique identifier of the contact. |
string |
|
Each key represents one piece of contact information, such as first
name, last name, home phone number, or email address. For each contact, For example:
For a list of supported keys, see section Supported contact keys. |
object |
|
Label that describes the key value. |
string |
|
Value defined for the key. |
string |
|
This is an object that represents an additional value defined for the
key. This object contains the same properties as a key: There is no limit to how many nested values a key can contain. For example, an
The first email address is contained in |
object |
Property |
Description |
Type |
---|---|---|
|
Unique identifier of the contact group. |
string |
|
Name of the group. |
string |
|
Contains the IDs of the contacts that belong to the group.
|
array of strings |