Package 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. API-Since: 8.0

    • Method Detail

      • homeDidAddAccessory

        default void homeDidAddAccessory​(@NotNull
                                 @NotNull HMHome home,
                                 @NotNull
                                 @NotNull 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​(@NotNull
                                 @NotNull HMHome home,
                                 @NotNull
                                 @NotNull 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​(@NotNull
                            @NotNull HMHome home,
                            @NotNull
                            @NotNull 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​(@NotNull
                                  @NotNull HMHome home,
                                  @NotNull
                                  @NotNull HMRoom room,
                                  @NotNull
                                  @NotNull 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​(@NotNull
                                             @NotNull HMHome home,
                                             @NotNull
                                             @NotNull HMService service,
                                             @NotNull
                                             @NotNull 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​(@NotNull
                                    @NotNull HMHome home,
                                    @NotNull
                                    @NotNull 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​(@NotNull
                               @NotNull HMHome home,
                               @NotNull
                               @NotNull 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​(@NotNull
                            @NotNull HMHome home,
                            @NotNull
                            @NotNull 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​(@NotNull
                            @NotNull HMHome home,
                            @NotNull
                            @NotNull 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​(@NotNull
                                               @NotNull HMHome home,
                                               @NotNull
                                               @NotNull NSError error,
                                               @NotNull
                                               @NotNull 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​(@NotNull
                                    @NotNull HMHome home,
                                    @NotNull
                                    @NotNull 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​(@NotNull
                                    @NotNull HMHome home,
                                    @NotNull
                                    @NotNull 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​(@NotNull
                               @NotNull HMHome home,
                               @NotNull
                               @NotNull 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​(@NotNull
                                       @NotNull HMHome home,
                                       @NotNull
                                       @NotNull HMRoom room,
                                       @NotNull
                                       @NotNull 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​(@NotNull
                                                  @NotNull HMHome home,
                                                  @NotNull
                                                  @NotNull HMService service,
                                                  @NotNull
                                                  @NotNull 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​(@NotNull
                                       @NotNull HMHome home,
                                       @NotNull
                                       @NotNull 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​(@NotNull
                                  @NotNull HMHome home,
                                  @NotNull
                                  @NotNull 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​(@NotNull
                               @NotNull HMHome home,
                               @NotNull
                               @NotNull 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​(@NotNull
                               @NotNull HMHome home,
                               @NotNull
                               @NotNull 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​(@NotNull
                                     @NotNull HMHome home,
                                     @NotNull
                                     @NotNull 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​(@NotNull
                                              @NotNull HMHome home,
                                              @NotNull
                                              @NotNull 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​(@NotNull
                                           @NotNull HMHome home,
                                           @NotNull
                                           @NotNull 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​(@NotNull
                                      @NotNull HMHome home,
                                      @NotNull
                                      @NotNull 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​(@NotNull
                                              @NotNull HMHome home,
                                              @NotNull
                                              @NotNull 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​(@NotNull
                                         @NotNull HMHome home,
                                         @NotNull
                                         @NotNull 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​(@NotNull
                                      @NotNull HMHome home,
                                      @NotNull
                                      @NotNull 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​(@NotNull
                                           @NotNull HMHome home,
                                           @NotNull
                                           @NotNull HMRoom room,
                                           @NotNull
                                           @NotNull 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​(@NotNull
                                  @NotNull HMHome home,
                                  @NotNull
                                  @NotNull 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​(@NotNull
                               @NotNull HMHome home)
        Informs the delegate of a change in the name of a home.
        Parameters:
        home - Sender of this message.

      • homeDidUpdateHomeHubState

        default void homeDidUpdateHomeHubState​(@NotNull
                                       @NotNull 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. API-Since: 11.0

      • homeDidUpdateAccessControlForCurrentUser

        default void homeDidUpdateAccessControlForCurrentUser​(@NotNull
                                                      @NotNull HMHome home)
        Informs the delegate when the access control for current user has been updated.
        Parameters:
        home - Sender of the message. API-Since: 11.0

      • homeDidUpdateSupportedFeatures

        default void homeDidUpdateSupportedFeatures​(@NotNull
                                            @NotNull 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. API-Since: 13.2