Address Book Objective-C Constants Reference

Overview

Constants

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.

NSString * const kABHomePageLabel;
NSString * const kABEmailWorkLabel;
NSString * const kABEmailHomeLabel;
NSString * const kABEmailMobileMeLabel;
NSString * const kABAddressHomeLabel;
NSString * const kABAddressWorkLabel;
NSString * const kABAnniversaryLabel;
NSString * const kABFatherLabel;
NSString * const kABMotherLabel;
NSString * const kABParentLabel;
NSString * const kABBrotherLabel;
NSString * const kABSisterLabel;
NSString * const kABChildLabel;
NSString * const kABFriendLabel;
NSString * const kABSpouseLabel;
NSString * const kABPartnerLabel;
NSString * const kABAssistantLabel;
NSString * const kABManagerLabel;
NSString * const kABPhoneWorkLabel;
NSString * const kABPhoneHomeLabel;
NSString * const kABPhoneiPhoneLabel;
NSString * const kABPhoneMobileLabel;
NSString * const kABPhoneMainLabel;
NSString * const kABPhoneHomeFAXLabel;
NSString * const kABPhoneWorkFAXLabel;
NSString * const kABPhonePagerLabel;
NSString * const kABAIMWorkLabel;
NSString * const kABAIMHomeLabel;
NSString * const kABAIMMobileMeLabel;
NSString * const kABJabberWorkLabel;
NSString * const kABJabberHomeLabel;
NSString * const kABMSNWorkLabel;
NSString * const kABMSNHomeLabel;
NSString * const kABYahooWorkLabel;
NSString * const kABYahooHomeLabel;
NSString * const kABICQWorkLabel;
NSString * const kABICQHomeLabel;

Constants

kABHomePageLabel

Webpage URL.

Available in Mac OS X v10.4 and later.

Declared in ABGlobals.h.

kABEmailWorkLabel

Work email.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABEmailHomeLabel

Home email.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABEmailMobileMeLabel

Mobile Me email.

Available in Mac OS X v10.6 and later.

Declared in ABGlobals.h.

kABAddressHomeLabel

Home address.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABAddressWorkLabel

Work address.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABAnniversaryLabel

Anniversary date.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABFatherLabel

Father.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABMotherLabel

Mother.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABParentLabel

Parent.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABBrotherLabel

Brother.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABSisterLabel

Sister.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABChildLabel

Child.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABFriendLabel

Friend.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABSpouseLabel

Spouse.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABPartnerLabel

Partner.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABAssistantLabel

Assistant.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABManagerLabel

Manager.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABPhoneWorkLabel

Work phone number.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABPhoneHomeLabel

Home phone number.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABPhoneiPhoneLabel

iPhone phone number.

Available in Mac OS X v10.6 and later.

Declared in ABGlobals.h.

kABPhoneMobileLabel

Cell phone number.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABPhoneMainLabel

Main phone number.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABPhoneHomeFAXLabel

Home fax number.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABPhoneWorkFAXLabel

Work fax number.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABPhonePagerLabel

Pager number.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABAIMWorkLabel

Work AOL instant messaging ID.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABAIMHomeLabel

Home AOL instant messaging ID.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABAIMMobileMeLabel

Mobile Me AOL instant messaging ID.

Available in Mac OS X v10.6 and later.

Declared in ABGlobals.h.

kABJabberWorkLabel

Work Jabber instant messaging ID.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABJabberHomeLabel

Home Jabber instant messaging ID.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABMSNWorkLabel

Work MSN instant messaging ID.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABMSNHomeLabel

Home MSN instant messaging ID.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABYahooWorkLabel

Work Yahoo instant messaging ID.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABYahooHomeLabel

Home Yahoo instant messaging ID.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABICQWorkLabel

Work ICQ instant messaging ID.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABICQHomeLabel

Home ICQ instant messaging ID.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

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.

NSString * const kABWorkLabel;
NSString * const kABHomeLabel;
NSString * const kABOtherLabel;

Constants

kABWorkLabel

All Work labels match this label.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABHomeLabel

All Home labels match this label.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABOtherLabel

All labels other than Home or Work labels match this label.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

Default Record Properties

Properties common to all types of records.

NSString * const kABUIDProperty;
NSString * const kABCreationDateProperty;
NSString * const kABModificationDateProperty;

Constants

kABUIDProperty

The unique ID for this record. It’s guaranteed never to change, no matter how much the record changes. If you need to store a reference to a record, use this value. Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABCreationDateProperty

The date when the record was first saved. Type: kABDateProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABModificationDateProperty

The date when the record was last saved. Type: kABDateProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

Default Group Properties

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

NSString * const kABGroupNameProperty;

Constants

kABGroupNameProperty

Name of the group

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

Default Person Properties

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

NSString * const kABFirstNameProperty;
NSString * const kABLastNameProperty;
NSString * const kABFirstNamePhoneticProperty;
NSString * const kABLastNamePhoneticProperty;
NSString * const kABNicknameProperty;
NSString * const kABMaidenNameProperty;
NSString * const kABBirthdayProperty;
NSString * const kABOrganizationProperty;
NSString * const kABJobTitleProperty;
NSString * const kABHomePageProperty;
NSString * const kABURLsProperty;
NSString * const kABCalendarURIsProperty;
NSString * const kABEmailProperty;
NSString * const kABAddressProperty;
NSString * const kABOtherDatesProperty;
NSString * const kABRelatedNamesProperty;
NSString * const kABDepartmentProperty;
NSString * const kABPersonFlags;
NSString * const kABPhoneProperty;
NSString * const kABAIMInstantProperty;
NSString * const kABJabberInstantProperty;
NSString * const kABMSNInstantProperty;
NSString * const kABYahooInstantProperty;
NSString * const kABICQInstantProperty;
NSString * const kABNoteProperty;
NSString * const kABMiddleNameProperty;
NSString * const kABMiddleNamePhoneticProperty;
NSString * const kABTitleProperty;
NSString * const kABSuffixProperty;
NSString * const kABMiddleNameProperty;
NSString * const kABMiddleNamePhoneticProperty;
NSString * const kABTitleProperty;
NSString * const kABSuffixProperty;
   

Constants

kABFirstNameProperty

First name. Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABLastNameProperty

Last name. Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABFirstNamePhoneticProperty

Phonetic representation of the first name. Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABLastNamePhoneticProperty

Phonetic representation of the last name. Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABNicknameProperty

Nickname. Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABMaidenNameProperty

Maiden name. Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABBirthdayProperty

Birth date. Type: kABDateProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABOrganizationProperty

Company name. Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABJobTitleProperty

Job title. Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABHomePageProperty

Home web page. Type: kABStringProperty. (Deprecated. Use kABURLsProperty instead.)

The kABHomePageProperty property has been deprecated in Mac OS X version 10.4. Instead, use the kABURLsProperty multivalue property with the label kABHomePageLabel.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABURLsProperty

Web pages. Type: kABMultiStringProperty.

Available in Mac OS X v10.4 and later.

Declared in ABGlobals.h.

kABCalendarURIsProperty

Calendar URIs. Type: kABMultiStringProperty.

Available in Mac OS X v10.5 and later.

Declared in ABGlobals.h.

kABEmailProperty

Email addresses. Type: kABMultiStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABAddressProperty

Street addresses. Type: kABMultiDictionaryProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABOtherDatesProperty

Dates associated with a person. Type: kABMultiDateProperty.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABRelatedNamesProperty

Names of people related to a person. Type: kABMultiStringProperty.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABDepartmentProperty

Department name. Type: kABStringProperty.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABPersonFlags

Property that specifies the name ordering and configuration of a record in the Address Book application. See “Person Flags” in ABPerson Class Reference.

Available in Mac OS X v10.3 and later.

Declared in ABGlobals.h.

kABPhoneProperty

Generic phone number. Type: kABMultiStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABAIMInstantProperty

AOL instant messaging ID. Type: kABMultiStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABJabberInstantProperty

Jabber instant messaging ID. Type: kABMultiStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABMSNInstantProperty

MSN instant messaging ID. Type: kABMultiStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABYahooInstantProperty

Yahoo instant messaging ID. Type: kABMultiStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABICQInstantProperty

ICQ instant messaging ID. Type: kABMultiStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABNoteProperty

Notes. Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABMiddleNameProperty

Middle name. Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABMiddleNamePhoneticProperty

Phonetic representation of the middle name. Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABTitleProperty

Title, such as “Mr.,” “Mrs.,” “General,” “Cardinal,” or “Lord.” Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABSuffixProperty

Suffix, such as “Sr.,” “Jr.,” “III.,” or “Esq.” Type: kABStringProperty.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

Multivalue Property

A multivalue property type.

#define kABMultiValueMask 0x100

Constants

kABMultiValueMask

Used by ABPropertyType to specify a multivalue property.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

Property Types

The possible ABPropertyType types for ABRecord properties:

enum _ABPropertyType {
kABErrorInProperty           = 0x0,
kABStringProperty            = 0x1,
kABIntegerProperty           = 0x2,
kABRealProperty              = 0x3,
kABDateProperty              = 0x4,
kABArrayProperty             = 0x5,
kABDictionaryProperty        = 0x6,
kABDataProperty              = 0x7,
kABMultiStringProperty       = kABMultiValueMask | kABStringProperty,
kABMultiIntegerProperty      = kABMultiValueMask | kABIntegerProperty,
kABMultiRealProperty         = kABMultiValueMask | kABRealProperty,
kABMultiDateProperty         = kABMultiValueMask | kABDateProperty,
kABMultiArrayProperty        = kABMultiValueMask | kABArrayProperty,
kABMultiDictionaryProperty   = kABMultiValueMask | kABDictionaryProperty,
kABMultiDataProperty         = kABMultiValueMask | kABDataProperty
};

Constants

kABErrorInProperty

An invalid property was used.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABStringProperty

This property is an NSString object.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABIntegerProperty

This property is an NSNumber object representing an integer.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABRealProperty

This property is an NSNumber object representing a real number.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABDateProperty

This property is an NSDate object.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABArrayProperty

This property is an NSArray object.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABDictionaryProperty

This property is an NSDictionary object.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABDataProperty

This property is an NSData object.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABMultiStringProperty

This property is an ABMultiValue object containing NSString objects.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABMultiIntegerProperty

This property is an ABMultiValue object containing NSNumber objects representing integers.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABMultiRealProperty

This property is an ABMultiValue object containing NSNumber objects representing real numbers.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABMultiDateProperty

This property is an ABMultiValue object containing NSDate objects.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABMultiArrayProperty

This property is an ABMultiValue object containing NSArray objects.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABMultiDictionaryProperty

This property is an ABMultiValue object containing NSDictionary objects.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

kABMultiDataProperty

This property is an ABMultiValue object containing NSData objects.

Available in Mac OS X v10.2 and later.

Declared in ABTypedefs.h.

Address Keys

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

NSString * const kABAddressStreetKey;
NSString * const kABAddressCityKey;
NSString * const kABAddressStateKey;
NSString * const kABAddressZIPKey;
NSString * const kABAddressCountryKey;
NSString * const kABAddressCountryCodeKey;

Constants

kABAddressStreetKey

Street.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABAddressCityKey

City.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABAddressStateKey

State.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABAddressZIPKey

Zip.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABAddressCountryKey

Country, identified by ISO country code. For a list of these codes, see Country Codes.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

kABAddressCountryCodeKey

Country Code.

Available in Mac OS X v10.2 and later.

Declared in ABGlobals.h.

---