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

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

Разработчик

Ссылка платформы HomeKit ссылка класса HMHome

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

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

HMHome

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

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

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

Swift

import HomeKit

Objective C

@import HomeKit;

Доступность

Доступный в iOS 8.0 и позже.

HMHome объект позволяет Вам связываться с и конфигурировать различные аксессуары в доме. Дома являются центральным объектом организации для HomeKit.

Дома имеют три основных цели:

  • Организуйте аксессуары во многие комнаты, самостоятельно дополнительно сгруппированные в зоны.

  • Служите основной точкой доступа для связи с и конфигурирования аксессуаров.

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

Вы не создаете дома непосредственно — вместо этого, Вы создаете их с addHomeWithName:completionHandler: метод HMHomeManager.

Информация о доме
  • name Свойство

    Имя дома. (только для чтения)

    Объявление

    Swift

    var name: String! { get }

    Objective C

    @property(readonly, copy, nonatomic) NSString *name

    Обсуждение

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

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • updateName (_: completionHandler:) - updateName:completionHandler:

    Обновляет имя дома.

    Объявление

    Swift

    func updateName(_ name: String!, completionHandler completion: ((NSError!) -> Void)!)

    Objective C

    - (void)updateName:(NSString *)name completionHandler:(void (^)(NSError *error))completion

    Параметры

    name

    Новое имя. Не должен уже существовать своими силами.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • primary Свойство

    Булево значение, указывающее, является ли получатель основным домом для своего домашнего менеджера. (только для чтения)

    Объявление

    Swift

    var primary: Bool { get }

    Objective C

    @property(readonly, getter=isPrimary, nonatomic) BOOL primary

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

Управление аксессуарами
  • accessories Свойство

    Массив всех объектов аксессуара добавил к дому. (только для чтения)

    Объявление

    Swift

    var accessories: [AnyObject]! { get }

    Objective C

    @property(readonly, copy, nonatomic) NSArray *accessories

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • addAccessory (_: completionHandler:) - addAccessory:completionHandler:

    Добавляет новый аксессуар к дому.

    Объявление

    Swift

    func addAccessory(_ accessory: HMAccessory!, completionHandler completion: ((NSError!) -> Void)!)

    Objective C

    - (void)addAccessory:(HMAccessory *)accessory completionHandler:(void (^)(NSError *error))completion

    Параметры

    accessory

    Аксессуар для добавления к дому.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

    Обсуждение

    Вы обнаруживаете, что аксессуары добавляют к домашнему использованию HMAccessoryBrowser класс. Недавно добавленные аксессуары автоматически добавляются к комнате, возвращенной roomForEntireHome.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • assignAccessory (_: toRoom:completionHandler:) - assignAccessory:toRoom:completionHandler:

    Присваивает аксессуар различной комнате.

    Объявление

    Swift

    func assignAccessory(_ accessory: HMAccessory!, toRoom room: HMRoom!, completionHandler completion: ((NSError!) -> Void)!)

    Objective C

    - (void)assignAccessory:(HMAccessory *)accessory toRoom:(HMRoom *)room completionHandler:(void (^)(NSError *error))completion

    Параметры

    accessory

    Аксессуар для присвоения; должно быть, уже был добавлен к дому.

    room

    Комната, которой будет присвоен аксессуар; должен уже существовать своими силами.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • removeAccessory (_: completionHandler:) - removeAccessory:completionHandler:

    Удаляет аксессуар из дома.

    Объявление

    Swift

    func removeAccessory(_ accessory: HMAccessory!, completionHandler completion: ((NSError!) -> Void)!)

    Objective C

    - (void)removeAccessory:(HMAccessory *)accessory completionHandler:(void (^)(NSError *error))completion

    Параметры

    accessory

    Аксессуар для удаления.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • unblockAccessory (_: completionHandler:) - unblockAccessory:completionHandler:

    Разблокируйте блокированный аксессуар.

    Объявление

    Swift

    func unblockAccessory(_ accessory: HMAccessory!, completionHandler completion: ((NSError!) -> Void)!)

    Objective C

    - (void)unblockAccessory:(HMAccessory *)accessory completionHandler:(void (^)(NSError *error))completion

    Параметры

    accessory

    Аксессуар для разблокирования.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

    Обсуждение

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

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

Управление комнатами
  • rooms Свойство

    Массив комнат своими силами. (только для чтения)

    Объявление

    Swift

    var rooms: [AnyObject]! { get }

    Objective C

    @property(readonly, copy, nonatomic) NSArray *rooms

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • roomForEntireHome () - roomForEntireHome

    Комната, представляющая все части дома, не имеющие более определенной комнаты для представления их.

    Объявление

    Swift

    func roomForEntireHome() -> HMRoom!

    Objective C

    - (HMRoom *)roomForEntireHome

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

    Комната, представляющая все части дома, не имеющие более определенной комнаты для представления их.

    Обсуждение

    Недавно добавленные аксессуары присваиваются этой комнате, пока пользователь не присваивает их более определенной комнате с assignAccessory:toRoom:completionHandler:.

    Эта комната не может быть переименована, добавлена к зоне или удалена из дома.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • addRoomWithName (_: completionHandler:) - addRoomWithName:completionHandler:

    Формирует новое пространство с указанным именем.

    Объявление

    Swift

    func addRoomWithName(_ roomName: String!, completionHandler completion: ((HMRoom!, NSError!) -> Void)!)

    Objective C

    - (void)addRoomWithName:(NSString *)roomName completionHandler:(void (^)(HMRoom *room, NSError *error))completion

    Параметры

    roomName

    Имя новой комнаты. Не должен быть nil, и не должно быть имя комнаты уже своими силами.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    room

    Недавно сформированное пространство.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • removeRoom (_: completionHandler:) - removeRoom:completionHandler:

    Удаляет комнату из дома.

    Объявление

    Swift

    func removeRoom(_ room: HMRoom!, completionHandler completion: ((NSError!) -> Void)!)

    Objective C

    - (void)removeRoom:(HMRoom *)room completionHandler:(void (^)(NSError *error))completion

    Параметры

    room

    Комната для удаления.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

    Обсуждение

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

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

Управление зонами
  • zones Свойство

    Массив всех зон своими силами. (только для чтения)

    Объявление

    Swift

    var zones: [AnyObject]! { get }

    Objective C

    @property(readonly, copy, nonatomic) NSArray *zones

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • addZoneWithName (_: completionHandler:) - addZoneWithName:completionHandler:

    Добавляет новая зона к дому.

    Объявление

    Swift

    func addZoneWithName(_ zoneName: String!, completionHandler completion: ((HMZone!, NSError!) -> Void)!)

    Objective C

    - (void)addZoneWithName:(NSString *)zoneName completionHandler:(void (^)(HMZone *zone, NSError *error))completion

    Параметры

    zoneName

    Имя новой зоны. Не должен быть nil, и не должно быть имя зоны уже своими силами.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    zone

    Недавно создаваемая зона.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • removeZone (_: completionHandler:) - removeZone:completionHandler:

    Удаляет зону из дома.

    Объявление

    Swift

    func removeZone(_ zone: HMZone!, completionHandler completion: ((NSError!) -> Void)!)

    Objective C

    - (void)removeZone:(HMZone *)zone completionHandler:(void (^)(NSError *error))completion

    Параметры

    zone

    Зона для удаления.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

Managing Services
  • servicesWithTypes (_:) - servicesWithTypes:

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

    Объявление

    Swift

    func servicesWithTypes(_ serviceTypes: [AnyObject]!) -> [AnyObject]!

    Objective C

    - (NSArray *)servicesWithTypes:(NSArray *)serviceTypes

    Параметры

    serviceTypes

    Массив строк, идентифицирующих типы службы. Посмотрите Вспомогательный Типы Службы для списка типов.

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

    Массив найденных служб. Возвраты nil если не найдены никакие службы соответствия.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • serviceGroups Свойство

    Массив всех групп службы своими силами. (только для чтения)

    Объявление

    Swift

    var serviceGroups: [AnyObject]! { get }

    Objective C

    @property(readonly, copy, nonatomic) NSArray *serviceGroups

    Обсуждение

    Группы технического обслуживания являются экземплярами HMServiceGroup.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • addServiceGroupWithName (_: completionHandler:) - addServiceGroupWithName:completionHandler:

    Добавляет группа службы к дому.

    Объявление

    Swift

    func addServiceGroupWithName(_ serviceGroupName: String!, completionHandler completion: ((HMServiceGroup!, NSError!) -> Void)!)

    Objective C

    - (void)addServiceGroupWithName:(NSString *)serviceGroupName completionHandler:(void (^)(HMServiceGroup *group, NSError *error))completion

    Параметры

    serviceGroupName

    Имя новой группы службы. Не должен быть nil, и не должно быть имя группы службы уже своими силами.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    group

    Недавно создаваемая группа службы.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • removeServiceGroup (_: completionHandler:) - removeServiceGroup:completionHandler:

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

    Объявление

    Swift

    func removeServiceGroup(_ group: HMServiceGroup!, completionHandler completion: ((NSError!) -> Void)!)

    Objective C

    - (void)removeServiceGroup:(HMServiceGroup *)group completionHandler:(void (^)(NSError *error))completion

    Параметры

    group

    Группа службы для удаления.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

Управление действиями
  • actionSets Свойство

    Массив действия устанавливает своими силами. (только для чтения)

    Объявление

    Swift

    var actionSets: [AnyObject]! { get }

    Objective C

    @property(readonly, copy, nonatomic) NSArray *actionSets

    Обсуждение

    Наборы действия являются экземплярами HMActionSet.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • addActionSetWithName (_: completionHandler:) - addActionSetWithName:completionHandler:

    Добавляет новый набор действия к дому.

    Объявление

    Swift

    func addActionSetWithName(_ actionSetName: String!, completionHandler completion: ((HMActionSet!, NSError!) -> Void)!)

    Objective C

    - (void)addActionSetWithName:(NSString *)actionSetName completionHandler:(void (^)(HMActionSet *actionSet, NSError *error))completion

    Параметры

    actionSetName

    Имя нового действия определяется. Не должен быть nil, и не должно быть имя набора действия уже своими силами.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    actionSet

    Недавно создаваемое действие установлено.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • removeActionSet (_: completionHandler:) - removeActionSet:completionHandler:

    Удаляет набор действия из дома.

    Объявление

    Swift

    func removeActionSet(_ actionSet: HMActionSet!, completionHandler completion: ((NSError!) -> Void)!)

    Objective C

    - (void)removeActionSet:(HMActionSet *)actionSet completionHandler:(void (^)(NSError *error))completion

    Параметры

    actionSet

    Набор действия для удаления.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • executeActionSet (_: completionHandler:) - executeActionSet:completionHandler:

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

    Объявление

    Swift

    func executeActionSet(_ actionSet: HMActionSet!, completionHandler completion: ((NSError!) -> Void)!)

    Objective C

    - (void)executeActionSet:(HMActionSet *)actionSet completionHandler:(void (^)(NSError *error))completion

    Параметры

    actionSet

    Набор действия для выполнения.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • triggers Свойство

    Массив триггеров, определенных своими силами. (только для чтения)

    Объявление

    Swift

    var triggers: [AnyObject]! { get }

    Objective C

    @property(readonly, copy, nonatomic) NSArray *triggers

    Обсуждение

    Триггеры являются экземплярами HMTrigger.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • addTrigger (_: completionHandler:) - addTrigger:completionHandler:

    Добавляет триггер к дому.

    Объявление

    Swift

    func addTrigger(_ trigger: HMTrigger!, completionHandler completion: ((NSError!) -> Void)!)

    Objective C

    - (void)addTrigger:(HMTrigger *)trigger completionHandler:(void (^)(NSError *error))completion

    Параметры

    trigger

    Имя нового триггера. Не должен быть nil, и не должно быть имя триггера уже своими силами.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    trigger

    Недавно создаваемый триггер.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • removeTrigger (_: completionHandler:) - removeTrigger:completionHandler:

    Удаляет триггер из дома.

    Объявление

    Swift

    func removeTrigger(_ trigger: HMTrigger!, completionHandler completion: ((NSError!) -> Void)!)

    Objective C

    - (void)removeTrigger:(HMTrigger *)trigger completionHandler:(void (^)(NSError *error))completion

    Параметры

    trigger

    Триггер для удаления.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа.

    Обсуждение

    Если trigger включен, удалять его из дома отключает его.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

Управление пользователями
  • addUserWithCompletionHandler (_:) - addUserWithCompletionHandler:

    Добавляет пользователь к дому.

    Объявление

    Swift

    func addUserWithCompletionHandler(_ completion: ((HMUser!, NSError!) -> Void)!)

    Objective C

    - (void)addUserWithCompletionHandler:(void (^)(HMUser *user, NSError *error))completion

    Параметры

    completion

    Блок выполнился после того, как запрос обрабатывается.

    user

    Пользователь, добавленный к дому.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа. error.userInfo[HMUserFailedAccessoriesKey] содержит больше информации в случае отказа. Посмотрите HMUserFailedAccessoriesKey для большего количества подробных данных.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • removeUser (_: completionHandler:) - removeUser:completionHandler:

    Удаляет пользователя из дома.

    Объявление

    Swift

    func removeUser(_ user: HMUser!, completionHandler completion: ((NSError!) -> Void)!)

    Objective C

    - (void)removeUser:(HMUser *)user completionHandler:(void (^)(NSError *error))completion

    Параметры

    user

    Пользователь для удаления.

    completion

    Блок выполнился после того, как запрос обрабатывается.

    error

    nil на успехе; иначе, ошибочный объект указание причины отказа. error.userInfo[HMUserFailedAccessoriesKey] содержит больше информации в случае отказа. Посмотрите HMUserFailedAccessoriesKey для большего количества подробных данных.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • users Свойство

    Все пользователи связались с домом. (только для чтения)

    Объявление

    Swift

    var users: [AnyObject]! { get }

    Objective C

    @property(readonly, copy, nonatomic) NSArray *users

    Обсуждение

    Пользователи являются экземплярами HMUser.

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

Получение и установка делегата
  • delegate Свойство

    Делегат, получающий обновления на состоянии дома.

    Объявление

    Swift

    weak var delegate: HMHomeDelegate?

    Objective C

    @property(weak, nonatomic) id< HMHomeDelegate > delegate

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

    Objective C

    @import HomeKit;

    Swift

    import HomeKit

    Доступность

    Доступный в iOS 8.0 и позже.

Константы
  • Пользователь неработающий ключ

    Ключ для получения детализирует того, каким аксессуарам не удалось добавить или удалить пользователя.

    Объявление

    Swift

    let HMUserFailedAccessoriesKey: String

    Objective C

    NSString *const HMUserFailedAccessoriesKey;

    Константы

    • HMUserFailedAccessoriesKey

      Ключ для получения детализирует того, каким аксессуарам не удалось добавить или удалить пользователя.

      Доступный в iOS 8.0 и позже.

    Обсуждение

    Когда пользователи добавлены к или удалены из дома, аксессуары сконфигурированы с тем пользователем. Если аксессуары встретятся с ошибками, то работа будет частично успешна. Этот ключ используется для получения подробной информации, о которой аксессуары встретились с проблемами от error.userInfo. Значение для ключа является массивом словарей. Каждый словарь содержит единственный ключ, UUID аксессуара, приведшего добавить/удалить работу к сбою. Соответствующее значение NSError объект с более подробной информацией относительно причины отказа.