io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithAccessoryFlags 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 io.github.hapjava.characteristics.impl.accessoryinformation.AccessoryFlagsEnum;
import java.util.concurrent.CompletableFuture;

/** Accessory with accessory flags, which indicates that additional setup is required */
public interface AccessoryWithAccessoryFlags {

  /**
   * When set indicates accessory requires additional setup.
   *
   * @return a future that will contain the accessory flags
   */
  CompletableFuture getAccessoryFlags();

  /**
   * Subscribes to changes in accessory flags
   *
   * @param callback the function to call when the accessory flags changes.
   */
  void subscribeAccessoryFlags(HomekitCharacteristicChangeCallback callback);

  /** Unsubscribes from changes in the accessory flags . */
  void unsubscribeAccessoryFlags();
}