Package apple.matter

Class MTRSubscribeParams

  • All Implemented Interfaces:
    NSCopying, NSObject
    public class MTRSubscribeParams
extends MTRReadParams
    MTRSubscribeParams This is used to control the behavior of attribute/event subscribes. If not provided (i.e. nil passed for the MTRSubscribeParams argument), will be treated as if a default-initialized object was passed in.

    • Constructor Detail

      • MTRSubscribeParams

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

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

      • autoResubscribe

        @Deprecated
@Nullable
public @Nullable NSNumber autoResubscribe()
        Deprecated.
        API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use resubscribeAutomatically

      • 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()

      • init

        @Deprecated
public MTRSubscribeParams init()
        Deprecated.
        init and new exist for now, for backwards compatibility, and initialize with minInterval set to 1 and maxInterval set to 0, which will not work on its own. Uses of MTRSubscribeParams that rely on init must all be using (deprecated) APIs that pass in a separate minInterval and maxInterval. API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use initWithMinInterval
        Overrides:
        init in class MTRReadParams

      • initWithMinIntervalMaxInterval

        public MTRSubscribeParams initWithMinIntervalMaxInterval​(@NotNull
                                                         @NotNull NSNumber minInterval,
                                                         @NotNull
                                                         @NotNull NSNumber maxInterval)
        Initialize an MTRSubscribeParams. Must provide a minInterval and maxInterval; there are no default values for those.

      • 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)

      • keepPreviousSubscriptions

        @Deprecated
@Nullable
public @Nullable NSNumber keepPreviousSubscriptions()
        Deprecated.
        API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use replaceExistingSubscriptions

      • keyPathsForValuesAffectingValueForKey

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

      • maxInterval

        @NotNull
public @NotNull NSNumber maxInterval()
        The suggested maximum time, in seconds, during which the server is allowed to send no reports at all for this subscription. Must be at least as large as minInterval. The server is allowed to use a larger time than this as the maxInterval it selects if it needs to (e.g. to meet its power budget). API-Since: 16.4

      • minInterval

        @NotNull
public @NotNull NSNumber minInterval()
        The minimum time, in seconds, between consecutive reports a server will send for this subscription. This can be used to rate-limit the subscription traffic. Any non-negative value is allowed, including 0. API-Since: 16.4

      • new_objc

        @Deprecated
public static MTRSubscribeParams new_objc()
        Deprecated.
        API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use initWithMinInterval

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • setAutoResubscribe

        @Deprecated
public void setAutoResubscribe​(@Nullable
                               @Nullable NSNumber value)
        Deprecated.
        API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use resubscribeAutomatically

      • setKeepPreviousSubscriptions

        @Deprecated
public void setKeepPreviousSubscriptions​(@Nullable
                                         @Nullable NSNumber value)
        Deprecated.
        API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use replaceExistingSubscriptions

      • setMaxInterval

        public void setMaxInterval​(@NotNull
                           @NotNull NSNumber value)
        The suggested maximum time, in seconds, during which the server is allowed to send no reports at all for this subscription. Must be at least as large as minInterval. The server is allowed to use a larger time than this as the maxInterval it selects if it needs to (e.g. to meet its power budget). API-Since: 16.4

      • setMinInterval

        public void setMinInterval​(@NotNull
                           @NotNull NSNumber value)
        The minimum time, in seconds, between consecutive reports a server will send for this subscription. This can be used to rate-limit the subscription traffic. Any non-negative value is allowed, including 0. API-Since: 16.4

      • setReplaceExistingSubscriptions

        public void setReplaceExistingSubscriptions​(boolean value)
        Whether the subscribe should replace already-existing subscriptions. The default value is YES. If YES, the subscribe will cancel any existing subscriptions to the target node when it sets up the new one. If NO, the subscribe will allow any previous subscriptions to remain. API-Since: 16.4

      • setReportEventsUrgently

        public void setReportEventsUrgently​(boolean value)
        Controls whether events will be reported urgently. The default value is YES. If YES, the events will be reported as soon as the minInterval does not prevent it. If NO, the events will be reported at the maximum interval. API-Since: 16.4

      • setResubscribeAutomatically

        public void setResubscribeAutomatically​(boolean value)
        Whether the subscription should automatically try to re-establish if it drops. The default value is YES. If NO, loss of subscription will simply lead to an error report. Some subscription APIs do not support this value. If YES, loss of subscription will lead to an automatic resubscription attempt. If this succeeds, the subscriptionEstablished callback will be called again. API-Since: 16.4

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • shouldReplaceExistingSubscriptions

        public boolean shouldReplaceExistingSubscriptions()
        Whether the subscribe should replace already-existing subscriptions. The default value is YES. If YES, the subscribe will cancel any existing subscriptions to the target node when it sets up the new one. If NO, the subscribe will allow any previous subscriptions to remain. API-Since: 16.4

      • shouldReportEventsUrgently

        public boolean shouldReportEventsUrgently()
        Controls whether events will be reported urgently. The default value is YES. If YES, the events will be reported as soon as the minInterval does not prevent it. If NO, the events will be reported at the maximum interval. API-Since: 16.4

      • shouldResubscribeAutomatically

        public boolean shouldResubscribeAutomatically()
        Whether the subscription should automatically try to re-establish if it drops. The default value is YES. If NO, loss of subscription will simply lead to an error report. Some subscription APIs do not support this value. If YES, loss of subscription will lead to an automatic resubscription attempt. If this succeeds, the subscriptionEstablished callback will be called again. API-Since: 16.4

      • superclass_static

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

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.

      • version_static

        public static long version_static()