You are reading 12.7.0. See this page in 13.4.1.
Titanium.Contacts.Person
Extends Titanium.Proxy
An object that represents a contact record for a person or organization in the system contacts address book.
A person object is created using Titanium.Contacts.createPerson.
The following two kinds of properties exist for this object:
- single value - contains either a
stringornumbertype value, an array ofstringtype values, ornullif unset. - multi-value - contains a dictionary with typical keys of
home,workand/orother. Each key contains either astringtype value, an array ofstringtype values, or a dictionary containing key/value pairs withstringtype values.
Adding and Modifying Properties
Support for adding and modifying properties is currently supported on iOS and Android.
Keys as Address Book UI Labels
Keys act as labels in the address book user interface.
Although there is limited support for custom, arbitrarily-named, keys when used with multi-value properties, there is no support them with single value properties.
On iOS, creating custom keys is not recommended, and will lead to undefined results.
If a label has been created by the user of the device and used with a multi-value property, it will exist as a key with the same name.
See examples in Titanium.Contacts for more information.
These APIs are unavailable on macOS if the app is built on a version of Xcode < 12.
Properties 32
Addresses for the person. Multi-value. Read-only on Android.
The format of the dictionary accepted by this property is as follows:
- Keys: any of
home,work, and/orother. - Values: arrays of dictionary types with seven keys,
CountryCode,Street,City, ,State,CountryandPostalCode, each with astringtype value.
On Android:
'CountryCode' and 'County' are currently not supported.
On iOS:
The CountryCode key value may be one of the recognized two-character ISO 3166-1 country
codes, and determines the format in which the contact is presented by the address book
user interface. See the wikipedia section
ISO 3166-1 alpha-2
for a comprehensive list of codes.
Alternate birthday of the person. Single Dictionary.
The format of the dictionary accepted by this property is as follows:
- Keys:
calendarIdentifier,era,year,month,dayandisLeapMonth. - Values: Use
chinese,hebrewandislamic-civilforcalendarIdentifier. Usenumbertype forera,year,monthandday. These must be consistent with correspondingcalendarIdentifier. Usebooleantype forisLeapMonth.
Inherited from Titanium.Proxy
The name of the API that this proxy corresponds to.
birthday
StringDate of birth of the person. Single value.
Date format is "yyyy-MM-ddTHH:mm:ss.SSS+0000"
Inherited from Titanium.Proxy
Indicates if the proxy will bubble an event to its parent.
Default: true
Dates associated with the person. Multi-value.
Adding or modifying this property is not currently supported.
The format of the dictionary accepted by this property is as follows:
- Keys: any of
anniversaryand/orother. - Values: array of
stringtype.
Date format is "yyyy-MM-ddTHH:mm:ss.SSS+0000"
department
StringDepartment of the person. Single value.
Email addresses for the person. Multi-value. Read-only on Android.
The format of the dictionary accepted by this property is as follows:
- Keys: any of
home,work, and/orother. - Values: array of
stringtype.
firstName
StringFirst name of the person. Single value.
firstPhonetic
StringPhonetic first name of the person. Single value.
Localized full name of the person. Single value. Read-only on Android.
The full name will be printed in the order of. Prefix,first name, middle name, family name, suffix.
Record identifier of the person. Single value.
Identifier of the person.
Prior to iOS 9, use the recordId property.
Image for the person. Single value. Read-only for >= iOS9
Set to null to remove the image.
Instant messenger information of the person. Multi-value.
The format of the dictionary accepted by this property is as follows:
- Keys: any of
home,workand/orother. - Values: arrays of dictionary types with two keys,
serviceandusername, each with astringtype value.
The service key value may be one of AIM, Facebook, GaduGadu, GoogleTalk, ICQ,
Jabber, MSN, QQ, Skype, or Yahoo. These values are key sensitive.
jobTitle
StringJob title of the person. Single value.
kind
NumberDetermines the type of information the person record contains; either person or organization. Read-only on Android.
lastName
StringLast name of the person. Single value.
lastPhonetic
StringPhonetic last name of the person. Single value.
Inherited from Titanium.Proxy
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
middleName
StringMiddle name of the person. Single value.
middlePhonetic
StringPhonetic middle name of the person. Single value.
nickname
StringNickname of the person. Single value.
note
StringNotes for the person. Single value.
organization
StringOrganization to which the person belongs. Single value.
Phone numbers for the person. Multi-value. Read-only on Android.
The format of the dictionary accepted by this property is as follows:
- Keys: any of
home,work,other,mobile,pager,workFax,homeFax,main, and/oriPhone. - Values: array of
stringtype.
Prefix for the person. Single value.
Record identifier of the person. Single value. Deprecated since iOS 9.
For iOS 9 and later, use the Titanium.Contacts.Person.identifier property. Previously, a contact can be selected without requiring User permission. In such case this property returns -1.
Names of people to which the person is related. Multi-value.
The format of the dictionary accepted by this property is as follows:
- Keys: any of
mother,father,parent,brother,sister,child,friend,spouse,partner,assistant,manager, and/orother. - Values: array of
stringtype.
Social profile information of the person. Multi-value.
The format of the dictionary accepted by this property is as follows:
- Keys: any of
home,workand/orother. - Values: arrays of dictionary types with two keys,
serviceandusernameeach with astringtype value.
The service key value may be one of twitter, sinaweibo, gamecenter, facebook,
myspace, linkedin, or flickr. These values are key sensitive.
Suffix for the person. Single value.
URLs of webpages associated with the person. Multi-value.
The format of the dictionary accepted by this property is as follows:
- Keys: any of
homepage,home,work, and/orother. - Values: array of
stringtype.
Methods 4
Inherited from Titanium.Proxy
Adds the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. 4 fields
|
applyProperties
since 3.0.0Inherited from Titanium.Proxy
Applies the properties to the proxy.
| Parameters | Type | Description |
|---|---|---|
| props | Dictionary | A dictionary of properties to apply. |
Inherited from Titanium.Proxy
Fires a synthesized event to any registered listeners.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| event? | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Inherited from Titanium.Proxy
Removes the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to 4 fields
|