iOS Developer Library

Developer

Address Book Framework Reference for iOS ABPerson Reference

Options
Deployment Target:

On This Page
Language:

ABPerson Reference

Person records are represented by instances of the ABRecordRef opaque type, whose record type is kABPersonType. Person records store information about a person, such as first name, last name, address, email, and phone number.

Person records don’t necessarily have to be stored in the Address Book database. You can use person records as a way to group contact information in memory and present it to the user through, for example, a person view controller (ABPersonViewController).

Functions

Data Types

  • Indicates a person sort ordering.

    Declaration

    Swift

    typealias ABPersonSortOrdering = UInt32

    Objective-C

    typedef uint32_t ABPersonSortOrdering;

    Discussion

    See “Sort Order”.

    Import Statement

    Objective-C

    @import AddressBook;

    Swift

    import AddressBook

    Availability

    Available in iOS 2.0 and later.

    Deprecated in iOS 9.0.

  • Indicates a person-name display format.

    Declaration

    Swift

    typealias ABPersonCompositeNameFormat = UInt32

    Objective-C

    typedef uint32_t ABPersonCompositeNameFormat;

    Discussion

    See “Composite Name Format”.

    Import Statement

    Objective-C

    @import AddressBook;

    Swift

    import AddressBook

    Availability

    Available in iOS 2.0 and later.

    Deprecated in iOS 9.0.

  • Indicates an image format.

    Declaration

    Swift

    struct ABPersonImageFormat : RawRepresentable, Equatable { init(_ rawValue: UInt32) init(rawValue rawValue: UInt32) var rawValue: UInt32 }

    Objective-C

    typedef enum ABPersonImageFormat;

    Discussion

    See “Image Format”.

    Import Statement

    Objective-C

    @import AddressBook;

    Swift

    import AddressBook

    Availability

    Available in iOS 2.0 and later.

    Deprecated in iOS 9.0.

Constants

  • These constants identify sort order for person lists.

    Declaration

    Swift

    var kABPersonSortByFirstName: Int { get } var kABPersonSortByLastName: Int { get }

    Objective-C

    enum { kABPersonSortByFirstName = 0, kABPersonSortByLastName = 1 };

    Constants

    • kABPersonSortByFirstName

      kABPersonSortByFirstName

      Order by first name.

      Available in iOS 2.0 and later.

    • kABPersonSortByLastName

      kABPersonSortByLastName

      Order by last name.

      Available in iOS 2.0 and later.

  • These constants identify the format to use for a person’s composite name order for person records.

    Declaration

    Swift

    var kABPersonCompositeNameFormatFirstNameFirst: Int { get } var kABPersonCompositeNameFormatLastNameFirst: Int { get }

    Objective-C

    enum { kABPersonCompositeNameFormatFirstNameFirst = 0, kABPersonCompositeNameFormatLastNameFirst = 1 };

    Constants

    • kABPersonCompositeNameFormatFirstNameFirst

      kABPersonCompositeNameFormatFirstNameFirst

      First name first.

      Available in iOS 2.0 and later.

    • kABPersonCompositeNameFormatLastNameFirst

      kABPersonCompositeNameFormatLastNameFirst

      Last name first.

      Available in iOS 2.0 and later.

  • These constants identify the size and shape of images.

    Declaration

    Swift

    var kABPersonImageFormatThumbnail: ABPersonImageFormat { get } var kABPersonImageFormatOriginalSize: ABPersonImageFormat { get }

    Objective-C

    enum { kABPersonImageFormatThumbnail = 0, kABPersonImageFormatOriginalSize = 2 };

    Constants

    • kABPersonImageFormatThumbnail

      kABPersonImageFormatThumbnail

      The small square thumbnail.

      Available in iOS 4.1 and later.

    • kABPersonImageFormatOriginalSize

      kABPersonImageFormatOriginalSize

      The image at its original size and shape.

      Available in iOS 4.1 and later.

  • These constants identify person properties used to store personal information.

    Declaration

    Swift

    let kABPersonFirstNameProperty: ABPropertyID let kABPersonLastNameProperty: ABPropertyID let kABPersonMiddleNameProperty: ABPropertyID let kABPersonPrefixProperty: ABPropertyID let kABPersonSuffixProperty: ABPropertyID let kABPersonNicknameProperty: ABPropertyID let kABPersonFirstNamePhoneticProperty: ABPropertyID let kABPersonLastNamePhoneticProperty: ABPropertyID let kABPersonMiddleNamePhoneticProperty: ABPropertyID let kABPersonOrganizationProperty: ABPropertyID let kABPersonJobTitleProperty: ABPropertyID let kABPersonDepartmentProperty: ABPropertyID let kABPersonEmailProperty: ABPropertyID let kABPersonBirthdayProperty: ABPropertyID let kABPersonNoteProperty: ABPropertyID let kABPersonCreationDateProperty: ABPropertyID let kABPersonModificationDateProperty: ABPropertyID

    Objective-C

    const ABPropertyID kABPersonFirstNameProperty; const ABPropertyID kABPersonLastNameProperty; const ABPropertyID kABPersonMiddleNameProperty; const ABPropertyID kABPersonPrefixProperty; const ABPropertyID kABPersonSuffixProperty; const ABPropertyID kABPersonNicknameProperty; const ABPropertyID kABPersonFirstNamePhoneticProperty; const ABPropertyID kABPersonLastNamePhoneticProperty; const ABPropertyID kABPersonMiddleNamePhoneticProperty; const ABPropertyID kABPersonOrganizationProperty; const ABPropertyID kABPersonJobTitleProperty; const ABPropertyID kABPersonDepartmentProperty; const ABPropertyID kABPersonEmailProperty; const ABPropertyID kABPersonBirthdayProperty; const ABPropertyID kABPersonNoteProperty; const ABPropertyID kABPersonCreationDateProperty; const ABPropertyID kABPersonModificationDateProperty;

    Constants

    • kABPersonFirstNameProperty

      kABPersonFirstNameProperty

      First name. Type: kABStringPropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonLastNameProperty

      kABPersonLastNameProperty

      Last name. Type: kABStringPropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonMiddleNameProperty

      kABPersonMiddleNameProperty

      Middle name. Type: kABStringPropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonPrefixProperty

      kABPersonPrefixProperty

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

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonSuffixProperty

      kABPersonSuffixProperty

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

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonNicknameProperty

      kABPersonNicknameProperty

      Nickname. Type: kABStringPropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonFirstNamePhoneticProperty

      kABPersonFirstNamePhoneticProperty

      First name phonetic. Type: kABStringPropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonLastNamePhoneticProperty

      kABPersonLastNamePhoneticProperty

      Last name phonetic. Type: kABStringPropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonMiddleNamePhoneticProperty

      kABPersonMiddleNamePhoneticProperty

      Middle name phonetic. Type: kABStringPropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonOrganizationProperty

      kABPersonOrganizationProperty

      Organization name. Type: kABStringPropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonJobTitleProperty

      kABPersonJobTitleProperty

      Job title. Type: kABStringPropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonDepartmentProperty

      kABPersonDepartmentProperty

      Department. Type: kABStringPropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonEmailProperty

      kABPersonEmailProperty

      Email address. Type: kABMultiStringPropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonBirthdayProperty

      kABPersonBirthdayProperty

      Birthday. Type: kABDateTimePropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonNoteProperty

      kABPersonNoteProperty

      Note. Type: kABStringPropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonCreationDateProperty

      kABPersonCreationDateProperty

      Creation date. Type: kABDateTimePropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonModificationDateProperty

      kABPersonModificationDateProperty

      Modification date. Type: kABDateTimePropertyType.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

  • These constants implement the person address property (a multivalue property of type kABMultiDictionaryPropertyType) and the labels used to identify each of the property’s values.

    Declaration

    Swift

    let kABPersonAddressProperty: ABPropertyID let kABPersonAddressStreetKey: CFString! let kABPersonAddressCityKey: CFString! let kABPersonAddressStateKey: CFString! let kABPersonAddressZIPKey: CFString! let kABPersonAddressCountryKey: CFString! let kABPersonAddressCountryCodeKey: CFString!

    Objective-C

    const ABPropertyID kABPersonAddressProperty; const CFStringRef kABPersonAddressStreetKey; const CFStringRef kABPersonAddressCityKey; const CFStringRef kABPersonAddressStateKey; const CFStringRef kABPersonAddressZIPKey; const CFStringRef kABPersonAddressCountryKey; const CFStringRef kABPersonAddressCountryCodeKey;

    Constants

    • kABPersonAddressProperty

      kABPersonAddressProperty

      Identifier for the address multivalue property.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAddressStreetKey

      kABPersonAddressStreetKey

      Street.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAddressCityKey

      kABPersonAddressCityKey

      City.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAddressStateKey

      kABPersonAddressStateKey

      State.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAddressZIPKey

      kABPersonAddressZIPKey

      Zip code.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAddressCountryKey

      kABPersonAddressCountryKey

      Country.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAddressCountryCodeKey

      kABPersonAddressCountryCodeKey

      Country code. The value is an ISO country code.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

  • These constants implement the person dates property (a multivalue property of type kABMultiDateTimePropertyType) and the labels used to identify each of the property’s values.

    Declaration

    Swift

    let kABPersonDateProperty: ABPropertyID let kABPersonAnniversaryLabel: CFString!

    Objective-C

    const ABPropertyID kABPersonDateProperty; const CFStringRef kABPersonAnniversaryLabel;

    Constants

    • kABPersonDateProperty

      kABPersonDateProperty

      Identifier for the dates multivalue property.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAnniversaryLabel

      kABPersonAnniversaryLabel

      Birthdate.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

  • These constants implement the person type property (a property of type kABIntegerPropertyType), which indicates whether a person record represents a human being or an organization.

    Declaration

    Swift

    let kABPersonKindProperty: ABPropertyID let kABPersonKindPerson: CFNumber! let kABPersonKindOrganization: CFNumber!

    Objective-C

    const ABPropertyID kABPersonKindProperty; const CFNumberRef kABPersonKindPerson; const CFNumberRef kABPersonKindOrganization;

    Constants

    • kABPersonKindProperty

      kABPersonKindProperty

      Identifier for the type property.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonKindPerson

      kABPersonKindPerson

      Identifies a person.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonKindOrganization

      kABPersonKindOrganization

      Identifies an organization.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

  • These constants implement the person phone number property (a multivalue property of type kABMultiStringPropertyType) and the labels used to identify each of the property’s values.

    Declaration

    Swift

    let kABPersonPhoneProperty: ABPropertyID let kABPersonPhoneMobileLabel: CFString! let kABPersonPhoneIPhoneLabel: CFString! let kABPersonPhoneMainLabel: CFString! let kABPersonPhoneHomeFAXLabel: CFString! let kABPersonPhoneWorkFAXLabel: CFString! let kABPersonPhoneOtherFAXLabel: CFString! let kABPersonPhonePagerLabel: CFString!

    Objective-C

    const ABPropertyID kABPersonPhoneProperty; const CFStringRef kABPersonPhoneMobileLabel; const CFStringRef kABPersonPhoneIPhoneLabel; const CFStringRef kABPersonPhoneMainLabel; const CFStringRef kABPersonPhoneHomeFAXLabel; const CFStringRef kABPersonPhoneWorkFAXLabel; const CFStringRef kABPersonPhoneOtherFAXLabel; const CFStringRef kABPersonPhonePagerLabel;

    Constants

    • kABPersonPhoneProperty

      kABPersonPhoneProperty

      Identifier for the phone number multivalue property.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonPhoneMobileLabel

      kABPersonPhoneMobileLabel

      Mobile phone number.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonPhoneIPhoneLabel

      kABPersonPhoneIPhoneLabel

      iPhone number.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonPhoneMainLabel

      kABPersonPhoneMainLabel

      Main phone number.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonPhoneHomeFAXLabel

      kABPersonPhoneHomeFAXLabel

      Home fax number.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonPhoneWorkFAXLabel

      kABPersonPhoneWorkFAXLabel

      Work fax number.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonPhoneOtherFAXLabel

      kABPersonPhoneOtherFAXLabel

      Other fax number.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonPhonePagerLabel

      kABPersonPhonePagerLabel

      Pager phone number.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

  • The keys used to specify the different fields in a kABPersonInstantMessageProperty property (a multivalue property of type kABMultiDictionaryPropertyType). Neither developers nor users can add more keys.

    Declaration

    Swift

    let kABPersonInstantMessageProperty: ABPropertyID let kABPersonInstantMessageServiceKey: CFString! let kABPersonInstantMessageUsernameKey: CFString!

    Objective-C

    const ABPropertyID kABPersonInstantMessageProperty; const CFStringRef kABPersonInstantMessageServiceKey; const CFStringRef kABPersonInstantMessageUsernameKey;

    Constants

    • kABPersonInstantMessageProperty

      kABPersonInstantMessageProperty

      Identifier for the instant message multivalue property.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonInstantMessageServiceKey

      kABPersonInstantMessageServiceKey

      Instant message service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonInstantMessageUsernameKey

      kABPersonInstantMessageUsernameKey

      Instant message service username.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

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

    Declaration

    Swift

    let kABPersonInstantMessageServiceYahoo: CFString! let kABPersonInstantMessageServiceJabber: CFString! let kABPersonInstantMessageServiceMSN: CFString! let kABPersonInstantMessageServiceICQ: CFString! let kABPersonInstantMessageServiceAIM: CFString! let kABPersonInstantMessageServiceQQ: CFString! let kABPersonInstantMessageServiceGoogleTalk: CFString! let kABPersonInstantMessageServiceSkype: CFString! let kABPersonInstantMessageServiceFacebook: CFString! let kABPersonInstantMessageServiceGaduGadu: CFString!

    Objective-C

    const CFStringRef kABPersonInstantMessageServiceYahoo; const CFStringRef kABPersonInstantMessageServiceJabber; const CFStringRef kABPersonInstantMessageServiceMSN; const CFStringRef kABPersonInstantMessageServiceICQ; const CFStringRef kABPersonInstantMessageServiceAIM; const CFStringRef kABPersonInstantMessageServiceQQ; const CFStringRef kABPersonInstantMessageServiceGoogleTalk; const CFStringRef kABPersonInstantMessageServiceSkype; const CFStringRef kABPersonInstantMessageServiceFacebook; const CFStringRef kABPersonInstantMessageServiceGaduGadu;

    Constants

    • kABPersonInstantMessageServiceYahoo

      kABPersonInstantMessageServiceYahoo

      Yahoo instant message service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonInstantMessageServiceJabber

      kABPersonInstantMessageServiceJabber

      Jabber instant message service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonInstantMessageServiceMSN

      kABPersonInstantMessageServiceMSN

      MSN instant message service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonInstantMessageServiceICQ

      kABPersonInstantMessageServiceICQ

      ICQ instant message service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonInstantMessageServiceAIM

      kABPersonInstantMessageServiceAIM

      AIM instant message service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonInstantMessageServiceQQ

      kABPersonInstantMessageServiceQQ

      QQ instant message service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonInstantMessageServiceGoogleTalk

      kABPersonInstantMessageServiceGoogleTalk

      Google Talk instant message service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonInstantMessageServiceSkype

      kABPersonInstantMessageServiceSkype

      Skype instant message service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonInstantMessageServiceFacebook

      kABPersonInstantMessageServiceFacebook

      Facebook instant message service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonInstantMessageServiceGaduGadu

      kABPersonInstantMessageServiceGaduGadu

      Gadu-Gadu instant message service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

  • The keys used to specify the different fields in a kABPersonSocialProfileProperty property (a multivalue property of type kABMultiDictionaryPropertyType). Neither developers nor users can add more keys.

    Declaration

    Swift

    let kABPersonSocialProfileProperty: ABPropertyID let kABPersonSocialProfileURLKey: CFString! let kABPersonSocialProfileServiceKey: CFString! let kABPersonSocialProfileUsernameKey: CFString! let kABPersonSocialProfileUserIdentifierKey: CFString!

    Objective-C

    const ABPropertyID kABPersonSocialProfileProperty; const CFStringRef kABPersonSocialProfileURLKey; const CFStringRef kABPersonSocialProfileServiceKey; const CFStringRef kABPersonSocialProfileUsernameKey; const CFStringRef kABPersonSocialProfileUserIdentifierKey;

    Constants

    • kABPersonSocialProfileProperty

      kABPersonSocialProfileProperty

      Identifier for the social profile property.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonSocialProfileURLKey

      kABPersonSocialProfileURLKey

      Social profile URL.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonSocialProfileServiceKey

      kABPersonSocialProfileServiceKey

      Social profile service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonSocialProfileUsernameKey

      kABPersonSocialProfileUsernameKey

      Social profile username.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonSocialProfileUserIdentifierKey

      kABPersonSocialProfileUserIdentifierKey

      Social profile user identifier.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

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

    Declaration

    Swift

    let kABPersonSocialProfileServiceTwitter: CFString! let kABPersonSocialProfileServiceGameCenter: CFString! let kABPersonSocialProfileServiceSinaWeibo: CFString! let kABPersonSocialProfileServiceFacebook: CFString! let kABPersonSocialProfileServiceMyspace: CFString! let kABPersonSocialProfileServiceLinkedIn: CFString! let kABPersonSocialProfileServiceFlickr: CFString!

    Objective-C

    const CFStringRef kABPersonSocialProfileServiceTwitter; const CFStringRef kABPersonSocialProfileServiceSinaWeibo; const CFStringRef kABPersonSocialProfileServiceGameCenter; const CFStringRef kABPersonSocialProfileServiceFacebook; const CFStringRef kABPersonSocialProfileServiceMyspace; const CFStringRef kABPersonSocialProfileServiceLinkedIn; const CFStringRef kABPersonSocialProfileServiceFlickr;

    Constants

    • kABPersonSocialProfileServiceTwitter

      kABPersonSocialProfileServiceTwitter

      Twitter social profile service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonSocialProfileServiceGameCenter

      kABPersonSocialProfileServiceGameCenter

      Game Center social profile service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonSocialProfileServiceSinaWeibo

      kABPersonSocialProfileServiceSinaWeibo

      Sina Weibo social profile service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonSocialProfileServiceFacebook

      kABPersonSocialProfileServiceFacebook

      Facebook social profile service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonSocialProfileServiceMyspace

      kABPersonSocialProfileServiceMyspace

      Myspace social profile service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonSocialProfileServiceLinkedIn

      kABPersonSocialProfileServiceLinkedIn

      LinkedIn social profile service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonSocialProfileServiceFlickr

      kABPersonSocialProfileServiceFlickr

      Flickr social profile service.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

  • This constant implements the person URL property (a multivalue property of type kABMultiStringPropertyType) and the label used to identify the property’s sole value.

    Declaration

    Swift

    let kABPersonURLProperty: ABPropertyID let kABPersonHomePageLabel: CFString!

    Objective-C

    const ABPropertyID kABPersonURLProperty; const CFStringRef kABPersonHomePageLabel;

    Constants

    • kABPersonURLProperty

      kABPersonURLProperty

      Identifier for the URL multivalue property.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonHomePageLabel

      kABPersonHomePageLabel

      Home page.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

  • These constants implement the person related name property (a multivalue property of type kABMultiStringPropertyType) and the labels used to identify each of the property’s values.

    Declaration

    Swift

    let kABPersonRelatedNamesProperty: ABPropertyID let kABPersonMotherLabel: CFString! let kABPersonFatherLabel: CFString! let kABPersonParentLabel: CFString! let kABPersonSisterLabel: CFString! let kABPersonBrotherLabel: CFString! let kABPersonChildLabel: CFString! let kABPersonFriendLabel: CFString! let kABPersonSpouseLabel: CFString! let kABPersonPartnerLabel: CFString! let kABPersonManagerLabel: CFString! let kABPersonAssistantLabel: CFString!

    Objective-C

    const ABPropertyID kABPersonRelatedNamesProperty; const CFStringRef kABPersonMotherLabel; const CFStringRef kABPersonFatherLabel; const CFStringRef kABPersonParentLabel; const CFStringRef kABPersonSisterLabel; const CFStringRef kABPersonBrotherLabel; const CFStringRef kABPersonChildLabel; const CFStringRef kABPersonFriendLabel; const CFStringRef kABPersonSpouseLabel; const CFStringRef kABPersonPartnerLabel; const CFStringRef kABPersonManagerLabel; const CFStringRef kABPersonAssistantLabel;

    Constants

    • kABPersonRelatedNamesProperty

      kABPersonRelatedNamesProperty

      Identifier for the related name multivalue property.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonMotherLabel

      kABPersonMotherLabel

      Mother.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonFatherLabel

      kABPersonFatherLabel

      Father.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonParentLabel

      kABPersonParentLabel

      Parent.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonSisterLabel

      kABPersonSisterLabel

      Sister.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonBrotherLabel

      kABPersonBrotherLabel

      Brother.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonChildLabel

      kABPersonChildLabel

      Child.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonFriendLabel

      kABPersonFriendLabel

      Friend.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonSpouseLabel

      kABPersonSpouseLabel

      Spouse.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonPartnerLabel

      kABPersonPartnerLabel

      Partner.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonManagerLabel

      kABPersonManagerLabel

      Manager.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAssistantLabel

      kABPersonAssistantLabel

      Assistant.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

  • These constants contain generic property labels.

    Declaration

    Swift

    let kABWorkLabel: CFString! let kABHomeLabel: CFString! let kABOtherLabel: CFString!

    Objective-C

    const CFStringRef kABWorkLabel; const CFStringRef kABHomeLabel; const CFStringRef kABOtherLabel;

    Constants

    • kABWorkLabel

      kABWorkLabel

      Work label.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABHomeLabel

      kABHomeLabel

      Home label.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABOtherLabel

      kABOtherLabel

      Other label.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

  • Alternate birthdays are represented by a new property whose value is a dictionary with specified keys, whose values are the relevant properties of an NSDateComponents object. The listed constants provide the reference to the property and the specified keys.

    Declaration

    Swift

    let kABPersonAlternateBirthdayProperty: ABPropertyID let kABPersonAlternateBirthdayCalendarIdentifierKey: CFString! let kABPersonAlternateBirthdayEraKey: CFString! let kABPersonAlternateBirthdayYearKey: CFString! let kABPersonAlternateBirthdayMonthKey: CFString! let kABPersonAlternateBirthdayIsLeapMonthKey: CFString! let kABPersonAlternateBirthdayDayKey: CFString!

    Objective-C

    const ABPropertyID kABPersonAlternateBirthdayProperty; const CFStringRef kABPersonAlternateBirthdayCalendarIdentifierKey; const CFStringRef kABPersonAlternateBirthdayEraKey; const CFStringRef kABPersonAlternateBirthdayYearKey; const CFStringRef kABPersonAlternateBirthdayMonthKey; const CFStringRef kABPersonAlternateBirthdayIsLeapMonthKey; const CFStringRef kABPersonAlternateBirthdayDayKey __OSX_AVAILABLE_STARTING(__MAC_NA, __IPHONE_8_0); // CFNumberRef - kCFNumberNSIntegerType

    Constants

    • kABPersonAlternateBirthdayProperty

      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.

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAlternateBirthdayCalendarIdentifierKey

      kABPersonAlternateBirthdayCalendarIdentifierKey

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

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAlternateBirthdayEraKey

      kABPersonAlternateBirthdayEraKey

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

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAlternateBirthdayYearKey

      kABPersonAlternateBirthdayYearKey

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

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAlternateBirthdayMonthKey

      kABPersonAlternateBirthdayMonthKey

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

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAlternateBirthdayIsLeapMonthKey

      kABPersonAlternateBirthdayIsLeapMonthKey

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

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    • kABPersonAlternateBirthdayDayKey

      kABPersonAlternateBirthdayDayKey

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

      Available in iOS 2.0 and later.

      Deprecated in iOS 9.0.

    Discussion

    The alternate birthday property provides a way for a user to specify a birthday that differs from the specific birth date, or that only specifies certain components—for example, a month and a day, but no year. iOS and OS X make this property available for editing in the Contacts app.

    The alternate birthday property is not applicable to Exchange contacts.