apple.homekit

Class HMService

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.homekit.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HMService.Block_updateAssociatedServiceTypeCompletionHandler
static interface	HMService.Block_updateNameCompletionHandler

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HMService(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
static boolean	accessInstanceVariablesDirectly()
HMAccessory	accessory() Accessory that provides this service.
static HMService	alloc()
static HMService	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
java.lang.String	associatedServiceType() For HMServiceTypeOutlet and HMServiceTypeSwitch, this is the type of the associated service.
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
static void	cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)
NSArray<? extends HMCharacteristic>	characteristics() Array of HMCharacteristic objects that represents all the characteristics provided by the service.
static NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static org.moe.natj.objc.Class	classForKeyedUnarchiver()
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
static long	hash_static()
HMService	init()
static NSObject.Function_instanceMethodForSelector_ret	instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
static NSMethodSignature	instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
static boolean	instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
boolean	isPrimaryService() Indicates if this services is the primary service.
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
boolean	isUserInteractive() Indicates if this service supports user interaction or not.
static NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
NSArray<? extends HMService>	linkedServices() Array of HMService objects that represents all the services that the service links to.
java.lang.String	localizedDescription() The localized description of the service.
java.lang.String	name() Name for the service.
static HMService	new_objc()
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
java.lang.String	serviceType() The type of the service, e.g.
static void	setVersion_static(long aVersion)
static org.moe.natj.objc.Class	superclass_static()
NSUUID	uniqueIdentifier() A unique identifier for the service.
void	updateAssociatedServiceTypeCompletionHandler(java.lang.String serviceType, 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.
void	updateNameCompletionHandler(java.lang.String name, HMService.Block_updateNameCompletionHandler completion) This method is used to change the name of the service.
static long	version_static()

Methods inherited from class apple.NSObject

accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject

equals, toString

Methods inherited from class org.moe.natj.general.NativeObject

finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HMService

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

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static HMService alloc()

allocWithZone

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

automaticallyNotifiesObserversForKey

public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)

cancelPreviousPerformRequestsWithTarget

public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)

cancelPreviousPerformRequestsWithTargetSelectorObject

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

classFallbacksForKeyedArchiver

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

classForKeyedUnarchiver

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

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

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

public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(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

public HMAccessory accessory()

Accessory that provides this service.

associatedServiceType

public 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

public NSArray<? extends HMCharacteristic> characteristics()

Array of HMCharacteristic objects that represents all the characteristics provided by the service.

init

public HMService init()

Overrides:

init in class NSObject

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.

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.

linkedServices

public 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.

localizedDescription

public java.lang.String localizedDescription()

The localized description of the service.

name

public 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

public java.lang.String serviceType()

The type of the service, e.g. HMServiceTypeLightbulb.

uniqueIdentifier

public NSUUID uniqueIdentifier()

A unique identifier for the service.

updateAssociatedServiceTypeCompletionHandler

public void updateAssociatedServiceTypeCompletionHandler(java.lang.String serviceType,
                                                         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(java.lang.String name,
                                        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.