apple.homekit.protocol

Interface HMHomeDelegate

public interface HMHomeDelegate

This delegate receives update on the various accessories, action sets, groups and triggers managed in the home.

Method Summary

Modifier and Type	Method and Description
default void	homeDidAddAccessory(HMHome home, HMAccessory accessory) Informs the delegate of addition of an accessory to the home.
default void	homeDidAddActionSet(HMHome home, HMActionSet actionSet) Informs the delegate that an action set was added to the home.
default void	homeDidAddRoom(HMHome home, HMRoom room) Informs the delegate of addition of a room to the home.
default void	homeDidAddRoomToZone(HMHome home, HMRoom room, HMZone zone) Informs the delegate that the room was added to a zone.
default void	homeDidAddServiceGroup(HMHome home, HMServiceGroup group) Informs the delegate that a service group was added to the home.
default void	homeDidAddServiceToServiceGroup(HMHome home, HMService service, HMServiceGroup group) Informs the delegate that a service was added to a service group.
default void	homeDidAddTrigger(HMHome home, HMTrigger trigger) Informs the delegate of the addition of a trigger to the home.
default void	homeDidAddUser(HMHome home, HMUser user) Informs the delegate that a user was added to the home.
default void	homeDidAddZone(HMHome home, HMZone zone) Informs the delegate of addition of a zone to the home.
default void	homeDidEncounterErrorForAccessory(HMHome home, NSError error, HMAccessory accessory) Informs the delegate that a configured accessory encountered an error.
default void	homeDidRemoveAccessory(HMHome home, HMAccessory accessory) Informs the delegate of removal of an accessory from the home.
default void	homeDidRemoveActionSet(HMHome home, HMActionSet actionSet) Informs the delegate that an action set was removed from the home.
default void	homeDidRemoveRoom(HMHome home, HMRoom room) Informs the delegate of removal of a room from the home.
default void	homeDidRemoveRoomFromZone(HMHome home, HMRoom room, HMZone zone) Informs the delegate that the room was removed from a zone.
default void	homeDidRemoveServiceFromServiceGroup(HMHome home, HMService service, HMServiceGroup group) Informs the delegate that a service was removed from a service group.
default void	homeDidRemoveServiceGroup(HMHome home, HMServiceGroup group) Informs the delegate that a service group was removed from the home.
default void	homeDidRemoveTrigger(HMHome home, HMTrigger trigger) Informs the delegate of removal of a trigger from the home.
default void	homeDidRemoveUser(HMHome home, HMUser user) Informs the delegate that a user was removed from the home.
default void	homeDidRemoveZone(HMHome home, HMZone zone) Informs the delegate of removal of a zone from the home.
default void	homeDidUnblockAccessory(HMHome home, HMAccessory accessory) Informs the delegate that an accessory has been unblocked
default void	homeDidUpdateAccessControlForCurrentUser(HMHome home) Informs the delegate when the access control for current user has been updated.
default void	homeDidUpdateActionsForActionSet(HMHome home, HMActionSet actionSet) Informs the delegate that the actions of an action set was modified.
default void	homeDidUpdateHomeHubState(HMHome home, long homeHubState) Informs the delegate when state of the home hub changes.
default void	homeDidUpdateName(HMHome home) Informs the delegate of a change in the name of a home.
default void	homeDidUpdateNameForActionSet(HMHome home, HMActionSet actionSet) Informs the delegate that the name of an action set was modified.
default void	homeDidUpdateNameForRoom(HMHome home, HMRoom room) Informs the delegate that the name of a room was modified
default void	homeDidUpdateNameForServiceGroup(HMHome home, HMServiceGroup group) Informs the delegate that the name of a service group was modified.
default void	homeDidUpdateNameForTrigger(HMHome home, HMTrigger trigger) Informs the delegate that the name of the trigger was modified.
default void	homeDidUpdateNameForZone(HMHome home, HMZone zone) Informs the delegate that the name of a zone was modified.
default void	homeDidUpdateRoomForAccessory(HMHome home, HMRoom room, HMAccessory accessory) Informs the delegate when a new room is assigned to an accessory
default void	homeDidUpdateSupportedFeatures(HMHome home) Informs the delegate when the supported features of this home changes.
default void	homeDidUpdateTrigger(HMHome home, HMTrigger trigger) Informs the delegate whenever a trigger is updated.

Method Detail

homeDidAddAccessory

default void homeDidAddAccessory(HMHome home,
                                 HMAccessory accessory)

Informs the delegate of addition of an accessory to the home.

Parameters:

home - Sender of the message.

accessory - Accessory that was added to the home.

homeDidAddActionSet

default void homeDidAddActionSet(HMHome home,
                                 HMActionSet actionSet)

Informs the delegate that an action set was added to the home.

Parameters:

home - Sender of this message.

actionSet - Action set that was added to the home.

homeDidAddRoom

default void homeDidAddRoom(HMHome home,
                            HMRoom room)

Informs the delegate of addition of a room to the home.

Parameters:

home - Sender of the message.

room - Room that was added to the home.

homeDidAddRoomToZone

default void homeDidAddRoomToZone(HMHome home,
                                  HMRoom room,
                                  HMZone zone)

Informs the delegate that the room was added to a zone.

Parameters:

home - Sender of this message.

room - Room that was added to the zone.

zone - Zone that was modified.

homeDidAddServiceToServiceGroup

default void homeDidAddServiceToServiceGroup(HMHome home,
                                             HMService service,
                                             HMServiceGroup group)

Informs the delegate that a service was added to a service group.

Parameters:

home - Sender of this message.

service - Service that was added to the service group.

group - Service group that was modified.

homeDidAddServiceGroup

default void homeDidAddServiceGroup(HMHome home,
                                    HMServiceGroup group)

Informs the delegate that a service group was added to the home.

Parameters:

home - Sender of the message.

group - Service group that was added to the home.

homeDidAddTrigger

default void homeDidAddTrigger(HMHome home,
                               HMTrigger trigger)

Informs the delegate of the addition of a trigger to the home.

Parameters:

home - Sender of the message.

trigger - Trigger that was added to the home.

homeDidAddUser

default void homeDidAddUser(HMHome home,
                            HMUser user)

Informs the delegate that a user was added to the home.

Parameters:

home - Sender of this message.

user - User who was granted access to the home.

homeDidAddZone

default void homeDidAddZone(HMHome home,
                            HMZone zone)

Informs the delegate of addition of a zone to the home.

Parameters:

home - Sender of the message.

zone - Zone that was added to the home.

homeDidEncounterErrorForAccessory

default void homeDidEncounterErrorForAccessory(HMHome home,
                                               NSError error,
                                               HMAccessory accessory)

Informs the delegate that a configured accessory encountered an error. The delegate should check the blocked state of the accessory

Parameters:

home - Sender of this message.

error - Error encountered by accessory.

accessory - Accessory that encountered the error

homeDidRemoveAccessory

default void homeDidRemoveAccessory(HMHome home,
                                    HMAccessory accessory)

Informs the delegate of removal of an accessory from the home.

Parameters:

home - Sender of the message.

accessory - Accessory that was removed from the home.

homeDidRemoveActionSet

default void homeDidRemoveActionSet(HMHome home,
                                    HMActionSet actionSet)

Informs the delegate that an action set was removed from the home.

Parameters:

home - Sender of this message.

actionSet - Action set that was removed from the home.

homeDidRemoveRoom

default void homeDidRemoveRoom(HMHome home,
                               HMRoom room)

Informs the delegate of removal of a room from the home.

Parameters:

home - Sender of the message.

room - Room that was removed from the home.

homeDidRemoveRoomFromZone

default void homeDidRemoveRoomFromZone(HMHome home,
                                       HMRoom room,
                                       HMZone zone)

Informs the delegate that the room was removed from a zone.

Parameters:

home - Sender of this message.

room - Room that was removed from the zone.

zone - Zone that was modified.

homeDidRemoveServiceFromServiceGroup

default void homeDidRemoveServiceFromServiceGroup(HMHome home,
                                                  HMService service,
                                                  HMServiceGroup group)

Informs the delegate that a service was removed from a service group.

Parameters:

home - Sender of this message.

service - Service that was removed from the service group.

group - Service group that was modified.

homeDidRemoveServiceGroup

default void homeDidRemoveServiceGroup(HMHome home,
                                       HMServiceGroup group)

Informs the delegate that a service group was removed from the home.

Parameters:

home - Sender of the message.

group - Service group that was removed from the home.

homeDidRemoveTrigger

default void homeDidRemoveTrigger(HMHome home,
                                  HMTrigger trigger)

Informs the delegate of removal of a trigger from the home.

Parameters:

home - Sender of the message.

trigger - Trigger that was removed from the home.

homeDidRemoveUser

default void homeDidRemoveUser(HMHome home,
                               HMUser user)

Informs the delegate that a user was removed from the home.

Parameters:

home - Sender of this message.

user - User whose access was revoked from the home.

homeDidRemoveZone

default void homeDidRemoveZone(HMHome home,
                               HMZone zone)

Informs the delegate of removal of a zone from the home.

Parameters:

home - Sender of the message.

zone - Zone that was removed from the home.

homeDidUnblockAccessory

default void homeDidUnblockAccessory(HMHome home,
                                     HMAccessory accessory)

Informs the delegate that an accessory has been unblocked

Parameters:

home - Sender of this message.

accessory - Accessory that was unblocked

homeDidUpdateActionsForActionSet

default void homeDidUpdateActionsForActionSet(HMHome home,
                                              HMActionSet actionSet)

Informs the delegate that the actions of an action set was modified. This indicates that an action was added/removed or modified (value replaced)

Parameters:

home - Sender of this message.

actionSet - Action set that was modified.

homeDidUpdateNameForActionSet

default void homeDidUpdateNameForActionSet(HMHome home,
                                           HMActionSet actionSet)

Informs the delegate that the name of an action set was modified.

Parameters:

home - Sender of this message.

actionSet - Action set that was modified.

homeDidUpdateNameForRoom

default void homeDidUpdateNameForRoom(HMHome home,
                                      HMRoom room)

Informs the delegate that the name of a room was modified

Parameters:

home - Sender of this message.

room - Room that was modified.

homeDidUpdateNameForServiceGroup

default void homeDidUpdateNameForServiceGroup(HMHome home,
                                              HMServiceGroup group)

Informs the delegate that the name of a service group was modified.

Parameters:

home - Sender of this message.

group - The service group that was modfied.

homeDidUpdateNameForTrigger

default void homeDidUpdateNameForTrigger(HMHome home,
                                         HMTrigger trigger)

Informs the delegate that the name of the trigger was modified.

Parameters:

home - Sender of this message.

trigger - Trigger that was modified.

homeDidUpdateNameForZone

default void homeDidUpdateNameForZone(HMHome home,
                                      HMZone zone)

Informs the delegate that the name of a zone was modified.

Parameters:

home - Sender of this message.

zone - Zone that was modified.

homeDidUpdateRoomForAccessory

default void homeDidUpdateRoomForAccessory(HMHome home,
                                           HMRoom room,
                                           HMAccessory accessory)

Informs the delegate when a new room is assigned to an accessory

Parameters:

home - Sender of the message.

room - New room for the accessory.

accessory - Accessory that was assigned a new room.

homeDidUpdateTrigger

default void homeDidUpdateTrigger(HMHome home,
                                  HMTrigger trigger)

Informs the delegate whenever a trigger is updated. For example, this method may be invoked when a trigger is activated, when a trigger fires, or when the action sets associated with a trigger are modified.

Parameters:

home - Sender of this message.

trigger - The trigger that was updated.

homeDidUpdateName

default void homeDidUpdateName(HMHome home)

Informs the delegate of a change in the name of a home.

Parameters:

home - Sender of this message.

homeDidUpdateHomeHubState

default void homeDidUpdateHomeHubState(HMHome home,
                                       long homeHubState)

Informs the delegate when state of the home hub changes.

Parameters:

home - Sender of the message.

homeHubState - The new home hub state.

homeDidUpdateAccessControlForCurrentUser

default void homeDidUpdateAccessControlForCurrentUser(HMHome home)

Informs the delegate when the access control for current user has been updated.

Parameters:

home - Sender of the message.

homeDidUpdateSupportedFeatures

default void homeDidUpdateSupportedFeatures(HMHome home)

Informs the delegate when the supported features of this home changes.

The supported features covered by this are currently: - supportsAddingNetworkRouter

Parameters:

home - Sender of the message.