Package apple.homekit

Class HMService

  • All Implemented Interfaces:
    NSObject
    public class HMService
extends NSObject
    Represents a service provided by an accessory. This class represents a service provided by an accessory in the home. A service is composed of one or more characteristics that can be modified. API-Since: 8.0

    • Constructor Detail

      • HMService

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static HMService 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 HMService 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()

      • accessory

        @Nullable
public @Nullable HMAccessory accessory()
        Accessory that provides this service.

      • associatedServiceType

        @Nullable
public @Nullable java.lang.String associatedServiceType()
        For HMServiceTypeOutlet and HMServiceTypeSwitch, this is the type of the associated service. This could be any of the HomeKit Accessory Profile defined services (except HMServiceTypeOutlet or HMServiceTypeSwitch) that supports HMCharacteristicTypePowerState characteristic.

      • characteristics

        @NotNull
public @NotNull NSArray<? extends HMCharacteristic> characteristics()
        Array of HMCharacteristic objects that represents all the characteristics provided by the service.

      • isPrimaryService

        public boolean isPrimaryService()
        Indicates if this services is the primary service. Applications should use this property to show the primary service on the accessory. API-Since: 10.0

      • isUserInteractive

        public boolean isUserInteractive()
        Indicates if this service supports user interaction or not. Applications should use this property to filter out services that the users should not directly interact with, e.g. HMServiceTypeAccessoryInformation. API-Since: 9.0

      • linkedServices

        @Nullable
public @Nullable NSArray<? extends HMService> linkedServices()
        Array of HMService objects that represents all the services that the service links to. Applications should use this property to show logical grouping of services on the accessory. linkedServices will be nil when the service does not link to any other services. API-Since: 10.0

      • localizedDescription

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

      • name

        @NotNull
public @NotNull java.lang.String name()
        Name for the service. Returns the service's name that is associated with HomeKit. The initial value is the value of the name characteristic of the service, if it has one.

      • serviceType

        @NotNull
public @NotNull java.lang.String serviceType()
        The type of the service, e.g. HMServiceTypeLightbulb.

      • uniqueIdentifier

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

      • updateAssociatedServiceTypeCompletionHandler

        public void updateAssociatedServiceTypeCompletionHandler​(@Nullable
                                                         @Nullable java.lang.String serviceType,
                                                         @NotNull
                                                         @NotNull HMService.Block_updateAssociatedServiceTypeCompletionHandler completion)
        This method is used to set up the service type of the device connected to a contact sensor, switch or an outlet. This method is only valid for the services of the following types: HMServiceTypeOutlet, HMServiceTypeContactSensor and HMServiceTypeSwitch For services of type HMServiceTypeOutlet and HMServiceTypeSwitch, serviceType can be one of the HomeKit Accessory Profile defined services (except HMServiceTypeOutlet or HMServiceTypeSwitch) that supports HMCharacteristicTypePowerState characteristic. For services of type HMServiceTypeContactSensor, serviceType can be one of the following services: HMServiceTypeDoor, HMServiceTypeGarageDoorOpener, HMServiceTypeWindow and HMServiceTypeWindowCovering
        Parameters:
        serviceType - Service type of the device connected to a contact sensor/switch/outlet service.
        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.

      • updateNameCompletionHandler

        public void updateNameCompletionHandler​(@NotNull
                                        @NotNull java.lang.String name,
                                        @NotNull
                                        @NotNull HMService.Block_updateNameCompletionHandler completion)
        This method is used to change the name of the service. The new name is stored in HomeKit and not on the accessory.
        Parameters:
        name - New name for the service.
        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.