Interface AccessoryWithTargetVisibilityState
-
public interface AccessoryWithTargetVisibilityStateaccessory with target visibility state characteristics.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CompletableFuture<TargetVisibilityStateEnum>getTargetVisibilityState()Retrieves the target visibility state.CompletableFuture<Void>setTargetVisibilityState(TargetVisibilityStateEnum state)Sets the target visibility statevoidsubscribeTargetVisibilityState(HomekitCharacteristicChangeCallback callback)Subscribes to changes in t target visibility state.voidunsubscribeTargetVisibilityState()Unsubscribes from changes in the target visibility state.
-
-
-
Method Detail
-
getTargetVisibilityState
CompletableFuture<TargetVisibilityStateEnum> getTargetVisibilityState()
Retrieves the target visibility state.- Returns:
- a future that will contain the target visibility state
-
setTargetVisibilityState
CompletableFuture<Void> setTargetVisibilityState(TargetVisibilityStateEnum state) throws Exception
Sets the target visibility state- Parameters:
state- the target visibility state to set- Returns:
- a future that completes when the change is made
- Throws:
Exception- when the change cannot be made
-
subscribeTargetVisibilityState
void subscribeTargetVisibilityState(HomekitCharacteristicChangeCallback callback)
Subscribes to changes in t target visibility state.- Parameters:
callback- the function to call when the target visibility state changes.
-
unsubscribeTargetVisibilityState
void unsubscribeTargetVisibilityState()
Unsubscribes from changes in the target visibility state.
-
-