Package io.github.zeroone3010.yahueapi.v2

Interface Button

All Known Implementing Classes:
ButtonImpl
public interface Button
A button of a Switch.
Since:
3.0.0

  • Method Summary

    Modifier and Type Method Description
    UUID getId()
    Returns the technical id of the button, as assigned by the Bridge.
    Optional<ButtonEventType> getLatestEvent()
    The latest event that this button has emitted.
    int getNumber()
    The number of this button in a switch.
    Switch getOwner()
    Returns the Switch that this Button belongs to.

  • Method Details

    • getId

      UUID getId()

      Returns the technical id of the button, as assigned by the Bridge.

      Returns:
      Id of the button.

    • getNumber

      int getNumber()

      The number of this button in a switch.

      Returns:
      An integer describing the number of this button.

    • getOwner

      Switch getOwner()
      Returns the Switch that this Button belongs to.
      Returns:
      The Switch that owns this button.

    • getLatestEvent

      Optional<ButtonEventType> getLatestEvent()

      The latest event that this button has emitted.

      Returns:
      An enumeration describing the latest event from this particular button. May be empty if this was not the last button to be pressed in its switch.