PIM Constants

Defines
#define	MA_PIM_TYPE_BINARY   0
#define	MA_PIM_TYPE_BOOLEAN   1
	int
#define	MA_PIM_TYPE_DATE   2
#define	MA_PIM_TYPE_INT   3
	int
#define	MA_PIM_TYPE_STRING   4
	wide-string '\0'
#define	MA_PIM_TYPE_STRING_ARRAY   5
#define	MA_PIM_FIELD_CONTACT_ADDR   100
	The addresses of the contact. Multiple string arrays. Has MA_PIM_CONTACT_ADDR indices.
#define	MA_PIM_FIELD_CONTACT_BIRTHDAY   101
	The birthday of the contact. Single date.
#define	MA_PIM_FIELD_CONTACT_CLASS   102
	Access class. Single integer. May be one of MA_PIM_CONTACT_CLASS_CONFIDENTIAL, MA_PIM_CONTACT_CLASS_PRIVATE, or MA_PIM_CONTACT_CLASS_PUBLIC.
#define	MA_PIM_FIELD_CONTACT_EMAIL   103
	The email addresses of the contact. Multiple strings.
#define	MA_PIM_FIELD_CONTACT_FORMATTED_ADDR   104
	The formatted addresses of the contact. Single string.
#define	MA_PIM_FIELD_CONTACT_FORMATTED_NAME   105
	The formatted name of the contact. Single string.
#define	MA_PIM_FIELD_CONTACT_NAME   106
	The name of the contact. Single string array containing Family name, Given name, Middle name, Prefix, Suffix, Phonetic family name, Phonetic given name, Phonetic middle name. Has MA_PIM_CONTACT_NAME indices.
#define	MA_PIM_FIELD_CONTACT_NICKNAME   107
	The nickname of the contact. Single string.
#define	MA_PIM_FIELD_CONTACT_NOTE   108
	Supplementary information, or a comment. Multiple string.
#define	MA_PIM_FIELD_CONTACT_ORG   109
	The organization name of the contact. Multiple string.
#define	MA_PIM_FIELD_CONTACT_PHOTO   110
	The contact's photo. A single int representing a data handle. Connected with PHOTO_URL.
#define	MA_PIM_FIELD_CONTACT_PHOTO_URL   111
	The contact's photo url. A single string representing the URL of a photo. Connected with PHOTO.
#define	MA_PIM_FIELD_CONTACT_PUBLIC_KEY   112
	The public key of the contact. Connected with PUBLIC_KEY_STRING.
#define	MA_PIM_FIELD_CONTACT_PUBLIC_KEY_STRING   113
	A string representation of the contact's public key. Connected with PUBLIC_KEY.
#define	MA_PIM_FIELD_CONTACT_REVISION   114
	The revision date of the field. Single date.
#define	MA_PIM_FIELD_CONTACT_TEL   115
	The telephone numbers of the contact. Multiple strings.
#define	MA_PIM_FIELD_CONTACT_TITLE   116
	The professional title of the contact inside the organization. Multiple strings.
#define	MA_PIM_FIELD_CONTACT_UID   117
	The unique identifier of the contact on the current device. Single string.
#define	MA_PIM_FIELD_CONTACT_URL   118
	Uniform Resource Locators associated with the contact. Multiple strings.
#define	MA_PIM_FIELD_CONTACT_IM   119
	The IM addresses of the contact. Multiple arrays. Has MA_PIM_CONTACT_IM indices.
#define	MA_PIM_FIELD_CONTACT_RELATION   120
	A relation of the contact.
#define	MA_PIM_FIELD_CONTACT_ORG_INFO   121
	Information about the organization. Has MA_PIM_CONTACT_ORG_INFO indices.
#define	MA_PIM_CONTACT_ADDR_POBOX   0
	Index for MA_PIM_FIELD_CONTACT_ADDR. Post office box number.
#define	MA_PIM_CONTACT_ADDR_EXTRA   1
	Index for MA_PIM_FIELD_CONTACT_ADDR. Extra info.
#define	MA_PIM_CONTACT_ADDR_STREET   2
	Index for MA_PIM_FIELD_CONTACT_ADDR. Street name and number.
#define	MA_PIM_CONTACT_ADDR_LOCALITY   3
	Index for MA_PIM_FIELD_CONTACT_ADDR. Locality name. (ex. city)
#define	MA_PIM_CONTACT_ADDR_REGION   4
	Index for MA_PIM_FIELD_CONTACT_ADDR. Region name. (ex. province, state or territory)
#define	MA_PIM_CONTACT_ADDR_POSTALCODE   5
	Index for MA_PIM_FIELD_CONTACT_ADDR. Postal code.
#define	MA_PIM_CONTACT_ADDR_COUNTRY   6
	Index for MA_PIM_FIELD_CONTACT_ADDR. Country name.
#define	MA_PIM_CONTACT_ADDR_NEIGHBORHOOD   7
	Index for MA_PIM_FIELD_CONTACT_ADDR. Neighborhood.
#define	MA_PIM_CONTACT_NAME_FAMILY   0
	Index for MA_PIM_FIELD_CONTACT_NAME. Family name.
#define	MA_PIM_CONTACT_NAME_GIVEN   1
	Index for MA_PIM_FIELD_CONTACT_NAME. Given name.
#define	MA_PIM_CONTACT_NAME_OTHER   2
	Index for MA_PIM_FIELD_CONTACT_NAME. Alternate/secondary names, if any.
#define	MA_PIM_CONTACT_NAME_PREFIX   3
	Index for MA_PIM_FIELD_CONTACT_NAME. Prefix. (ex. "Dr.")
#define	MA_PIM_CONTACT_NAME_SUFFIX   4
	Index for MA_PIM_FIELD_CONTACT_NAME. Suffix. (ex. "M.D.")
#define	MA_PIM_CONTACT_NAME_PHONETIC_FAMILY   5
	Index for MA_PIM_FIELD_CONTACT_NAME. Phonetic last name.
#define	MA_PIM_CONTACT_NAME_PHONETIC_GIVEN   6
	Index for MA_PIM_FIELD_CONTACT_NAME. Phonetic first name.
#define	MA_PIM_CONTACT_NAME_PHONETIC_OTHER   7
	Index for MA_PIM_FIELD_CONTACT_NAME. Phonetic middle name.
#define	MA_PIM_CONTACT_NAME_DISPLAY   8
	Index for MA_PIM_FIELD_CONTACT_NAME. Display name.
#define	MA_PIM_CONTACT_ORG_INFO_DEPARTMENT   0
#define	MA_PIM_CONTACT_ORG_INFO_JOB_DESCRIPTION   1
#define	MA_PIM_CONTACT_ORG_INFO_SYMBOL   2
#define	MA_PIM_CONTACT_ORG_INFO_PHONETIC_NAME   3
#define	MA_PIM_CONTACT_ORG_INFO_OFFICE_LOCATION   4
#define	MA_PIM_CONTACT_ORG_INFO_PHONETIC_NAME_STYLE   5
#define	MA_PIM_CONTACT_IM_USERNAME   0
	MA_PIM_TYPE_STRING.
#define	MA_PIM_CONTACT_IM_PROTOCOL   1
	MA_PIM_TYPE_STRING.
#define	MA_PIM_CONTACT_CLASS_CONFIDENTIAL   200
	Value for MA_PIM_FIELD_CONTACT_CLASS.
#define	MA_PIM_CONTACT_CLASS_PRIVATE   201
	Value for MA_PIM_FIELD_CONTACT_CLASS.
#define	MA_PIM_CONTACT_CLASS_PUBLIC   202
	Value for MA_PIM_FIELD_CONTACT_CLASS.
#define	MA_PIM_CONTACT_IM_PROTOCOL_AIM   "AIM"
	This constant describes an AIM protocol.
#define	MA_PIM_CONTACT_IM_PROTOCOL_MSN   "MSN"
	This constant describes a MSN protocol.
#define	MA_PIM_CONTACT_IM_PROTOCOL_YAHOO   "Yahoo"
	This constant describes a Yahoo protocol.
#define	MA_PIM_CONTACT_IM_PROTOCOL_SKYPE   "Skype"
	This constant describes a Skype protocol.
#define	MA_PIM_CONTACT_IM_PROTOCOL_QQ   "QQ"
	This constant describes a QQ protocol.
#define	MA_PIM_CONTACT_IM_PROTOCOL_GOOGLE_TALK   "GoogleTalk"
	This constant describes a Google Talk protocol.
#define	MA_PIM_CONTACT_IM_PROTOCOL_ICQ   "ICQ"
	This constant describes an ICQ protocol.
#define	MA_PIM_CONTACT_IM_PROTOCOL_JABBER   "Jabber"
	This constant describes a Jabber protocol.
#define	MA_PIM_CONTACT_IM_PROTOCOL_NETMEETING   "Netmeeting"
	This constant describes a NetMeeting protocol.
#define	MA_PIM_ATTR_ASST   1
	The value describes an assistant.
#define	MA_PIM_ATTR_AUTO   2
	Unknown.
#define	MA_PIM_ATTR_FAX   4
	The value describes a fax number.
#define	MA_PIM_ATTR_HOME   8
	The value describes a home phone number.
#define	MA_PIM_ATTR_MOBILE   16
	The value describes a mobile phone number.
#define	MA_PIM_ATTR_OTHER   32
	Unknown.
#define	MA_PIM_ATTR_PAGER   64
	The value describes a pager number.
#define	MA_PIM_ATTR_PREFERRED   128
#define	MA_PIM_ATTR_SMS   256
	The value describes an SMS number?
#define	MA_PIM_ATTR_WORK   512
	The value describes a work phone number.
#define	MA_PIM_ATTR_ADDR_HOME   101
	The constant describes a home address.
#define	MA_PIM_ATTR_ADDR_WORK   102
	The constant describes a work address.
#define	MA_PIM_ATTR_ADDR_OTHER   103
	The constant describes a different address type.
#define	MA_PIM_ATTR_ADDR_CUSTOM   104
#define	MA_PIM_ATTR_EMAIL_HOME   201
	The constant describes a home e-mail address.
#define	MA_PIM_ATTR_EMAIL_WORK   202
	The constant describes a work e-mail address.
#define	MA_PIM_ATTR_EMAIL_MOBILE   203
	The constant describes a mobile e-mail address.
#define	MA_PIM_ATTR_EMAIL_OTHER   204
	The constant describes a different e-mail address type.
#define	MA_PIM_ATTR_EMAIL_CUSTOM   205
#define	MA_PIM_ATTR_FORMATTED_ADDR_HOME   301
	The constant describes a home formatted address.
#define	MA_PIM_ATTR_FORMATTED_ADDR_WORK   302
	The constant describes a work formatted address.
#define	MA_PIM_ATTR_FORMATTED_ADDR_OTHER   303
	The constant describes a different formatted address type.
#define	MA_PIM_ATTR_FORMATTED_ADDR_CUSTOM   304
#define	MA_PIM_ATTR_ORG_WORK   401
	The constant describes a work organization.
#define	MA_PIM_ATTR_ORG_OTHER   402
	The constant describes a different organization type.
#define	MA_PIM_ATTR_ORG_CUSTOM   403
#define	MA_PIM_ATTR_PHONE_HOME   501
	The constant describes a home phone number.
#define	MA_PIM_ATTR_PHONE_MOBILE   502
	The constant describes a mobile phone number.
#define	MA_PIM_ATTR_PHONE_HOME_FAX   503
	The constant describes a home fax phone number.
#define	MA_PIM_ATTR_PHONE_WORK_FAX   504
	The constant describes a work fax phone number.
#define	MA_PIM_ATTR_PHONE_PAGER   505
	The constant describes a pager phone number.
#define	MA_PIM_ATTR_PHONE_IPHONE   506
	The constant describes an iPhone phone number.
#define	MA_PIM_ATTR_PHONE_WORK   507
	The constant describes a work phone number.
#define	MA_PIM_ATTR_PHONE_CALLBACK   508
	The constant describes a callback phone number.
#define	MA_PIM_ATTR_PHONE_CAR   509
	The constant describes a car phone number.
#define	MA_PIM_ATTR_PHONE_COMPANY_MAIN   510
	The constant describes a company main phone number.
#define	MA_PIM_ATTR_PHONE_ISDN   511
	The constant describes a ISDN phone number.
#define	MA_PIM_ATTR_PHONE_OTHER_FAX   512
	The constant describes a other fax type phone number.
#define	MA_PIM_ATTR_PHONE_RADIO   513
	The constant describes a radio phone number.
#define	MA_PIM_ATTR_PHONE_TELEX   514
	The constant describes a telex phone number.
#define	MA_PIM_ATTR_PHONE_TTY_TDD   515
	The constant describes a TTY TDD phone number.
#define	MA_PIM_ATTR_PHONE_WORK_MOBILE   516
	The constant describes a work mobile phone number.
#define	MA_PIM_ATTR_PHONE_WORK_PAGER   517
	The constant describes a work pager phone number.
#define	MA_PIM_ATTR_PHONE_ASSISTANT   518
	The constant describes an assistant phone number.
#define	MA_PIM_ATTR_PHONE_MMS   519
	The constant describes a MMS phone number.
#define	MA_PIM_ATTR_PHONE_OTHER   520
	The constant describes a different phone number type.
#define	MA_PIM_ATTR_PHONE_CUSTOM   521
#define	MA_PIM_ATTR_TITLE_WORK   601
#define	MA_PIM_ATTR_TITLE_OTHER   602
#define	MA_PIM_ATTR_TITLE_CUSTOM   603
#define	MA_PIM_ATTR_WEBSITE_HOMEPAGE   701
	The constant describes a homepage website.
#define	MA_PIM_ATTR_WEBSITE_BLOG   702
	The constant describes a blog website.
#define	MA_PIM_ATTR_WEBSITE_PROFILE   703
	The constant describes a profile website.
#define	MA_PIM_ATTR_WEBSITE_HOME   704
	The constant describes a home website.
#define	MA_PIM_ATTR_WEBSITE_WORK   705
	The constant describes a work website.
#define	MA_PIM_ATTR_WEBSITE_FTP   706
	The constant describes a FTP website.
#define	MA_PIM_ATTR_WEBSITE_OTHER   707
	The constant describes a different website type.
#define	MA_PIM_ATTR_WEBSITE_CUSTOM   708
#define	MA_PIM_ATTR_IM_HOME   801
	The constant describes a home IM address.
#define	MA_PIM_ATTR_IM_WORK   802
	The constant describes a work IM address.
#define	MA_PIM_ATTR_IM_OTHER   803
	The constant describes a different IM address type.
#define	MA_PIM_ATTR_IM_CUSTOM   804
#define	MA_PIM_ATTR_RELATION_MOTHER   901
	The constant describes a mother relation.
#define	MA_PIM_ATTR_RELATION_FATHER   902
	The constant describes a father relation.
#define	MA_PIM_ATTR_RELATION_PARENT   903
	The constant describes a parent relation.
#define	MA_PIM_ATTR_RELATION_SISTER   904
	The constant describes a sister relation.
#define	MA_PIM_ATTR_RELATION_BROTHER   905
	The constant describes a brother relation.
#define	MA_PIM_ATTR_RELATION_CHILD   906
	The constant describes a child relation.
#define	MA_PIM_ATTR_RELATION_FRIEND   907
	The constant describes a friend relation.
#define	MA_PIM_ATTR_RELATION_SPOUSE   908
	The constant describes a spouse relation.
#define	MA_PIM_ATTR_RELATION_PARTNER   909
	The constant describes a partner relation.
#define	MA_PIM_ATTR_RELATION_MANAGER   910
	The constant describes a manager relation.
#define	MA_PIM_ATTR_RELATION_ASSISTANT   911
	The constant describes a assistant relation.
#define	MA_PIM_ATTR_RELATION_DOMESTIC_PARTNER   912
	The constant describes a domestic partner relation.
#define	MA_PIM_ATTR_RELATION_REFERRED_BY   913
	The constant describes a referred by relation.
#define	MA_PIM_ATTR_RELATION_RELATIVE   914
	The constant describes a relative relation.
#define	MA_PIM_ATTR_RELATION_CUSTOM   915
#define	MA_PIM_ATTR_ORG_INFO_WORK   1001
#define	MA_PIM_ATTR_ORG_INFO_OTHER   1002
#define	MA_PIM_ATTR_ORG_INFO_CUSTOM   1003
#define	MA_PIM_ATTRPREFERRED   0x10000
	The constant describes a preferred field.
#define	MA_PIM_ERR_NONE   0
	No error. The operation completed successfully.
#define	MA_PIM_ERR_UNAVAILABLE   -1
	This function is unavailable on the current platform.
#define	MA_PIM_ERR_NATIVE_TYPE_MISMATCH   -2
	The native database's data type for the given field did not match the MoSync API.
#define	MA_PIM_ERR_LIST_TYPE_INVALID   -3
	The specified list type is invalid.
#define	MA_PIM_ERR_LIST_UNAVAILABLE   -4
	The specified pim list is not available on the current platform.
#define	MA_PIM_ERR_LIST_ALREADY_OPENED   -5
	The specified list is already opened.
#define	MA_PIM_ERR_FIELD_INVALID   -6
	The specified field is invalid.
#define	MA_PIM_ERR_FIELD_UNSUPPORTED   -7
	The field type is not supported.
#define	MA_PIM_ERR_FIELD_EMPTY   -8
	The requested field doesn't have a value.
#define	MA_PIM_ERR_FIELD_COUNT_MAX   -9
	More values in this field are not supported.
#define	MA_PIM_ERR_FIELD_READ_ONLY   -10
	The field is read-only.
#define	MA_PIM_ERR_FIELD_WRITE_ONLY   -11
	The field is write-only.
#define	MA_PIM_ERR_INDEX_INVALID   -12
	The given index is not valid.
#define	MA_PIM_ERR_HANDLE_INVALID   -13
	Invalid handle.
#define	MA_PIM_ERR_ATTRIBUTE_COMBO_UNSUPPORTED   -14
	The field/attribute combination is not supported.
#define	MA_PIM_ERR_ATTRIBUTE_CUSTOM   -15
	The values's attribute is not set to custom.
#define	MA_PIM_ERR_BUFFER_INVALID   -16
	Invalid buffer structure.
#define	MA_PIM_ERR_NO_LABEL   -17
	The value does not have a custom label.
#define	MA_PIM_ERR_OPERATION_NOT_PERMITTED   -18
	The operation is not allowed by the Address Book database.

---

Define Documentation

#define MA_PIM_TYPE_BINARY   0

bytes the bytes are not null-terminated.

#define MA_PIM_TYPE_BOOLEAN   1

int

#define MA_PIM_TYPE_DATE   2

int unix time.

#define MA_PIM_TYPE_INT   3

int

#define MA_PIM_TYPE_STRING   4

wide-string '\0'

#define MA_PIM_TYPE_STRING_ARRAY   5

int (wide-string '\0')* the int specifies the number of strings. there is no extra null terminator at the end of the list.

#define MA_PIM_FIELD_CONTACT_ADDR   100

The addresses of the contact. Multiple string arrays. Has MA_PIM_CONTACT_ADDR indices.

Valid values

MA_PIM_TYPE_STRING_ARRAY.

Operations

Add, Set and Get.

Attributes

MA_PIM_ATTR_ADDR_HOME, MA_PIM_ATTR_ADDR_WORK, MA_PIM_ATTR_ADDR_OTHER, MA_PIM_ATTR_ADDR_CUSTOM.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_BIRTHDAY   101

The birthday of the contact. Single date.

Valid values

MA_PIM_TYPE_DATE.

Operations

Add, Set and Get.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_CLASS   102

Access class. Single integer. May be one of MA_PIM_CONTACT_CLASS_CONFIDENTIAL, MA_PIM_CONTACT_CLASS_PRIVATE, or MA_PIM_CONTACT_CLASS_PUBLIC.

Valid values

MA_PIM_TYPE_INT.

Operations

Add, Set and Get.

Supported Platforms

Symbian.

#define MA_PIM_FIELD_CONTACT_EMAIL   103

The email addresses of the contact. Multiple strings.

Valid values

MA_PIM_TYPE_STRING.

Operations

Add, Set and Get.

Attributes

MA_PIM_ATTR_EMAIL_HOME, MA_PIM_ATTR_EMAIL_WORK, MA_PIM_ATTR_EMAIL_MOBILE, MA_PIM_ATTR_EMAIL_OTHER, MA_PIM_ATTR_EMAIL_CUSTOM.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_FORMATTED_ADDR   104

The formatted addresses of the contact. Single string.

Valid values

MA_PIM_TYPE_STRING.

Operations

Get only.

Attributes

MA_PIM_ATTR_FORMATTED_ADDR_HOME, MA_PIM_ATTR_FORMATTED_ADDR_WORK, MA_PIM_ATTR_FORMATTED_ADDR_OTHER, MA_PIM_ATTR_FORMATTED_ADDR_CUSTOM.

Supported Platforms

Android.

#define MA_PIM_FIELD_CONTACT_FORMATTED_NAME   105

The formatted name of the contact. Single string.

Valid values

MA_PIM_TYPE_STRING.

Operations

Get only.

Supported Platforms

Symbian.

#define MA_PIM_FIELD_CONTACT_NAME   106

The name of the contact. Single string array containing Family name, Given name, Middle name, Prefix, Suffix, Phonetic family name, Phonetic given name, Phonetic middle name. Has MA_PIM_CONTACT_NAME indices.

Valid values

MA_PIM_TYPE_STRING_ARRAY.

Operations

Get only.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_NICKNAME   107

The nickname of the contact. Single string.

Valid values

MA_PIM_TYPE_STRING.

Operations

Add, Set and Get.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_NOTE   108

Supplementary information, or a comment. Multiple string.

Valid values

MA_PIM_TYPE_STRING.

Operations

Add, Set and Get.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_ORG   109

The organization name of the contact. Multiple string.

Valid values

MA_PIM_TYPE_STRING.

Operations

Add, Set and Get.

Attributes

MA_PIM_ATTR_ORG_WORK, MA_PIM_ATTR_ORG_OTHER, MA_PIM_ATTR_ORG_CUSTOM.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_PHOTO   110

The contact's photo. A single int representing a data handle. Connected with PHOTO_URL.

Valid values

MA_PIM_TYPE_INT.

Operations

Add, Set and Get.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_PHOTO_URL   111

The contact's photo url. A single string representing the URL of a photo. Connected with PHOTO.

Valid values

MA_PIM_TYPE_STRING.

Operations

Set only.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_PUBLIC_KEY   112

The public key of the contact. Connected with PUBLIC_KEY_STRING.

Valid values

MA_PIM_TYPE_BINARY.

Operations

Add, Set and Get.

Supported Platforms

Symbian.

#define MA_PIM_FIELD_CONTACT_PUBLIC_KEY_STRING   113

A string representation of the contact's public key. Connected with PUBLIC_KEY.

Valid values

MA_PIM_TYPE_STRING.

Operations

Add, Set and Get.

Supported Platforms

Symbian.

#define MA_PIM_FIELD_CONTACT_REVISION   114

The revision date of the field. Single date.

Valid values

MA_PIM_TYPE_DATE.

Operations

Get only.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_TEL   115

The telephone numbers of the contact. Multiple strings.

Valid values

MA_PIM_TYPE_STRING.

Operations

Add, Set and Get.

Attributes

MA_PIM_ATTR_PHONE_HOME, MA_PIM_ATTR_PHONE_MOBILE, MA_PIM_ATTR_PHONE_HOME_FAX, MA_PIM_ATTR_PHONE_WORK_FAX, MA_PIM_ATTR_PHONE_PAGER, MA_PIM_ATTR_PHONE_IPHONE, MA_PIM_ATTR_PHONE_WORK, MA_PIM_ATTR_PHONE_CALLBACK, MA_PIM_ATTR_PHONE_CAR, MA_PIM_ATTR_PHONE_COMPANY_MAIN, MA_PIM_ATTR_PHONE_ISDN, MA_PIM_ATTR_PHONE_OTHER_FAX, MA_PIM_ATTR_PHONE_RADIO, MA_PIM_ATTR_PHONE_TELEX, MA_PIM_ATTR_PHONE_TTY_TDD, MA_PIM_ATTR_PHONE_WORK_MOBILE, MA_PIM_ATTR_PHONE_WORK_PAGER, MA_PIM_ATTR_PHONE_ASSISTANT, MA_PIM_ATTR_PHONE_MMS, MA_PIM_ATTR_PHONE_OTHER, MA_PIM_ATTR_PHONE_CUSTOM.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_TITLE   116

The professional title of the contact inside the organization. Multiple strings.

Valid values

MA_PIM_TYPE_STRING.

Operations

Add, Set and Get.

Attributes

MA_PIM_ATTR_TITLE_WORK, MA_PIM_ATTR_TITLE_OTHER, MA_PIM_ATTR_TITLE_CUSTOM.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_UID   117

The unique identifier of the contact on the current device. Single string.

Valid values

Single MA_PIM_TYPE_STRING.

Operations

Get only.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_URL   118

Uniform Resource Locators associated with the contact. Multiple strings.

Valid values

MA_PIM_TYPE_STRING.

Operations

Add, Set and Get.

Attributes

MA_PIM_ATTR_WEBSITE_HOMEPAGE, MA_PIM_ATTR_WEBSITE_BLOG, MA_PIM_ATTR_WEBSITE_PROFILE, MA_PIM_ATTR_WEBSITE_HOME, MA_PIM_ATTR_WEBSITE_WORK, MA_PIM_ATTR_WEBSITE_FTP, MA_PIM_ATTR_WEBSITE_OTHER, MA_PIM_ATTR_WEBSITE_CUSTOM.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_IM   119

The IM addresses of the contact. Multiple arrays. Has MA_PIM_CONTACT_IM indices.

Valid values

MA_PIM_TYPE_STRING_ARRAY.

Operations

Add, Set and Get.

Attributes

MA_PIM_ATTR_IM_HOME, MA_PIM_ATTR_IM_WORK, MA_PIM_ATTR_IM_OTHER, MA_PIM_ATTR_IM_CUSTOM.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_RELATION   120

A relation of the contact.

Valid values

MA_PIM_TYPE_STRING.

Operations

Add, Set and Get.

Attributes

MA_PIM_ATTR_RELATION_MOTHER, MA_PIM_ATTR_RELATION_FATHER, MA_PIM_ATTR_RELATION_PARENT, MA_PIM_ATTR_RELATION_SISTER, MA_PIM_ATTR_RELATION_BROTHER, MA_PIM_ATTR_RELATION_CHILD, MA_PIM_ATTR_RELATION_FRIEND, MA_PIM_ATTR_RELATION_SPOUSE, MA_PIM_ATTR_RELATION_PARTNER, MA_PIM_ATTR_RELATION_MANAGER, MA_PIM_ATTR_RELATION_ASSISTANT, MA_PIM_ATTR_RELATION_DOMESTIC_PARTNER, MA_PIM_ATTR_RELATION_REFERRED_BY, MA_PIM_ATTR_RELATION_RELATIVE, MA_PIM_ATTR_RELATION_CUSTOM.

Supported Platforms

Android, iOS.

#define MA_PIM_FIELD_CONTACT_ORG_INFO   121

Information about the organization. Has MA_PIM_CONTACT_ORG_INFO indices.

Valid values

MA_PIM_TYPE_STRING_ARRAY.

Operations

Add, Set and Get.

Attributes

MA_PIM_ATTR_ORG_INFO_WORK, MA_PIM_ATTR_ORG_INFO_OTHER, MA_PIM_ATTR_ORG_INFO_CUSTOM.

Supported Platforms

Android, iOS.

#define MA_PIM_CONTACT_ADDR_POBOX   0

Index for MA_PIM_FIELD_CONTACT_ADDR. Post office box number.

#define MA_PIM_CONTACT_ADDR_EXTRA   1

Index for MA_PIM_FIELD_CONTACT_ADDR. Extra info.

#define MA_PIM_CONTACT_ADDR_STREET   2

Index for MA_PIM_FIELD_CONTACT_ADDR. Street name and number.

#define MA_PIM_CONTACT_ADDR_LOCALITY   3

Index for MA_PIM_FIELD_CONTACT_ADDR. Locality name. (ex. city)

#define MA_PIM_CONTACT_ADDR_REGION   4

Index for MA_PIM_FIELD_CONTACT_ADDR. Region name. (ex. province, state or territory)

#define MA_PIM_CONTACT_ADDR_POSTALCODE   5

Index for MA_PIM_FIELD_CONTACT_ADDR. Postal code.

#define MA_PIM_CONTACT_ADDR_COUNTRY   6

Index for MA_PIM_FIELD_CONTACT_ADDR. Country name.

#define MA_PIM_CONTACT_ADDR_NEIGHBORHOOD   7

Index for MA_PIM_FIELD_CONTACT_ADDR. Neighborhood.

#define MA_PIM_CONTACT_NAME_FAMILY   0

Index for MA_PIM_FIELD_CONTACT_NAME. Family name.

#define MA_PIM_CONTACT_NAME_GIVEN   1

Index for MA_PIM_FIELD_CONTACT_NAME. Given name.

#define MA_PIM_CONTACT_NAME_OTHER   2

Index for MA_PIM_FIELD_CONTACT_NAME. Alternate/secondary names, if any.

#define MA_PIM_CONTACT_NAME_PREFIX   3

Index for MA_PIM_FIELD_CONTACT_NAME. Prefix. (ex. "Dr.")

#define MA_PIM_CONTACT_NAME_SUFFIX   4

Index for MA_PIM_FIELD_CONTACT_NAME. Suffix. (ex. "M.D.")

#define MA_PIM_CONTACT_NAME_PHONETIC_FAMILY   5

Index for MA_PIM_FIELD_CONTACT_NAME. Phonetic last name.

#define MA_PIM_CONTACT_NAME_PHONETIC_GIVEN   6

Index for MA_PIM_FIELD_CONTACT_NAME. Phonetic first name.

#define MA_PIM_CONTACT_NAME_PHONETIC_OTHER   7

Index for MA_PIM_FIELD_CONTACT_NAME. Phonetic middle name.

#define MA_PIM_CONTACT_NAME_DISPLAY   8

Index for MA_PIM_FIELD_CONTACT_NAME. Display name.

#define MA_PIM_CONTACT_ORG_INFO_DEPARTMENT   0

MA_PIM_TYPE_STRING. Only for Android and iOS devices.

#define MA_PIM_CONTACT_ORG_INFO_JOB_DESCRIPTION   1

MA_PIM_TYPE_STRING. Only for Android devices.

#define MA_PIM_CONTACT_ORG_INFO_SYMBOL   2

MA_PIM_TYPE_STRING. Only for Android devices.

#define MA_PIM_CONTACT_ORG_INFO_PHONETIC_NAME   3

MA_PIM_TYPE_STRING. Only for Android devices.

#define MA_PIM_CONTACT_ORG_INFO_OFFICE_LOCATION   4

MA_PIM_TYPE_STRING. Only for Android devices.

#define MA_PIM_CONTACT_ORG_INFO_PHONETIC_NAME_STYLE   5

MA_PIM_TYPE_STRING. Only for Android devices.

#define MA_PIM_CONTACT_IM_USERNAME   0

MA_PIM_TYPE_STRING.

#define MA_PIM_CONTACT_IM_PROTOCOL   1

MA_PIM_TYPE_STRING.

#define MA_PIM_CONTACT_CLASS_CONFIDENTIAL   200

Value for MA_PIM_FIELD_CONTACT_CLASS.

#define MA_PIM_CONTACT_CLASS_PRIVATE   201

Value for MA_PIM_FIELD_CONTACT_CLASS.

#define MA_PIM_CONTACT_CLASS_PUBLIC   202

Value for MA_PIM_FIELD_CONTACT_CLASS.

#define MA_PIM_CONTACT_IM_PROTOCOL_AIM   "AIM"

This constant describes an AIM protocol.

#define MA_PIM_CONTACT_IM_PROTOCOL_MSN   "MSN"

This constant describes a MSN protocol.

#define MA_PIM_CONTACT_IM_PROTOCOL_YAHOO   "Yahoo"

This constant describes a Yahoo protocol.

#define MA_PIM_CONTACT_IM_PROTOCOL_SKYPE   "Skype"

This constant describes a Skype protocol.

#define MA_PIM_CONTACT_IM_PROTOCOL_QQ   "QQ"

This constant describes a QQ protocol.

#define MA_PIM_CONTACT_IM_PROTOCOL_GOOGLE_TALK   "GoogleTalk"

This constant describes a Google Talk protocol.

#define MA_PIM_CONTACT_IM_PROTOCOL_ICQ   "ICQ"

This constant describes an ICQ protocol.

#define MA_PIM_CONTACT_IM_PROTOCOL_JABBER   "Jabber"

This constant describes a Jabber protocol.

#define MA_PIM_CONTACT_IM_PROTOCOL_NETMEETING   "Netmeeting"

This constant describes a NetMeeting protocol.

#define MA_PIM_ATTR_ASST   1

The value describes an assistant.

#define MA_PIM_ATTR_AUTO   2

Unknown.

#define MA_PIM_ATTR_FAX   4

The value describes a fax number.

#define MA_PIM_ATTR_HOME   8

The value describes a home phone number.

#define MA_PIM_ATTR_MOBILE   16

The value describes a mobile phone number.

#define MA_PIM_ATTR_OTHER   32

Unknown.

#define MA_PIM_ATTR_PAGER   64

The value describes a pager number.

#define MA_PIM_ATTR_PREFERRED   128

In a field with multiple values, this one is preferred before the others. Only one value per field may be marked PREFERRED. Marking a value PREFERRED causes any other PREFERRED value in the field to become unmarked.

#define MA_PIM_ATTR_SMS   256

The value describes an SMS number?

#define MA_PIM_ATTR_WORK   512

The value describes a work phone number.

#define MA_PIM_ATTR_ADDR_HOME   101

The constant describes a home address.

#define MA_PIM_ATTR_ADDR_WORK   102

The constant describes a work address.

#define MA_PIM_ATTR_ADDR_OTHER   103

The constant describes a different address type.

#define MA_PIM_ATTR_ADDR_CUSTOM   104

The constant describes a custom address type. The field's label can be set.

#define MA_PIM_ATTR_EMAIL_HOME   201

The constant describes a home e-mail address.

#define MA_PIM_ATTR_EMAIL_WORK   202

The constant describes a work e-mail address.

#define MA_PIM_ATTR_EMAIL_MOBILE   203

The constant describes a mobile e-mail address.

#define MA_PIM_ATTR_EMAIL_OTHER   204

The constant describes a different e-mail address type.

#define MA_PIM_ATTR_EMAIL_CUSTOM   205

The constant describes a custom e-mail address type. The field's label can be set.

#define MA_PIM_ATTR_FORMATTED_ADDR_HOME   301

The constant describes a home formatted address.

#define MA_PIM_ATTR_FORMATTED_ADDR_WORK   302

The constant describes a work formatted address.

#define MA_PIM_ATTR_FORMATTED_ADDR_OTHER   303

The constant describes a different formatted address type.

#define MA_PIM_ATTR_FORMATTED_ADDR_CUSTOM   304

The constant describes a custom formatted address type. The field's label can be set.

#define MA_PIM_ATTR_ORG_WORK   401

The constant describes a work organization.

#define MA_PIM_ATTR_ORG_OTHER   402

The constant describes a different organization type.

#define MA_PIM_ATTR_ORG_CUSTOM   403

The constant describes a custom organization type. The field's label can be set.

#define MA_PIM_ATTR_PHONE_HOME   501

The constant describes a home phone number.

#define MA_PIM_ATTR_PHONE_MOBILE   502

The constant describes a mobile phone number.

#define MA_PIM_ATTR_PHONE_HOME_FAX   503

The constant describes a home fax phone number.

#define MA_PIM_ATTR_PHONE_WORK_FAX   504

The constant describes a work fax phone number.

#define MA_PIM_ATTR_PHONE_PAGER   505

The constant describes a pager phone number.

#define MA_PIM_ATTR_PHONE_IPHONE   506

The constant describes an iPhone phone number.

#define MA_PIM_ATTR_PHONE_WORK   507

The constant describes a work phone number.

#define MA_PIM_ATTR_PHONE_CALLBACK   508

The constant describes a callback phone number.

#define MA_PIM_ATTR_PHONE_CAR   509

The constant describes a car phone number.

#define MA_PIM_ATTR_PHONE_COMPANY_MAIN   510

The constant describes a company main phone number.

#define MA_PIM_ATTR_PHONE_ISDN   511

The constant describes a ISDN phone number.

#define MA_PIM_ATTR_PHONE_OTHER_FAX   512

The constant describes a other fax type phone number.

#define MA_PIM_ATTR_PHONE_RADIO   513

The constant describes a radio phone number.

#define MA_PIM_ATTR_PHONE_TELEX   514

The constant describes a telex phone number.

#define MA_PIM_ATTR_PHONE_TTY_TDD   515

The constant describes a TTY TDD phone number.

#define MA_PIM_ATTR_PHONE_WORK_MOBILE   516

The constant describes a work mobile phone number.

#define MA_PIM_ATTR_PHONE_WORK_PAGER   517

The constant describes a work pager phone number.

#define MA_PIM_ATTR_PHONE_ASSISTANT   518

The constant describes an assistant phone number.

#define MA_PIM_ATTR_PHONE_MMS   519

The constant describes a MMS phone number.

#define MA_PIM_ATTR_PHONE_OTHER   520

The constant describes a different phone number type.

#define MA_PIM_ATTR_PHONE_CUSTOM   521

The constant describes a custom phone number type. The field's label can be set.

#define MA_PIM_ATTR_TITLE_WORK   601

The constant describes a work title. Not available on iOS.

#define MA_PIM_ATTR_TITLE_OTHER   602

The constant describes a different title type. Not available on iOS.

#define MA_PIM_ATTR_TITLE_CUSTOM   603

The constant describes a custom title type. The field's label can be set. Not available on iOS.

#define MA_PIM_ATTR_WEBSITE_HOMEPAGE   701

The constant describes a homepage website.

#define MA_PIM_ATTR_WEBSITE_BLOG   702

The constant describes a blog website.

#define MA_PIM_ATTR_WEBSITE_PROFILE   703

The constant describes a profile website.

#define MA_PIM_ATTR_WEBSITE_HOME   704

The constant describes a home website.

#define MA_PIM_ATTR_WEBSITE_WORK   705

The constant describes a work website.

#define MA_PIM_ATTR_WEBSITE_FTP   706

The constant describes a FTP website.

#define MA_PIM_ATTR_WEBSITE_OTHER   707

The constant describes a different website type.

#define MA_PIM_ATTR_WEBSITE_CUSTOM   708

The constant describes a custom website type. The field's label can be set.

#define MA_PIM_ATTR_IM_HOME   801

The constant describes a home IM address.

#define MA_PIM_ATTR_IM_WORK   802

The constant describes a work IM address.

#define MA_PIM_ATTR_IM_OTHER   803

The constant describes a different IM address type.

#define MA_PIM_ATTR_IM_CUSTOM   804

The constant describes a custom IM address type. The field's label can be set.

#define MA_PIM_ATTR_RELATION_MOTHER   901

The constant describes a mother relation.

#define MA_PIM_ATTR_RELATION_FATHER   902

The constant describes a father relation.

#define MA_PIM_ATTR_RELATION_PARENT   903

The constant describes a parent relation.

#define MA_PIM_ATTR_RELATION_SISTER   904

The constant describes a sister relation.

#define MA_PIM_ATTR_RELATION_BROTHER   905

The constant describes a brother relation.

#define MA_PIM_ATTR_RELATION_CHILD   906

The constant describes a child relation.

#define MA_PIM_ATTR_RELATION_FRIEND   907

The constant describes a friend relation.

#define MA_PIM_ATTR_RELATION_SPOUSE   908

The constant describes a spouse relation.

#define MA_PIM_ATTR_RELATION_PARTNER   909

The constant describes a partner relation.

#define MA_PIM_ATTR_RELATION_MANAGER   910

The constant describes a manager relation.

#define MA_PIM_ATTR_RELATION_ASSISTANT   911

The constant describes a assistant relation.

#define MA_PIM_ATTR_RELATION_DOMESTIC_PARTNER   912

The constant describes a domestic partner relation.

#define MA_PIM_ATTR_RELATION_REFERRED_BY   913

The constant describes a referred by relation.

#define MA_PIM_ATTR_RELATION_RELATIVE   914

The constant describes a relative relation.

#define MA_PIM_ATTR_RELATION_CUSTOM   915

The constant describes a custom relation type. The field's label can be set. Not available on iOS.

#define MA_PIM_ATTR_ORG_INFO_WORK   1001

The constant describes a work organization. Not available on iOS.

#define MA_PIM_ATTR_ORG_INFO_OTHER   1002

The constant describes a different organization type. Not available on iOS.

#define MA_PIM_ATTR_ORG_INFO_CUSTOM   1003

The constant describes a custom organization type. The field's label can be set. Not available on iOS.

#define MA_PIM_ATTRPREFERRED   0x10000

The constant describes a preferred field.

#define MA_PIM_ERR_NONE   0

No error. The operation completed successfully.

#define MA_PIM_ERR_UNAVAILABLE   -1

This function is unavailable on the current platform.

#define MA_PIM_ERR_NATIVE_TYPE_MISMATCH   -2

The native database's data type for the given field did not match the MoSync API.

#define MA_PIM_ERR_LIST_TYPE_INVALID   -3

The specified list type is invalid.

#define MA_PIM_ERR_LIST_UNAVAILABLE   -4

The specified pim list is not available on the current platform.

#define MA_PIM_ERR_LIST_ALREADY_OPENED   -5

The specified list is already opened.

#define MA_PIM_ERR_FIELD_INVALID   -6

The specified field is invalid.

#define MA_PIM_ERR_FIELD_UNSUPPORTED   -7

The field type is not supported.

#define MA_PIM_ERR_FIELD_EMPTY   -8

The requested field doesn't have a value.

#define MA_PIM_ERR_FIELD_COUNT_MAX   -9

More values in this field are not supported.

#define MA_PIM_ERR_FIELD_READ_ONLY   -10

The field is read-only.

#define MA_PIM_ERR_FIELD_WRITE_ONLY   -11

The field is write-only.

#define MA_PIM_ERR_INDEX_INVALID   -12

The given index is not valid.

#define MA_PIM_ERR_HANDLE_INVALID   -13

Invalid handle.

#define MA_PIM_ERR_ATTRIBUTE_COMBO_UNSUPPORTED   -14

The field/attribute combination is not supported.

#define MA_PIM_ERR_ATTRIBUTE_CUSTOM   -15

The values's attribute is not set to custom.

#define MA_PIM_ERR_BUFFER_INVALID   -16

Invalid buffer structure.

#define MA_PIM_ERR_NO_LABEL   -17

The value does not have a custom label.

#define MA_PIM_ERR_OPERATION_NOT_PERMITTED   -18

The operation is not allowed by the Address Book database.