io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithConfiguredName Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hap Show documentation

Homekit Accessory Protocol for Java

There is a newer version: 2.0.7

package io.github.hapjava.accessories.optionalcharacteristic;

import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
import java.util.concurrent.CompletableFuture;

/** Accessory with configured name. */
public interface AccessoryWithConfiguredName {

  /**
   * Retrieves configured name.
   *
   * @return configured name
   */
  CompletableFuture getConfiguredName();

  /**
   * Sets the configured name
   *
   * @param name configured name
   * @return a future that completes when the change is made
   * @throws Exception when the change cannot be made
   */
  CompletableFuture setConfiguredName(String name) throws Exception;

  /**
   * Subscribes to changes in configured name.
   *
   * @param callback the function to call when the configureed name changes.
   */
  void subscribeConfiguredName(HomekitCharacteristicChangeCallback callback);

  /** Unsubscribes from changes in the configured name state. */
  void unsubscribeConfiguredName();
}