| Platform | Since |
|---|---|
| Android | 0.8 |
| iPhone | 0.8 |
| iPad | 0.8 |
An object which represents a person in the contacts database.
There are two kinds of properties: single value and multivalue. Single value properties are returned as a direct value, while mutlivalue properties are returned as dictionary objects with keys which represent labels of the property, with values that are arrays of all values in the property which correspond to that label (e.g. {"home" : [address1, address2]})
| Name | Summary |
|---|---|
| addEventListener |
Adds the specified callback as an event listener for the named event. |
| fireEvent |
Fires a synthesized event to any registered listeners. |
| getAddress |
Gets the value of the address property. |
| getBirthday |
Gets the value of the birthday property. |
| getCreated |
Gets the value of the created property. |
| getDate |
Gets the value of the date property. |
| getDepartment |
Gets the value of the department property. |
| getEmail |
Gets the value of the email property. |
| getFirstName |
Gets the value of the firstName property. |
| getFirstPhonetic |
Gets the value of the firstPhonetic property. |
| getFullName |
Gets the value of the fullName property. |
| getImage |
Gets the value of the image property. |
| getInstantMessage |
Gets the value of the instantMessage property. |
| getJobTitle |
Gets the value of the jobTitle property. |
| getKind |
Gets the value of the kind property. |
| getLastName |
Gets the value of the lastName property. |
| getLastPhonetic |
Gets the value of the lastPhonetic property. |
| getMiddleName |
Gets the value of the middleName property. |
| getMiddlePhonetic |
Gets the value of the middlePhonetic property. |
| getModified |
Gets the value of the modified property. |
| getNickname |
Gets the value of the nickname property. |
| getNote |
Gets the value of the note property. |
| getOrganization |
Gets the value of the organization property. |
| getPhone |
Gets the value of the phone property. |
| getPrefix |
Gets the value of the prefix property. |
| getRelatedNames |
Gets the value of the relatedNames property. |
| getSuffix |
Gets the value of the suffix property. |
| getUrl |
Gets the value of the url property. (iPhone, iPad only.) |
| removeEventListener |
Removes the specified callback as an event listener for the named event. |
| setAddress |
Sets the value of the address property. |
| setBirthday |
Sets the value of the birthday property. |
| setCreated |
Sets the value of the created property. |
| setDate |
Sets the value of the date property. |
| setDepartment |
Sets the value of the department property. |
| setEmail |
Sets the value of the email property. |
| setFirstName |
Sets the value of the firstName property. |
| setFirstPhonetic |
Sets the value of the firstPhonetic property. |
| setFullName |
Sets the value of the fullName property. |
| setImage |
Sets the value of the image property. |
| setInstantMessage |
Sets the value of the instantMessage property. |
| setJobTitle |
Sets the value of the jobTitle property. |
| setKind |
Sets the value of the kind property. |
| setLastName |
Sets the value of the lastName property. |
| setLastPhonetic |
Sets the value of the lastPhonetic property. |
| setMiddleName |
Sets the value of the middleName property. |
| setMiddlePhonetic |
Sets the value of the middlePhonetic property. |
| setModified |
Sets the value of the modified property. |
| setNickname |
Sets the value of the nickname property. |
| setNote |
Sets the value of the note property. |
| setOrganization |
Sets the value of the organization property. |
| setPhone |
Sets the value of the phone property. |
| setPrefix |
Sets the value of the prefix property. |
| setRelatedNames |
Sets the value of the relatedNames property. |
| setSuffix |
Sets the value of the suffix property. |
| setUrl |
Sets the value of the url property. (iPhone, iPad only.) |
| Name | Type | Summary |
|---|---|---|
| address | Object |
The addresses for the person. Multi-value, valid labels are: |
| birthday | String |
The birthday of the person. Single value, format is "yyyy-MM-dd'T'HH:mm:ss'.'SSS+0000" |
| created | String |
The date the person was created in the database. Single value, format is "yyyy-MM-dd'T'HH:mm:ss'.'SSS+0000", read-only |
| date | Object |
Dates associated with the person. Multi-value, valid labels are: |
| department | String |
The department of the person. Single value |
| Object |
The email addresses for the person. Multi-value, valid labels are: |
|
| firstName | String |
The first name of the person. Single value |
| firstPhonetic | String |
The phonetic first name of the person. Single value |
| fullName | String |
The localized full name of the person. Single value, read-only |
| image | Object |
A blob object representing the image for the person. Set to |
| instantMessage | Object |
The instant messenger names for the person. Multi-value, valid labels are: |
| jobTitle | String |
The job title of the person. Single value |
| kind | Number |
The kind of person. Single value, one of |
| lastName | String |
The last name of the person. Single value |
| lastPhonetic | String |
The phonetic last name of the person. Single value |
| middleName | String |
The middle name of the person. Single value |
| middlePhonetic | String |
The phonetic middle name of the person. Single value |
| modified | String |
The most recent date the person was modified. Single value, format is "yyyy-MM-dd'T'HH:mm:ss'.'SSS+0000", read-only |
| nickname | String |
The nickname of the person. Single value |
| note | String |
Notes for the person. Single value |
| organization | String |
The organization the person belongs to. Single value |
| phone | Object |
The phone numbers for the person. Multi-value, valid labels are: |
| prefix | String |
The prefix for the person. Single value |
| relatedNames | Object |
The names of people the person is related to. Multi-value, valid labels are: |
| suffix | String |
The suffix for the person. Single value |
| url | Object |
URLs of webpages associated with the person. Multi-value, valid labels are: |