Package apple.homekit

Class HMCharacteristic

  • All Implemented Interfaces:
    NSObject
    public class HMCharacteristic
extends NSObject
    Represent a characteristic on a service of an accessory. API-Since: 8.0

    • Constructor Detail

      • HMCharacteristic

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static HMCharacteristic 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)

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

      • characteristicType

        @NotNull
public @NotNull java.lang.String characteristicType()
        The type of the characteristic, e.g. HMCharacteristicTypePowerState.

      • enableNotificationCompletionHandler

        public void enableNotificationCompletionHandler​(boolean enable,
                                                @NotNull
                                                @NotNull HMCharacteristic.Block_enableNotificationCompletionHandler completion)
        Enables/disables notifications or indications for the value of a specified characteristic.
        Parameters:
        enable - A Boolean value indicating whether you wish to receive notifications or indications whenever the characteristic’s value changes.
        completion - Block that is invoked once the request is processed. The NSError provides more information on the status of the request, error will be nil on success.

      • isNotificationEnabled

        public boolean isNotificationEnabled()
        Specifies whether the characteristic has been enabled to send notifications. This property is reset to NO if the reachability of the accessory is NO.

      • localizedDescription

        @NotNull
public @NotNull java.lang.String localizedDescription()
        The localized description of the characteristic. API-Since: 9.0

      • metadata

        @Nullable
public @Nullable HMCharacteristicMetadata metadata()
        Meta data associated with the characteristic.

      • properties

        @NotNull
public @NotNull NSArray<java.lang.String> properties()
        Array that describes the properties of the characteristic. This value corresponds to the properties associated with this characteristic. The contents of the array are one or more HMCharacteristicProperty constants.

      • readValueWithCompletionHandler

        public void readValueWithCompletionHandler​(@NotNull
                                           @NotNull HMCharacteristic.Block_readValueWithCompletionHandler completion)
        Reads the value of the characteristic. The updated value can be read from the 'value' property of the characteristic.
        Parameters:
        completion - Block that is invoked once the request is processed. The NSError provides more information on the status of the request, error will be nil on success.

      • service

        @Nullable
public @Nullable HMService service()
        Service that contains this characteristic.

      • uniqueIdentifier

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

      • updateAuthorizationDataCompletionHandler

        public void updateAuthorizationDataCompletionHandler​(@Nullable
                                                     @Nullable NSData data,
                                                     @NotNull
                                                     @NotNull HMCharacteristic.Block_updateAuthorizationDataCompletionHandler completion)
        Sets/clears authorization data used when writing to the characteristic.
        Parameters:
        data - New authorization data to use. Specify nil to remove authorization data.
        completion - Block that is invoked once the request is processed. The NSError provides more information on the status of the request, error will be nil on success.

      • value

        @Nullable
public @Nullable java.lang.Object value()
        The value of the characteristic. The value is a cached value that may have been updated as a result of prior interaction with the accessory.

      • writeValueCompletionHandler

        public void writeValueCompletionHandler​(@Nullable
                                        @Nullable java.lang.Object value,
                                        @NotNull
                                        @NotNull HMCharacteristic.Block_writeValueCompletionHandler completion)
        Modifies the value of the characteristic. The value being written is validated against the metadata, format and permissions. The value written may be bounded by metadata for characteristics with int and float format. If validation fails, the error provided to the completion handler indicates the type of failure.
        Parameters:
        value - The value to be written.
        completion - Block that is invoked once the request is processed. The NSError provides more information on the status of the request, error will be nil on success.

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.