Address Book Constants

Get the constants you use to specify Address Book information.

Topics

Data Type Constants

Address Keys

The keys used to specify the different fields in a kABAddressProperty. Neither developers nor users can add more keys.

Default Person Properties

The properties that a person record contains by default. Developers can add their own properties with the ABPerson method addPropertiesAndTypes:.

Default Group Properties

The properties that a group record contains by default. Developers can add their own properties with the ABGroup method addPropertiesAndTypes:

Default Multivalue List Labels

The default labels contained in the Address Book database for specifying different values in a multivalue list. Users can also add their own labels.

Generic Multivalue List Labels

The generic labels contained in the Address Book database for specifying different values in a multivalue list. These labels are especially useful if there is no default label for a property. Users can also add their own labels.

Multivalue Property

A multivalue property type.

Default Record Properties

Properties common to all types of records.

Property Types

The possible ABPropertyType types for ABRecord properties:

Social Media Constants

Instant Messaging Keys

The keys used to specify the different fields in a kABInstantMessageProperty property. Neither developers nor users can add more keys.

Instant Messaging Services

The predefined constants are used to identify instant messaging services. You may use these constants or any other string.

Social Profile Services

The predefined constants are used to identify social networking services. You may use these constants or any other string.

Errors

ABAddressBookErrorDomain

Error domain returning errors reported by an address book object.

Error Codes

Errors codes used by the Address Book framework.

Miscellaneous

ABPeoplePickerDisplayedPropertyDidChangeNotification

Posted when the displayed property in the record list is changed.

ABPeoplePickerGroupSelectionDidChangeNotification

Posted when the selection in the group list is changed.

ABPeoplePickerNameSelectionDidChangeNotification

Posted when the selection in the name list is changed.

ABPeoplePickerValueSelectionDidChangeNotification

Posted when the selection in a multivalue property is changed.

kABDatabaseChangedExternallyNotification

Posted when a process other than the current one has changed the Address Book database.

kABDatabaseChangedNotification

Posted when this process has changed the Address Book database.

kABDefaultNameOrdering

Default name ordering (whether a person’s first name or last name is displayed first) in the Address Book application.

kABDeletedRecords

Records that have been deleted.

kABFirstNameFirst

First name is displayed first in Address Book.

kABInsertedRecords

Records that have been inserted.

kABLastNameFirst

Last name is displayed first in Address Book.

kABMultiValueInvalidIdentifier

Invalid multivalue property.

kABNameOrderingMask

Used in conjunction with kABDefaultNameOrdering, kABFirstNameFirst, and kABLastNameFirst to determine name ordering.

kABPropertyInvalidID

Indicates an invalid value for a property ID.

kABRecordInvalidID

Records with this ID have not been saved to the Address Book database.

kABShowAsCompany

Record is displayed as a company.

kABShowAsMask

Used in conjunction with kABShowAsPerson and kABShowAsCompany to determine record configuration.

kABShowAsPerson

Record is displayed as a person.

kABShowAsResource

Record is displayed as a resource.

kABShowAsRoom

Record is displayed as a room.

kABSourceTypeSearchableMask

Indicates that a source is searchable.

kABUpdatedRecords

Records that have been updated.

Deprecated

kABPersonAddressCountryCodeKey

Country code. The value is an ISO country code.

Deprecated
kABPersonAddressCountryKey

Country.

Deprecated
kABPersonAddressProperty

Identifier for the address multivalue property.

Deprecated
kABPersonAddressStateKey

State.

Deprecated
kABPersonAddressStreetKey

Street.

Deprecated
kABPersonAddressZIPKey

Zip code.

Deprecated
kABPersonAlternateBirthdayCalendarIdentifierKey

The associated value is a string representing the calendar identifier for a CFCalendarRef. Corresponds to calendar.

Deprecated
kABPersonAlternateBirthdayDayKey

The associated value is a CFNumberRef of type kCFNumberNSIntegerType whose value is the day for the birthday. Corresponds to day.

Deprecated
kABPersonAlternateBirthdayEraKey

The associated value is a CFNumberRef of type kCFNumberNSIntegerType whose value is the era for the birthday. Corresponds to era.

Deprecated
kABPersonAlternateBirthdayIsLeapMonthKey

The associated value is a CFNumberRef of type kCFNumberCharType—used to represent a boolean—whose value is YES if the birthday occurred during a leap month, NO otherwise. Corresponds to leapMonth.

Deprecated
kABPersonAlternateBirthdayMonthKey

The associated value is a CFNumberRef of type kCFNumberNSIntegerType whose value is the month for the birthday. Corresponds to month.

Deprecated
kABPersonAlternateBirthdayProperty

The associated value is a kABDictionaryPropertyType with keys specified by the other constants listed here. You can use toll-free bridging to cast the value to NSDictionary. The data corresponds to an NSDateComponents object.

Deprecated
kABPersonAlternateBirthdayYearKey

The associated value is a CFNumberRef of type kCFNumberNSIntegerType whose value is the year for the birthday. Corresponds to year.

Deprecated
kABPersonAnniversaryLabel

Birthdate.

Deprecated
kABPersonAssistantLabel

Assistant.

Deprecated
kABPersonBrotherLabel

Brother.

Deprecated
kABPersonChildLabel

Child.

Deprecated
kABPersonDateProperty

Identifier for the dates multivalue property.

Deprecated
kABPersonEmailProperty

Email address. Type: kABMultiStringPropertyType.

Deprecated
kABPersonFatherLabel

Father.

Deprecated
kABPersonFirstNamePhoneticProperty

First name phonetic. Type: kABStringPropertyType.

Deprecated
kABPersonFriendLabel

Friend.

Deprecated
kABPersonHomePageLabel

Home page.

Deprecated
kABPersonImageFormatOriginalSize

The image at its original size and shape.

Deprecated
kABPersonImageFormatThumbnail

The small square thumbnail.

Deprecated
kABPersonInstantMessageProperty

Identifier for the instant message multivalue property.

Deprecated
kABPersonInstantMessageServiceAIM

AIM instant message service.

Deprecated
kABPersonInstantMessageServiceFacebook

Facebook instant message service.

Deprecated
kABPersonInstantMessageServiceGaduGadu

Gadu-Gadu instant message service.

Deprecated
kABPersonInstantMessageServiceGoogleTalk

Google Talk instant message service.

Deprecated
kABPersonInstantMessageServiceICQ

ICQ instant message service.

Deprecated
kABPersonInstantMessageServiceJabber

Jabber instant message service.

Deprecated
kABPersonInstantMessageServiceKey

Instant message service.

Deprecated
kABPersonInstantMessageServiceMSN

MSN instant message service.

Deprecated
kABPersonInstantMessageServiceQQ

QQ instant message service.

Deprecated
kABPersonInstantMessageServiceSkype

Skype instant message service.

Deprecated
kABPersonInstantMessageServiceYahoo

Yahoo instant message service.

Deprecated
kABPersonInstantMessageUsernameKey

Instant message service username.

Deprecated
kABPersonKindOrganization

Identifies an organization.

Deprecated
kABPersonKindPerson

Identifies a person.

Deprecated
kABPersonKindProperty

Identifier for the type property.

Deprecated
kABPersonLastNamePhoneticProperty

Last name phonetic. Type: kABStringPropertyType.

Deprecated
kABPersonManagerLabel

Manager.

Deprecated
kABPersonMiddleNamePhoneticProperty

Middle name phonetic. Type: kABStringPropertyType.

Deprecated
kABPersonMotherLabel

Mother.

Deprecated
kABPersonOrganizationProperty

Organization name. Type: kABStringPropertyType.

Deprecated
kABPersonParentLabel

Parent.

Deprecated
kABPersonPartnerLabel

Partner.

Deprecated
kABPersonPhoneHomeFAXLabel

Home fax number.

Deprecated
kABPersonPhoneIPhoneLabel

iPhone number.

Deprecated
kABPersonPhoneMainLabel

Main phone number.

Deprecated
kABPersonPhoneMobileLabel

Mobile phone number.

Deprecated
kABPersonPhoneOtherFAXLabel

Other fax number.

Deprecated
kABPersonPhonePagerLabel

Pager phone number.

Deprecated
kABPersonPhoneProperty

Identifier for the phone number multivalue property.

Deprecated
kABPersonPhoneWorkFAXLabel

Work fax number.

Deprecated
kABPersonPrefixProperty

Prefix (“Sir,” “Duke,” “General”). Type: kABStringPropertyType.

Deprecated
kABPersonRelatedNamesProperty

Identifier for the related name multivalue property.

Deprecated
kABPersonSisterLabel

Sister.

Deprecated
kABPersonSocialProfileProperty

Identifier for the social profile property.

Deprecated
kABPersonSocialProfileServiceFacebook

Facebook social profile service.

Deprecated
kABPersonSocialProfileServiceFlickr

Flickr social profile service.

Deprecated
kABPersonSocialProfileServiceGameCenter

Game Center social profile service.

Deprecated
kABPersonSocialProfileServiceKey

Social profile service.

Deprecated
kABPersonSocialProfileServiceLinkedIn

LinkedIn social profile service.

Deprecated
kABPersonSocialProfileServiceMyspace

Myspace social profile service.

Deprecated
kABPersonSocialProfileServiceSinaWeibo

Sina Weibo social profile service.

Deprecated
kABPersonSocialProfileServiceTwitter

Twitter social profile service.

Deprecated
kABPersonSocialProfileURLKey

Social profile URL.

Deprecated
kABPersonSocialProfileUserIdentifierKey

Social profile user identifier.

Deprecated
kABPersonSocialProfileUsernameKey

Social profile username.

Deprecated
kABPersonSpouseLabel

Spouse.

Deprecated
kABPersonSuffixProperty

Suffix (“Jr.,” “Sr.,” “III”). Type: kABStringPropertyType.

Deprecated
kABPersonURLProperty

Identifier for the URL multivalue property.

Deprecated
kABSourceNameProperty

The name of the source. Type: kABStringPropertyType.

Deprecated
kABSourceTypeProperty

The type of the source. Type: ABSourceType

Deprecated

See Also

C Interfaces

C Types

Identify the C types that correspond to Address Book objects.

AddressBook Functions

Find the C functions and function-like macros you use to manipulate Address Book data.

AddressBook Enumerations

Get the enumerations you use to specify Address Book information.

AddressBook Data Types

Get the data types you use to specify Address Book information.