Interface AccessoryWithConfiguredName
-
public interface AccessoryWithConfiguredName
Accessory with configured name.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.concurrent.CompletableFuture<java.lang.String>
getConfiguredName()
Retrieves configured name.java.util.concurrent.CompletableFuture<java.lang.Void>
setConfiguredName(java.lang.String name)
Sets the configured namevoid
subscribeConfiguredName(HomekitCharacteristicChangeCallback callback)
Subscribes to changes in configured name.void
unsubscribeConfiguredName()
Unsubscribes from changes in the configured name state.
-
-
-
Method Detail
-
getConfiguredName
java.util.concurrent.CompletableFuture<java.lang.String> getConfiguredName()
Retrieves configured name.- Returns:
- configured name
-
setConfiguredName
java.util.concurrent.CompletableFuture<java.lang.Void> setConfiguredName(java.lang.String name) throws java.lang.Exception
Sets the configured name- Parameters:
name
- configured name- Returns:
- a future that completes when the change is made
- Throws:
java.lang.Exception
- when the change cannot be made
-
subscribeConfiguredName
void subscribeConfiguredName(HomekitCharacteristicChangeCallback callback)
Subscribes to changes in configured name.- Parameters:
callback
- the function to call when the configureed name changes.
-
unsubscribeConfiguredName
void unsubscribeConfiguredName()
Unsubscribes from changes in the configured name state.
-
-