io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithLockTargetState 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.lock.LockTargetStateEnum;
import java.util.concurrent.CompletableFuture;

/** Accessory with lock target state. */
public interface AccessoryWithLockTargetState {

  /**
   * Retrieves the lock states. The target state of the physical security mechanism (e.g. deadbolt)
   *
   * @return a future with the value
   */
  CompletableFuture getLockTargetState();

  /**
   * Sets the lock target state
   *
   * @param state the target state to set
   * @return a future that completes when the change is made
   * @throws Exception when the change cannot be made
   */
  CompletableFuture setLockTargetState(LockTargetStateEnum state) throws Exception;

  /**
   * Subscribes to changes in lock target state.
   *
   * @param callback the function when the lock target state changes
   */
  void subscribeLockTargetState(HomekitCharacteristicChangeCallback callback);

  /** Unsubscribes from changes */
  void unsubscribeLockTargetState();
}