apple.homekit

Class HMCharacteristic

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.homekit.HMCharacteristic

All Implemented Interfaces:

NSObject

public class HMCharacteristic
extends NSObject

Represent a characteristic on a service of an accessory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HMCharacteristic.Block_enableNotificationCompletionHandler
static interface	HMCharacteristic.Block_readValueWithCompletionHandler
static interface	HMCharacteristic.Block_updateAuthorizationDataCompletionHandler
static interface	HMCharacteristic.Block_writeValueCompletionHandler

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static boolean	accessInstanceVariablesDirectly()
static HMCharacteristic	alloc()
static HMCharacteristic	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
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)
java.lang.String	characteristicType() The type of the characteristic, e.g.
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()
void	enableNotificationCompletionHandler(boolean enable, HMCharacteristic.Block_enableNotificationCompletionHandler completion) Enables/disables notifications or indications for the value of a specified characteristic.
static long	hash_static()
HMCharacteristic	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	isNotificationEnabled() Specifies whether the characteristic has been enabled to send notifications.
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
static NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
java.lang.String	localizedDescription() The localized description of the characteristic.
HMCharacteristicMetadata	metadata() Meta data associated with the characteristic.
static HMCharacteristic	new_objc()
NSArray<java.lang.String>	properties() Array that describes the properties of the characteristic.
void	readValueWithCompletionHandler(HMCharacteristic.Block_readValueWithCompletionHandler completion) Reads the value of the characteristic.
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
HMService	service() Service that contains this characteristic.
static void	setVersion_static(long aVersion)
static org.moe.natj.objc.Class	superclass_static()
NSUUID	uniqueIdentifier() A unique identifier for the characteristic.
void	updateAuthorizationDataCompletionHandler(NSData data, HMCharacteristic.Block_updateAuthorizationDataCompletionHandler completion) Sets/clears authorization data used when writing to the characteristic.
java.lang.Object	value() The value of the characteristic.
static long	version_static()
void	writeValueCompletionHandler(java.lang.Object value, HMCharacteristic.Block_writeValueCompletionHandler completion) Modifies the value of the characteristic.

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

HMCharacteristic

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

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static HMCharacteristic alloc()

allocWithZone

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

characteristicType

public java.lang.String characteristicType()

The type of the characteristic, e.g. HMCharacteristicTypePowerState.

enableNotificationCompletionHandler

public void enableNotificationCompletionHandler(boolean enable,
                                                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.

init

public HMCharacteristic init()

Overrides:

init in class NSObject

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

public java.lang.String localizedDescription()

The localized description of the characteristic.

metadata

public HMCharacteristicMetadata metadata()

Meta data associated with the characteristic.

properties

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

public HMService service()

Service that contains this characteristic.

uniqueIdentifier

public NSUUID uniqueIdentifier()

A unique identifier for the characteristic.

updateAuthorizationDataCompletionHandler

public void updateAuthorizationDataCompletionHandler(NSData data,
                                                     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

public 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(java.lang.Object value,
                                        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.