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

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

Разработчик

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

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

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

ABGroup

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

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

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

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

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

Swift

import AddressBook

Objective C

@import AddressBook;

Доступность

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

Управление свойствами
  • addPropertiesAndTypes (_:) + addPropertiesAndTypes:

    Добавляют данные свойства ко всем записям этого типа в базе данных Address Book.

    Объявление

    Swift

    class func addPropertiesAndTypes(_ properties: [NSObject : AnyObject]!) -> Int

    Objective C

    + (NSInteger)addPropertiesAndTypes:(NSDictionary *)properties

    Параметры

    properties

    Словарь свойств, которые будут добавлены и их типы.

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

    Число свойств успешно добавило.

    Обсуждение

    В каждой словарной статье ключ является строкой с именем свойства, и значение является константой с типом свойства. Имя свойства должно быть уникальным. Можно хотеть использовать имена пакета стиля Java для свойств, например, org.dogclub.dogname или com.mycompany.groupID. Тип свойства должен быть одной из констант, описанных в Типах Свойства.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    + removeProperties:

  • removeProperties (_:) + removeProperties:

    Удаляет данные свойства из всех записей этого типа в базе данных Address Book.

    Объявление

    Swift

    class func removeProperties(_ properties: [AnyObject]!) -> Int

    Objective C

    + (NSInteger)removeProperties:(NSArray *)properties

    Параметры

    properties

    Массив свойств, которые будут удалены.

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

    Число свойств успешно удалено.

    Обсуждение

    Только пользовательские свойства могут быть удалены. Этот метод не реализован.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    + addPropertiesAndTypes:

  • свойства () + свойства

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

    Объявление

    Swift

    class func properties() -> [AnyObject]!

    Objective C

    + (NSArray *)properties

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    + typeOfProperty:

  • typeOfProperty (_:) + typeOfProperty:

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

    Объявление

    Swift

    class func typeOfProperty(_ property: String!) -> ABPropertyType

    Objective C

    + (ABPropertyType)typeOfProperty:(NSString *)property

    Параметры

    property

    Свойство, тип которого будет возвращен.

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

    Тип свойства property.

    Обсуждение

    Если свойство не существует, этот метод возвраты kABErrorInProperty.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    + свойства

Управление лицами
  • addMember (_:) - addMember:

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

    Объявление

    Swift

    func addMember(_ person: ABPerson!) -> Bool

    Objective C

    - (BOOL)addMember:(ABPerson *)person

    Параметры

    person

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

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

    YEStrue если успешный; иначе, NOfalse.

    Обсуждение

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

    Специальные замечания

    До OS X v10.6, если запись лица уже находится в группе, этот метод не делает ничего и возвратов NOfalse.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    – removeMember:
    – addSubgroup:
    – элементы

  • removeMember (_:) - removeMember:

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

    Объявление

    Swift

    func removeMember(_ person: ABPerson!) -> Bool

    Objective C

    - (BOOL)removeMember:(ABPerson *)person

    Параметры

    person

    Лицо, которое будет удалено.

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

    YEStrue если успешный; иначе, NOfalse.

    Обсуждение

    Если person параметр не находится в группе, этот метод не делает ничего и возвратов NOfalse. Если person nil, этот метод повышает исключение.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    – addMember:
    – элементы
    – removeSubgroup:

  • элементы () - элементы

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

    Объявление

    Swift

    func members() -> [AnyObject]!

    Objective C

    - (NSArray *)members

    Обсуждение

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

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    – addMember:
    – removeMember:
    – подгруппы

Управление подгруппами
  • addSubgroup (_:) - addSubgroup:

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

    Объявление

    Swift

    func addSubgroup(_ group: ABGroup!) -> Bool

    Objective C

    - (BOOL)addSubgroup:(ABGroup *)group

    Параметры

    group

    Группа для добавления как подгруппа.

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

    YEStrue если успешный; иначе, NOfalse.

    Обсуждение

    Если group параметром уже является часть получателя, этот метод не делает ничего и возвратов NOfalse. Если добавление группы создало бы рекурсию, этот метод также не делает ничего и возвратов NOfalse. (Например, если бы Любители группы Животных находятся в Любителях собак, и Вы добавляете Любителей собак к Любителям Животных, которые создали бы рекурсию, которую не позволит этот метод.), Если group параметр nil, этот метод повышает исключение.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    – removeSubgroup:
    – addMember:
    – подгруппы

  • removeSubgroup (_:) - removeSubgroup:

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

    Объявление

    Swift

    func removeSubgroup(_ group: ABGroup!) -> Bool

    Objective C

    - (BOOL)removeSubgroup:(ABGroup *)group

    Параметры

    group

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

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

    YEStrue если успешный; иначе, NOfalse.

    Обсуждение

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

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    – addSubgroup:
    – подгруппы
    – removeMember:

  • parentGroups () - parentGroups

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

    Объявление

    Swift

    func parentGroups() -> [AnyObject]!

    Objective C

    - (NSArray *)parentGroups

    Обсуждение

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

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    – подгруппы

  • подгруппы () - подгруппы

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

    Объявление

    Swift

    func subgroups() -> [AnyObject]!

    Objective C

    - (NSArray *)subgroups

    Обсуждение

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

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    – addSubgroup:
    – removeSubgroup:
    – элементы

Управление списками рассылки
  • distributionIdentifierForProperty (_: лицо:) - distributionIdentifierForProperty:person:

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

    Объявление

    Swift

    func distributionIdentifierForProperty(_ property: String!, person person: ABPerson!) -> String!

    Objective C

    - (NSString *)distributionIdentifierForProperty:(NSString *)property person:(ABPerson *)person

    Параметры

    property

    Свойство, идентификатор распределения которого будет возвращен.

    person

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

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

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

    Обсуждение

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

    Идентификаторы распределения позволяют Вам использовать группы в качестве списков рассылки путем указания, какое значение в свойстве мультизначения должно использоваться при обращении группы. Посмотрите Using Address Book Groups как Списки рассылки для более детального обсуждения.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    – setDistributionIdentifier:forProperty:person:
    – primaryIdentifier (ABMultiValue)

  • setDistributionIdentifier (_: forProperty:person:) - setDistributionIdentifier:forProperty:person:

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

    Объявление

    Swift

    func setDistributionIdentifier(_ identifier: String!, forProperty property: String!, person person: ABPerson!) -> Bool

    Objective C

    - (BOOL)setDistributionIdentifier:(NSString *)identifier forProperty:(NSString *)property person:(ABPerson *)person

    Параметры

    identifier

    Идентификатор, который будет установлен как идентификатор распределения

    property

    Свойство, идентификатор распределения которого будет установлен.

    person

    Лицо, идентификатор распределения которого будет.

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

    YEStrue если успешный; иначе, NOfalse.

    Обсуждение

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

    Идентификаторы распределения позволяют Вам использовать группы в качестве списков рассылки путем указания, какое значение в свойстве мультизначения должно использоваться при обращении группы. Посмотрите Using Address Book Groups как Списки рассылки для более детального обсуждения.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    – distributionIdentifierForProperty:person:
    – setPrimaryIdentifier: (ABMutableMultiValue)

Поиск
  • searchElementForProperty (_: label:key:value:comparison:) + searchElementForProperty:label:key:value:comparison:

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

    Объявление

    Swift

    class func searchElementForProperty(_ property: String!, label label: String!, key key: String!, value value: AnyObject!, comparison comparison: ABSearchComparison) -> ABSearchElement!

    Objective C

    + (ABSearchElement *)searchElementForProperty:(NSString *)property label:(NSString *)label key:(NSString *)key value:(id)value comparison:(ABSearchComparison)comparison

    Параметры

    property

    Имя свойства для поиска на. Это не может быть nil. Для полного списка свойств посмотрите Свойства Default Record Properties and Default Group.

    label

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

    key

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

    value

    Что Вы ищете. Если nil, единственное поддерживаемое значение для comparison kABEqual или kABNotEqual.

    comparison

    Тип сравнения для выполнения и ABSearchComparison, такой как kABEqual или kABPrefixMatchCaseInsensitive.

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

    Objective C

    @import AddressBook;

    Swift

    import AddressBook

    Доступность

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

    См. также

    + searchElementForProperty:label:key:value:comparison: (АБПЕРСОН)
    + searchElementForConjunction:children: (ABSearchElement)
    – recordsMatchingSearchElement: (ABAddressBook)