Package apple.homekit

Class HMTrigger

  • All Implemented Interfaces:
    NSObject
    Direct Known Subclasses:
    HMEventTrigger, HMTimerTrigger
    public class HMTrigger
extends NSObject
    Represents a trigger event. This class describes a trigger which is an event that can be used to execute one or more action sets when the event fires. API-Since: 8.0

    • Constructor Detail

      • HMTrigger

        protected HMTrigger​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static HMTrigger allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • new_objc

        public static HMTrigger new_objc()

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • actionSets

        @NotNull
public @NotNull NSArray<? extends HMActionSet> actionSets()
        Array of HMActionSet objects that represent all the action sets associated with this trigger.

      • addActionSetCompletionHandler

        public void addActionSetCompletionHandler​(@NotNull
                                          @NotNull HMActionSet actionSet,
                                          @NotNull
                                          @NotNull HMTrigger.Block_addActionSetCompletionHandler completion)
        Registers an action set to be executed when the trigger is fired.
        Parameters:
        actionSet - HMActionSet to execute when the trigger fires. The order of execution of the action set is not guaranteed.
        completion - Block that is invoked once the request is processed. The NSError provides more information on the status of the request.

      • enableCompletionHandler

        public void enableCompletionHandler​(boolean enable,
                                    @NotNull
                                    @NotNull HMTrigger.Block_enableCompletionHandler completion)
        Enables or disables the trigger. In order for the trigger to be enabled the following criteria must be met: 1. The trigger must be added to a home. 2. The trigger must have at least one action set associated with it. 3. Each action set added to the trigger must have at least one action. 4. For HMTimerTrigger: The next fire date of the timer trigger must be less than 5 weeks in the future. The fire date of a one-shot timer trigger must be in the future.
        Parameters:
        enable - Setting this to TRUE will enable the trigger, FALSE will disable it.
        completion - Block that is invoked once the request is processed. The NSError provides more information on the status of the request.

      • isEnabled

        public boolean isEnabled()
        State of the trigger. TRUE if the trigger is enable, FALSE otherwise.

      • lastFireDate

        @Deprecated
@Nullable
public @Nullable NSDate lastFireDate()
        Deprecated.
        The date that this trigger was most recently fired. API-Since: 8.0 Deprecated-Since: 17.0 Deprecated-Message: No longer supported

      • name

        @NotNull
public @NotNull java.lang.String name()
        Name of the trigger.

      • removeActionSetCompletionHandler

        public void removeActionSetCompletionHandler​(@NotNull
                                             @NotNull HMActionSet actionSet,
                                             @NotNull
                                             @NotNull HMTrigger.Block_removeActionSetCompletionHandler completion)
        De-registers an action set from the trigger.
        Parameters:
        actionSet - The HMActionSet to disassociate from the trigger.
        completion - Block that is invoked once the request is processed. The NSError provides more information on the status of the request.

      • uniqueIdentifier

        @NotNull
public @NotNull NSUUID uniqueIdentifier()
        A unique identifier for the trigger. API-Since: 9.0

      • updateNameCompletionHandler

        public void updateNameCompletionHandler​(@NotNull
                                        @NotNull java.lang.String name,
                                        @NotNull
                                        @NotNull HMTrigger.Block_updateNameCompletionHandler completion)
        This method is used to change the name of the trigger.
        Parameters:
        name - New name for the trigger.
        completion - Block that is invoked once the request is processed. The NSError provides more information on the status of the request.

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.