iOS Developer Library

Developer

Address Book Framework Reference for iOS ABMultiValue Reference

Options
Deployment Target:

On This Page
Language:

ABMultiValue Reference

The ABMultiValue opaque type (whose objects are known as multivalues) implements a property that can have multiple values. All the contained values must be of the same type. Each value has a unique identifier and a nonunique label, which may be one of the provided labels or one defined by the user.

For example, if a multivalue property is used to store phone numbers, there may be multiple work phone numbers. These have the same label, but different unique identifiers.

Multivalue properties are immutable. To use mutable multivalue properties, see ABMutableMultiValue Reference.

Functions

Data Types

  • Reference to a multivalue property.

    Declaration

    Swift

    typealias ABMultiValue = CFTypeRef

    Objective-C

    typedef CFTypeRef ABMultiValueRef;

    Import Statement

    Objective-C

    @import AddressBook;

    Swift

    import AddressBook

    Availability

    Available in iOS 2.0 and later.

    Deprecated in iOS 9.0.

  • Identifies multivalue properties.

    Declaration

    Swift

    typealias ABMultiValueIdentifier = Int32

    Objective-C

    typedef int32_t ABMultiValueIdentifier;

    Import Statement

    Objective-C

    @import AddressBook;

    Swift

    import AddressBook

    Availability

    Available in iOS 2.0 and later.

    Deprecated in iOS 9.0.

Constants

  • This preprocessor definition identifies an multivalue property with values whose type does not match its declared type.

    Declaration

    Swift

    var kABMultiValueInvalidIdentifier: Int32 { get }

    Objective-C

    #define kABMultiValueInvalidIdentifier -1

    Constants

    • kABMultiValueInvalidIdentifier

      kABMultiValueInvalidIdentifier

      Invalid multivalue property.

      Available in iOS 2.0 and later.

    Discussion

    See ABMultiValueIdentifier.