io.flic.lib

Class FlicButtonCallback

java.lang.Object

io.flic.lib.FlicButtonCallback

public class FlicButtonCallback
extends java.lang.Object

FlicButtonCallback Callbacks for button updates. You should extend this class and implement the callbacks you want.

Constructor Summary

Constructors

Constructor and Description
FlicButtonCallback()

Method Summary

Methods

Modifier and Type	Method and Description
void	onButtonClickOrHold(FlicButton button, boolean wasQueued, int timeDiff, boolean isClick, boolean isHold) Used for the scenario where you want to listen on button click and hold.
void	onButtonSingleOrDoubleClick(FlicButton button, boolean wasQueued, int timeDiff, boolean isSingleClick, boolean isDoubleClick) Used for the scenario where you want to listen on single click and double click.
void	onButtonSingleOrDoubleClickOrHold(FlicButton button, boolean wasQueued, int timeDiff, boolean isSingleClick, boolean isDoubleClick, boolean isHold) Used for the scenario where you want to listen on single click, double click and hold.
void	onButtonUpOrDown(FlicButton button, boolean wasQueued, int timeDiff, boolean isUp, boolean isDown) Called when the button was pressed or released.
void	onConnectionCompleted(FlicButton button) Called when the connection to the button has been established and is ready to use.
void	onConnectionFailed(FlicButton button, int status) Called if there was a problem establishing a Bluetooth connection to the button.
void	onConnectionStarted(FlicButton button) Called when the Bluetooth connection has just been started.
void	onDisconnect(FlicButton button, int flicError) Called when the Bluetooth connection was disconnected, for example if the button becomes out of range or the user manually disconnecting this button in the Flic Application.
void	onReadRemoteRSSI(FlicButton button, int rssi, int status) Called as a result of FlicButton.readRemoteRSSI().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlicButtonCallback

public FlicButtonCallback()

Method Detail

onConnectionStarted

public void onConnectionStarted(FlicButton button)

Called when the Bluetooth connection has just been started. It's not ready for use yet however - onConnectionCompleted(FlicButton) will be called when ready.

Parameters:

button - The button

onConnectionFailed

public void onConnectionFailed(FlicButton button,
                      int status)

Called if there was a problem establishing a Bluetooth connection to the button. Happens very rarely.

Parameters:

button - The button

status - A Bluetooth GATT status.

onDisconnect

public void onDisconnect(FlicButton button,
                int flicError)

Called when the Bluetooth connection was disconnected, for example if the button becomes out of range or the user manually disconnecting this button in the Flic Application.

Parameters:

button - The button

flicError - An error

onConnectionCompleted

public void onConnectionCompleted(FlicButton button)

Called when the connection to the button has been established and is ready to use.

Parameters:

button - The button

onReadRemoteRSSI

public void onReadRemoteRSSI(FlicButton button,
                    int rssi,
                    int status)

Called as a result of FlicButton.readRemoteRSSI().

Parameters:

button - The button

rssi - RSSI value for the remote device

status - 0 if the RSSI was read successfully

onButtonUpOrDown

public void onButtonUpOrDown(FlicButton button,
                    boolean wasQueued,
                    int timeDiff,
                    boolean isUp,
                    boolean isDown)

Called when the button was pressed or released.

Parameters:

button - The button

wasQueued - If the event was locally queued in the button because it was disconnected. After the connection is completed, the event will be sent with this parameter set to true.

timeDiff - If the event was queued, the timeDiff will be the number of seconds since the event happened.

isUp - True if up, else false

isDown - True if down, else false

onButtonClickOrHold

public void onButtonClickOrHold(FlicButton button,
                       boolean wasQueued,
                       int timeDiff,
                       boolean isClick,
                       boolean isHold)

Used for the scenario where you want to listen on button click and hold.

Parameters:

button - The button

wasQueued - If the event was locally queued in the button because it was disconnected. After the connection is completed, the event will be sent with this parameter set to true.

timeDiff - If the event was queued, the timeDiff will be the number of seconds since the event happened.

isClick - True if click, else false

isHold - True if hold, else false

onButtonSingleOrDoubleClick

public void onButtonSingleOrDoubleClick(FlicButton button,
                               boolean wasQueued,
                               int timeDiff,
                               boolean isSingleClick,
                               boolean isDoubleClick)

Used for the scenario where you want to listen on single click and double click. Single clicks might be delayed for up to 0.5 seconds because we can't be sure if it was rather a double click or not until then.

Parameters:

button - The button

wasQueued - If the event was locally queued in the button because it was disconnected. After the connection is completed, the event will be sent with this parameter set to true.

timeDiff - If the event was queued, the timeDiff will be the number of seconds since the event happened.

isSingleClick - True if single click, else false

isDoubleClick - True if double click, else false

onButtonSingleOrDoubleClickOrHold

public void onButtonSingleOrDoubleClickOrHold(FlicButton button,
                                     boolean wasQueued,
                                     int timeDiff,
                                     boolean isSingleClick,
                                     boolean isDoubleClick,
                                     boolean isHold)

Used for the scenario where you want to listen on single click, double click and hold. Single clicks might be delayed for up to 0.5 seconds because we can't be sure if it was rather a double click or not until then.

Parameters:

button - The button

wasQueued - If the event was locally queued in the button because it was disconnected. After the connection is completed, the event will be sent with this parameter set to true.

timeDiff - If the event was queued, the timeDiff will be the number of seconds since the event happened.

isSingleClick - True if single click, else false

isDoubleClick - True if double click, else false

isHold - True if hold, else false