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

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

Разработчик

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

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

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

ABGroup C ссылка

Непрозрачный тип ABGroup поддерживает понятие «группы», содержащей одно или более лиц. Люди могут принадлежать многократным группам, и группы могут также принадлежать другим группам, пока отношение не вызывает циклическую ссылку. Единственное предопределенное свойство группы является своим именем. Однако подобный записям лица, можно добавить собственные свойства для группировки записей. Группы не только помогают организовать записи лица, но и позволить Вам создавать списки рассылки по электронной почте.

Используйте ABGroupCopyArrayOfAllMembers функция для получения всех элементов группы используйте ABGroupAddMember функция, чтобы добавить людей к группе, и ABGroupRemoveMember функция для удаления людей из группы. Используйте ABGroupAddGroup функция для создания подгруппы.

Используйте ABAddressBook ABAddPropertiesAndTypes функция для добавления дополнительных определенных с помощью программы свойств для группировки записей. Поскольку база данных Address Book сохранена как список свойств, эти определенные с помощью программы свойства могут быть проигнорированы другими приложениями. Обратите внимание на то, что к базе данных Address Book получает доступ многократное приложение и не шифруют так, Ваше приложение не должно хранить уязвимую информацию в базе данных.

Можно также искать записи, соответствующие определенный «запрос», который Вы указываете путем создания объекта ABSearchElement. Используйте ABGroupCreateSearchElement функция для создания объекта ABSearchElement, содержащего запрос. Тогда используйте ABAddressBook ABCopyArrayOfMatchingRecords функция, передавая ABSearchElement как параметр, для запросов базы данных. Посмотрите ABSearchElement для функций, создающих составные запросы.

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

Функции

ABGroup для разных функций C
  • ABGroupAddGroup (_: _:) ABGroupAddGroup

    Добавляет подгруппа к другой группе.

    Объявление

    Swift

    func ABGroupAddGroup(_ group: ABGroup!, _ groupToAdd: ABGroup!) -> Bool

    Objective C

    bool ABGroupAddGroup ( ABGroupRef group, ABGroupRef groupToAdd );

    Параметры

    group

    Группа Вы хотите добавить подгруппу к. Если NULL, эта функция повышает исключение.

    groupToAdd

    Подгруппа Вы хотите добавить к group.

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

    Возвраты true в случае успеха. Если group параметром уже является часть получателя, эта функция не делает ничего и возвратов false. Если добавление группы создало бы рекурсию, эта функция также не делает ничего и возвратов false. Например, если группа “Любители Животных” находится в «Любителях собак», и Вы добавляете «Любителей собак» к “Любителям Животных”, которые создали бы рекурсию, которую не позволит эта функция.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

  • ABGroupAddMember (_: _:) ABGroupAddMember

    Добавляет лицо к группе.

    Объявление

    Swift

    func ABGroupAddMember(_ group: ABGroup!, _ person: ABPerson!) -> Bool

    Objective C

    bool ABGroupAddMember ( ABGroupRef group, ABPersonRef personToAdd );

    Параметры

    group

    Группа Вы хотите добавить person к.

    person

    Лицо для добавления к group. Если person NULL, эта функция повышает исключение.

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

    true в случае успеха, ложь иначе. Например, если person уже находится в group, эта функция делает только возвраты false.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

  • ABGroupCopyDistributionIdentifier (_: _: _:) ABGroupCopyDistributionIdentifier

    Возвращает идентификатор распределения для данного свойства и лица.

    Объявление

    Swift

    func ABGroupCopyDistributionIdentifier(_ group: ABGroup!, _ person: ABPerson!, _ property: CFString!) -> Unmanaged<CFString>!

    Objective C

    CFStringRef ABGroupCopyDistributionIdentifier ( ABGroupRef group, ABPersonRef person, CFStringRef property );

    Параметры

    group

    Объект группы это person принадлежит.

    person

    Объект лица, идентификатор распределения которого Вы хотите получить.

    property

    Имя мультизначения лица перечисляет свойство, идентификатор распределения которого Вы хотите получить.

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

    Идентификатор распределения для person и property если это было установлено, иначе возвращает основной идентификатор свойства. Если также person или property NULL, эта функция возвраты NULL. Кроме того, возвраты NULL если property не свойство списка мультизначения. Вы ответственны за выпуск этого объекта.

    Обсуждение

    Используйте ABGroupSetDistributionIdentifier функционируйте для установки идентификатора распределения для свойства списка мультизначения лица.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

  • ABGroupCopyArrayOfAllMembers (_:) ABGroupCopyArrayOfAllMembers

    Возвращает массив лиц в группе.

    Объявление

    Swift

    func ABGroupCopyArrayOfAllMembers(_ group: ABGroup!) -> Unmanaged<CFArray>!

    Objective C

    CFArrayRef ABGroupCopyArrayOfAllMembers ( ABGroupRef group );

    Параметры

    group

    ABGroup возражают, чьи элементы Вы хотите получить.

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

    Массив объектов АБПЕРСОНА, представляющих людей в group. Если эта группа не содержит людей, эта функция возвращает пустой массив. Вы ответственны за выпуск этого объекта.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

  • ABGroupCopyArrayOfAllSubgroups (_:) ABGroupCopyArrayOfAllSubgroups

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

    Объявление

    Swift

    func ABGroupCopyArrayOfAllSubgroups(_ group: ABGroup!) -> Unmanaged<CFArray>!

    Objective C

    CFArrayRef ABGroupCopyArrayOfAllSubgroups ( ABGroupRef group );

    Параметры

    group

    ABGroup возражают, чьи подгруппы Вы хотите получить.

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

    Массив объектов ABGroup, представляющих подгруппы group. Если group не содержит групп, эта функция возвращает пустой массив. Вы ответственны за выпуск этого объекта.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

  • ABGroupCopyParentGroups (_:) ABGroupCopyParentGroups

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

    Объявление

    Swift

    func ABGroupCopyParentGroups(_ group: ABGroup!) -> Unmanaged<CFArray>!

    Objective C

    CFArrayRef ABGroupCopyParentGroups ( ABGroupRef group );

    Параметры

    group

    Группа, родительские группы которой Вы хотите получить.

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

    Массив, содержащий объекты ABGroup, представляющие родителей group. Если group не принадлежит никаким группам, эта функция возвращает пустой массив. Вы ответственны за выпуск этого объекта.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

  • ABGroupCreate () ABGroupCreate

    Возвращает новый объект ABGroup.

    Объявление

    Swift

    func ABGroupCreate() -> Unmanaged<ABGroup>!

    Objective C

    ABGroupRef ABGroupCreate ( void );

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

    Недавно создаваемый объект ABGroup. Вы ответственны за выпуск этого объекта.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

  • ABGroupCreateSearchElement (_: _: _: _: _:) ABGroupCreateSearchElement

    Создает объект ABSearchElement, указывающий запрос для записей ABGroup.

    Объявление

    Swift

    func ABGroupCreateSearchElement(_ property: CFString!, _ label: CFString!, _ key: CFString!, _ value: AnyObject!, _ comparison: ABSearchComparison) -> Unmanaged<ABSearchElement>!

    Objective C

    ABSearchElementRef ABGroupCreateSearchElement ( CFStringRef property, CFStringRef label, CFStringRef key, CFTypeRef value, ABSearchComparison comparison );

    Параметры

    property

    Имя свойства для поиска на. Это не может быть NULL. Для полного списка свойств посмотрите Group Properties и Common Properties.

    label

    Имя метки для списка мультизначения. Если property не имеет многократных значений, передачи NULL. Если property действительно имеет многократные значения, передачу NULL искать все значения. По умолчанию записи ABGroup не содержат свойств списка мультизначения.

    key

    Ключевое имя для словаря. Если property не словарь, передача NULL. Если property словарь, передача NULL искать все ключи. По умолчанию записи ABGroup не содержат свойств, которые являются словарями.

    value

    Значение Вы ищете. Это не может быть NULL

    comparison

    Указывает тип сравнения для выполнения, такой как kABEqual или kABPrefixMatchCaseInsensitive. Для полного списка посмотрите ABSearchComparison.

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

    Поисковый объект элемента, указывающий запрос согласно вышеупомянутым параметрам. Вы ответственны за выпуск этого объекта.

    Обсуждение

    Используйте ABAddressBook ABCopyArrayOfMatchingRecords функционируйте для фактического выполнения запроса. Кроме того, посмотрите ABSearchElement для большего количества функций, создающих составные запросы.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

  • ABGroupRemoveGroup (_: _:) ABGroupRemoveGroup

    Удаляет подгруппу из группы.

    Объявление

    Swift

    func ABGroupRemoveGroup(_ group: ABGroup!, _ groupToRemove: ABGroup!) -> Bool

    Objective C

    bool ABGroupRemoveGroup ( ABGroupRef group, ABGroupRef groupToRemove );

    Параметры

    group

    Если NULL, эта функция повышает исключение.

    groupToRemove

    Подгруппа, которая будет удалена из group.

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

    true в случае успеха. Если group параметр не является подгруппой, эта функция не делает ничего и возвратов false.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

  • ABGroupRemoveMember (_: _:) ABGroupRemoveMember

    Удаляет лицо из группы.

    Объявление

    Swift

    func ABGroupRemoveMember(_ group: ABGroup!, _ person: ABPerson!) -> Bool

    Objective C

    bool ABGroupRemoveMember ( ABGroupRef group, ABPersonRef personToRemove );

    Параметры

    group

    Группа, которую Вы хотите удалить person от.

    person

    Элемент, из которого Вы хотите удалить group.

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

    true в случае успеха. Если person параметр не находится в group, эта функция не делает ничего и возвратов false.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

  • ABGroupSetDistributionIdentifier (_: _: _: _:) ABGroupSetDistributionIdentifier

    Присвоение определенного идентификатора распределения для мультизначения лица перечисляет свойство так, чтобы группа могла использоваться в качестве списка рассылки (список рассылки, в случае почтового свойства).

    Объявление

    Swift

    func ABGroupSetDistributionIdentifier(_ group: ABGroup!, _ person: ABPerson!, _ property: CFString!, _ identifier: CFString!) -> Bool

    Objective C

    bool ABGroupSetDistributionIdentifier ( ABGroupRef group, ABPersonRef person, CFStringRef property, CFStringRef identifier );

    Параметры

    group

    Группа это person принадлежит.

    person

    Лицо, чей идентификатор распределения для property Вы хотите измениться. Если NULL, эта функция повышает исключение.

    property

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

    identifier

    Новый идентификатор распределения, метка, используемая списком мультизначения такой как kABAddressHomeLabel для a kABAddressProperty. Передача NULL сбрасывать идентификатор распределения к его значению по умолчанию, основной идентификатор списка мультизначения.

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

    true в случае успеха, false иначе.

    Обсуждение

    Идентификатор распределения по умолчанию является основным идентификатором списка мультизначения. Используйте эту функцию, если необходимо изменить идентификатор распределения для определенного лица. Например, если идентификатор по умолчанию является домашней электронной почтой лица, но Вы хотите использовать электронную почту работы Джона, вызовите эту функциональную передачу kABEmailWorkLabel как identifier параметр, kABEmailProperty как property параметр и лицо Джона возражают как person параметр.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

Типы данных

  • ABGroupRef ABGroupRef

    Ссылка на объект ABGroup.

    Объявление

    Swift

    typealias ABGroupRef = ABGroup

    Objective C

    typedef struct __ABGroup *ABGroupRef;

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

Константы

  • Свойства группы

    Свойства, определенные для объектов ABGroup.

    Объявление

    Swift

    let kABGroupNameProperty: NSString!

    Objective C

    CFStringRef kABGroupNameProperty;

    Константы

    • kABGroupNameProperty

      kABGroupNameProperty

      Имя группы.

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

  • Тип записи

    Используемый для обозначения типов записи.

    Объявление

    Objective C

    CFStringRef kABGroupRecordType;

    Константы

    • kABGroupRecordType

      kABGroupRecordType

      Указывает запись объекта ABGroup.