Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека разработчика Mac

Разработчик

Ссылка платформы AddressBook ссылка класса ABAddressBook

Опции
Развертывание Target:

На этой странице
Язык:

ABAddressBook

ABAddressBook класс обеспечивает интерфейс программирования для Адресной книги — централизованная база данных, используемая многократными приложениями для хранения контакта и других персональных данных о людях. База данных Address Book также поддерживает понятие «группы», содержащей одно или более лиц. Люди могут принадлежать многократным группам, и группы могут также принадлежать другим группам с некоторыми ограничениями (например, никакие циклические ссылки не позволяются).

ABAddressBook класс “бесплатный соединенный мостом” с его процедурным дубликатом непрозрачного типа C. Это означает что ABAddressBookRef тип является взаимозаменяемым в вызовах функции или вызовах метода с экземплярами ABAddressBook класс.

Наследование

Соответствует

Оператор импорта

Swift

import AddressBook

Objective C

@import AddressBook;

Доступность

Доступный в OS X v10.2 и позже.

Создание и инициализация адресной книги
  • sharedAddressBook () + sharedAddressBook

    Возвращает уникальный совместно используемый экземпляр ABAddressBook, или nil если не может быть инициализирована база данных Address Book.

    Объявление

    Swift

    class func sharedAddressBook() -> ABAddressBook!

    Objective C

    + (ABAddressBook *)sharedAddressBook

    Возвращаемое значение

    Уникальный совместно используемый экземпляр ABAddressBook, или nil если не может быть инициализирована база данных Address Book.

    Обсуждение

    Этот метод возвращает адресную книгу для зарегистрированного пользователя, совместно использующегося каждым приложением. Если Вы вызовете этот метод несколько раз или попытаетесь создать новую адресную книгу, то Вы получите указатель на ту же совместно используемую адресную книгу.

    Если Вы просто делаете одноразовые поиски и редактирования, это - надлежащий метод для использования. Если Ваш код выполняет жесткий цикл, с помощью addressBook метод с initWithAddressBook: метод ABPerson может привести к значительным повышениям производительности. Посмотрите Доступ к Адресной книге для большего количества подробных данных.

    Если пользователь отклоняет Ваш доступ к приложениям к базе данных Address Book, этот метод возвраты nil.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    + addressBook

  • addressBook + addressBook

    Возвращает новый экземпляр ABAddressBook, или nil если не может быть инициализирована база данных Address Book.

    Объявление

    Objective C

    + (ABAddressBook *)addressBook

    Возвращаемое значение

    Новый экземпляр ABAddressBook, или nil если не может быть инициализирована база данных Address Book.

    Обсуждение

    Если Вы просто делаете одноразовые поиски и редактирования, sharedAddressBook метод является, вероятно, более надлежащим. Если Ваш код выполняет жесткий цикл, addressBook метод может привести к значительным повышениям производительности, когда используется с АБПЕРСОН initWithAddressBook: метод. Посмотрите Доступ к Адресной книге для большего количества подробных данных.

    Если пользователь отклоняет Ваш доступ к приложениям к базе данных Address Book, этот метод возвраты nil.

    Оператор импорта

    Objective C

    @import AddressBook;

    Доступность

    Доступный в OS X v10.5 и позже.

    См. также

    + sharedAddressBook

Retrieving Groups и люди
  • группы () - группы

    Возвращает массив всех групп в базе данных Address Book.

    Объявление

    Swift

    func groups() -> [AnyObject]!

    Objective C

    - (NSArray *)groups

    Возвращаемое значение

    Массив всех групп в базе данных Address Book.

    Обсуждение

    Если база данных не содержит групп, этот метод возвращает пустой массив.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – люди

  • люди () - люди

    Возвращает массив всех людей в базе данных Address Book.

    Объявление

    Swift

    func people() -> [AnyObject]!

    Objective C

    - (NSArray *)people

    Возвращаемое значение

    Массив всех людей в базе данных Address Book.

    Обсуждение

    Если база данных не содержит людей, этот метод возвращает пустой массив.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – группы

Установка и получение записи зарегистрированного пользователя
  • я () - я

    Возвраты ABPerson запись, представляющая зарегистрированного пользователя.

    Объявление

    Swift

    func me() -> ABPerson!

    Objective C

    - (ABPerson *)me

    Возвращаемое значение

    ABPerson запись, представляющая зарегистрированного пользователя.

    Обсуждение

    Если пользователь никогда не указывал такую запись, этот метод возвраты nil.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – setMe:

  • setMe (_:) - setMe:

    Устанавливает рекорд, представляющий зарегистрированного пользователя.

    Объявление

    Swift

    func setMe(_ person: ABPerson!)

    Objective C

    - (void)setMe:(ABPerson *)person

    Параметры

    person

    Лицо для установки как представление зарегистрированного пользователя.

    Обсуждение

    Если Вы не хотите, чтобы запись представляла зарегистрированного пользователя, то передайте nil как person параметр. Обратите внимание на то, что это не удалит существующую запись, если Вы будете установлены.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – я

Получение определенной записи
  • recordForUniqueId (_:) - recordForUniqueId:

    Возвращает лицо или запись группы, соответствующую данный уникальный идентификатор.

    Объявление

    Swift

    func recordForUniqueId(_ uniqueId: String!) -> ABRecord!

    Objective C

    - (ABRecord *)recordForUniqueId:(NSString *)uniqueId

    Параметры

    uniqueId

    Уникальный идентификатор записи. Это значение не должно быть nil; иначе, исключение повышено.

    Возвращаемое значение

    Лицо или запись группы, соответствующая данный уникальный идентификатор.

    Обсуждение

    Если никакая запись не имеет данный ID, этот метод возвраты nil.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    uniqueId (ABRecord)

Получение класса записи
  • recordClassFromUniqueId (_:) - recordClassFromUniqueId:

    Возвращает имя класса записи, соответствующей данный уникальный идентификатор.

    Объявление

    Swift

    func recordClassFromUniqueId(_ uniqueId: String!) -> String!

    Objective C

    - (NSString *)recordClassFromUniqueId:(NSString *)uniqueId

    Параметры

    uniqueId

    Уникальный идентификатор записи.

    Возвращаемое значение

    Имя класса записи, например ABPerson.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.3 и позже.

Получение отформатированного адреса
  • formattedAddressFromDictionary (_:) - formattedAddressFromDictionary:

    Возвращает приписанную строку, содержащую отформатированный адрес.

    Объявление

    Swift

    func formattedAddressFromDictionary(_ address: [NSObject : AnyObject]!) -> NSAttributedString!

    Objective C

    - (NSAttributedString *)formattedAddressFromDictionary:(NSDictionary *)address

    Параметры

    address

    Словарь, содержащий адрес расположения.

    Возвращаемое значение

    Приписанная строка, содержащая отформатированный адрес.

    Обсуждение

    Атрибуты строки соответствуют ключи словаря адреса, такой как kABAddressStreetKey. Каждое значение атрибута содержит локализованное описание ключа. (Например, значение канадца kABAddressZIPKey в то время как значение французского будет “Почтовым Кодом”, полем был бы «Почтовый индекс».)

    Для получения словаря, содержащего адрес расположения для записи лица, использовать valueForProperty: со свойством kABAddressProperty, и затем получая одно из значений от возвращающегося мультизначения.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.3 и позже.

Получение значений по умолчанию
  • defaultCountryCode () - defaultCountryCode

    Возвращает код страны по умолчанию для записей с неуказанными кодами стран.

    Объявление

    Swift

    func defaultCountryCode() -> String!

    Objective C

    - (NSString *)defaultCountryCode

    Возвращаемое значение

    Код страны по умолчанию.

    Обсуждение

    Это значение возвратилось, установлен пользователем в общем предпочтении приложения Адресной книги. Поддерживаемые коды стран перечислены в Кодах стран.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.3 и позже.

  • defaultNameOrdering () - defaultNameOrdering

    Возвращает упорядочивание имени по умолчанию, определенное пользователем в предпочтениях приложения Адресной книги.

    Объявление

    Swift

    func defaultNameOrdering() -> Int

    Objective C

    - (NSInteger)defaultNameOrdering

    Возвращаемое значение

    Упорядочивание имени по умолчанию определяется пользователем в предпочтениях приложения Адресной книги.

    Обсуждение

    Возможные значения kABFirstNameFirst и kABLastNameFirst.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.3 и позже.

Добавление и удаление записей
  • addRecord (_: ошибка:) - addRecord:error:

    Добавляет ABPerson или ABGroup запишите к базе данных Address Book.

    Объявление

    Swift

    func addRecord(_ record: ABRecord!, error error: NSErrorPointer) -> Bool

    Objective C

    - (BOOL)addRecord:(ABRecord *)record error:(NSError **)error

    Параметры

    record

    Запись для добавления.

    error

    Указатель на ошибочный объект, установленный в NSError экземпляр, если происходит ошибка.

    Возвращаемое значение

    YEStrue если запись была добавлена успешно; иначе NOfalse.

    Обсуждение

    Если record параметр nil, этот метод повышает исключение. Ваши изменения не фиксируются, пока Вы не вызываете save метод.

    Более эффективно использовать ABRecord метод initWithAddressBook: если это возможно.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.7 и позже.

    См. также

    – removeRecord:
    initWithVCardRepresentation: (АБПЕРСОН)

  • addRecord (_:) - addRecord:

    Добавляет ABPerson или ABGroup запишите к базе данных Address Book.

    Объявление

    Swift

    func addRecord(_ record: ABRecord!) -> Bool

    Objective C

    - (BOOL)addRecord:(ABRecord *)record

    Параметры

    record

    Запись для добавления.

    Возвращаемое значение

    YEStrue если запись была добавлена успешно; иначе NOfalse.

    Обсуждение

    Если record параметр nil, этот метод повышает исключение. Ваши изменения не фиксируются, пока Вы не вызываете save метод.

    Более эффективно использовать ABRecord метод initWithAddressBook: если это возможно.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – removeRecord:
    initWithVCardRepresentation: (АБПЕРСОН)

  • removeRecord (_: ошибка:) - removeRecord:error:

    Удаляет ABPerson или ABGroup запись от базы данных Address Book.

    Объявление

    Swift

    func removeRecord(_ record: ABRecord!, error error: NSErrorPointer) -> Bool

    Objective C

    - (BOOL)removeRecord:(ABRecord *)record error:(NSError **)error

    Параметры

    record

    Запись, которая будет удалена.

    error

    Указатель на ошибочный объект, установленный в NSError экземпляр, если происходит ошибка.

    Возвращаемое значение

    YEStrue если запись была удалена успешно; иначе, NOfalse.

    Обсуждение

    Если record nil, этот метод повышает исключение. Ваши изменения не фиксируются, пока Вы не вызываете save метод.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.7 и позже.

    См. также

    – addRecord:

  • removeRecord (_:) - removeRecord:

    Удаляет ABPerson или ABGroup запись от базы данных Address Book.

    Объявление

    Swift

    func removeRecord(_ record: ABRecord!) -> Bool

    Objective C

    - (BOOL)removeRecord:(ABRecord *)record

    Параметры

    record

    Запись, которая будет удалена.

    Возвращаемое значение

    YEStrue если запись была удалена успешно; иначе, NOfalse.

    Обсуждение

    Если record nil, этот метод повышает исключение. Ваши изменения не фиксируются, пока Вы не вызываете save метод.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – addRecord:

Поиск
  • recordsMatchingSearchElement (_:) - recordsMatchingSearchElement:

    Возвращает массив записей, соответствующих данный поисковый элемент, или возвращает пустой массив, если никакие записи не соответствуют поисковый элемент.

    Объявление

    Swift

    func recordsMatchingSearchElement(_ search: ABSearchElement!) -> [AnyObject]!

    Objective C

    - (NSArray *)recordsMatchingSearchElement:(ABSearchElement *)search

    Параметры

    search

    Поисковый элемент для выполнения поиска против.

    Возвращаемое значение

    Массив записей, соответствующих данный поисковый элемент или пустой массив, если никакие записи не соответствуют поисковый элемент.

    Обсуждение

    Если search nil, этот метод повышает исключение.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    searchElementForProperty:label:key:value:comparison: (АБПЕРСОН)
    searchElementForProperty:label:key:value:comparison: (ABGroup)
    searchElementForConjunction:children: (ABSearchElement)

Сохранение и обнаружение изменений
  • hasUnsavedChanges () - hasUnsavedChanges

    Указывает, имеет ли адресная книга изменения, не сохраненные к базе данных Address Book.

    Объявление

    Swift

    func hasUnsavedChanges() -> Bool

    Objective C

    - (BOOL)hasUnsavedChanges

    Возвращаемое значение

    YEStrue если там не сохраняются изменения; иначе, NOfalse.

    Обсуждение

    Несохраненный флаг изменений установлен автоматически каждый раз, когда внесены изменения.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – saveAndReturnError:

  • сохраните () - сохранить

    Сохраняет все изменения, внесенные начиная с последнего сохранения.

    Объявление

    Swift

    func save() -> Bool

    Objective C

    - (BOOL)save

    Возвращаемое значение

    YEStrue если успешный или не было никаких изменений; иначе, NOfalse.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

    См. также

    – hasUnsavedChanges
    – saveAndReturnError:

  • saveAndReturnError (_:) - saveAndReturnError:

    Сохраняет все изменения, внесенные начиная с последнего сохранения.

    Объявление

    Swift

    func saveAndReturnError(_ error: NSErrorPointer) -> Bool

    Objective C

    - (BOOL)saveAndReturnError:(NSError **)error

    Параметры

    error

    Указатель на ошибочный объект, установленный в NSError экземпляр, если происходит ошибка.

    Возвращаемое значение

    YEStrue если успешный или не было никаких изменений; иначе, NOfalse.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.5 и позже.

    См. также

    – сохранить
    – hasUnsavedChanges

Константы
  • Ключи уведомления изменения базы данных

    Ключи, содержавшие словарем пользовательской информации уведомлений, отправляются платформой Адресной книги.

    Объявление

    Swift

    let kABInsertedRecords: NSString! let kABUpdatedRecords: NSString! let kABDeletedRecords: NSString!

    Objective C

    NSString * const kABInsertedRecords; NSString * const kABUpdatedRecords; NSString * const kABDeletedRecords;

    Константы

    • kABInsertedRecords

      kABInsertedRecords

      Вставленные записи.

      Доступный в OS X v10.3 и позже.

    • kABUpdatedRecords

      kABUpdatedRecords

      Обновленные записи.

      Доступный в OS X v10.3 и позже.

    • kABDeletedRecords

      kABDeletedRecords

      Удаленные записи.

      Доступный в OS X v10.3 и позже.

  • Ошибки

    Ошибочные коды, возвращенные Платформой Адресной книги.

    Объявление

    Swift

    var ABAddRecordsError: Int { get } var ABRemoveRecordsError: Int { get } var ABPropertyValueValidationError: Int { get } var ABPropertyUnsupportedBySourceError: Int { get } var ABPropertyReadOnlyError: Int { get }

    Objective C

    enum { ABAddRecordsError = 1001, ABRemoveRecordsError = 1002, ABPropertyValueValidationError = 1012, ABPropertyUnsupportedBySourceError = 1013, ABPropertyReadOnlyError = 1014 };

    Константы

    • ABAddRecordsError

      ABAddRecordsError

      Записи не могли быть добавлены

      Доступный в OS X v10.7 и позже.

    • ABRemoveRecordsError

      ABRemoveRecordsError

      Записи не могли быть удалены.

      Доступный в OS X v10.7 и позже.

    • ABPropertyValueValidationError

      ABPropertyValueValidationError

      Значение свойства не допустимо.

      Доступный в OS X v10.7 и позже.

    • ABPropertyUnsupportedBySourceError

      ABPropertyUnsupportedBySourceError

      Свойство не поддерживается источником.

      Доступный в OS X v10.7 и позже.

    • ABPropertyReadOnlyError

      ABPropertyReadOnlyError

      Свойство только для чтения.

      Доступный в OS X v10.7 и позже.

Уведомления
  • kABDatabaseChangedNotification kABDatabaseChangedNotification

    Отправленный, когда этот процесс изменил базу данных Address Book.

    В зависимости от работы, выполняемой на адресной книге, один или больше следующих ключей, может быть включен в словарь пользовательской информации: kABInsertedRecords, kABUpdatedRecords, и kABDeletedRecords. Значения для каждого из ключей являются уникальными идентификаторами записей, вставленных, обновленных или удаленных, соответственно. Если значения для всех ключей nil, каждая запись имеет изменения. Например, когда база данных Address Book восстанавливается из резервной копии, это происходит.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.

  • kABDatabaseChangedExternallyNotification kABDatabaseChangedExternallyNotification

    Отправленный, когда процесс кроме текущего изменил базу данных Address Book.

    В зависимости от работы, выполняемой на адресной книге, один или больше следующих ключей, может быть включен в словарь пользовательской информации: kABInsertedRecords, kABUpdatedRecords, и kABDeletedRecords. Значения для каждого из ключей являются уникальными идентификаторами записей, вставленных, обновленных или удаленных, соответственно. Если значения для всех ключей nil, каждая запись имеет изменения. Например, когда база данных Address Book восстанавливается из резервной копии, это происходит.

    Оператор импорта

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

    Доступный в OS X v10.2 и позже.