io.flic.lib

Class FlicManager

java.lang.Object

io.flic.lib.FlicManager

public final class FlicManager
extends java.lang.Object

Flic Manager. This is a singleton class used to communicate with the Flic Application. Use getInstance(Context, FlicManagerInitializedCallback, FlicManagerUninitializedCallback) or getInstance(Context, FlicManagerInitializedCallback) to retrieve a manager.

Field Summary

Fields

Modifier and Type	Field and Description
static int	GRAB_BUTTON_REQUEST_CODE Request code used in the grab button flow.

Method Summary

Methods

Modifier and Type	Method and Description
FlicButton	completeGrabButton(int requestCode, int resultCode, Intent data) Completes a grab button sequence.
static void	destroyInstance() Clean resources and unregister all callbacks.
protected void	finalize()
void	forgetButton(FlicButton button) Forget button.
FlicButton	getButtonByDeviceId(java.lang.String deviceId) Get a button by its MAC-address.
static void	getInstance(Context context, FlicManagerInitializedCallback initializedCallback) Get the singleton instance of the manager.
static void	getInstance(Context context, FlicManagerInitializedCallback initializedCallback, FlicManagerUninitializedCallback uninitializedCallback) Get the singleton instance of the manager.
java.util.List<FlicButton>	getKnownButtons() Get a copy of the internal list of buttons.
void	initiateGrabButton(Activity currentActivity) Initiate a grab button sequence.
boolean	isInitialized() Is initialized.

Methods inherited from class java.lang.Object

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

Field Detail

GRAB_BUTTON_REQUEST_CODE

public static final int GRAB_BUTTON_REQUEST_CODE

Request code used in the grab button flow.

See Also:

Constant Field Values

Method Detail

getInstance

public static void getInstance(Context context,
               FlicManagerInitializedCallback initializedCallback)

Get the singleton instance of the manager.

Parameters:

context - An application/service/activity context. Context#getApplicationContext() on this object will be the context to use.

initializedCallback - A callback that will be called with the manager as parameter.

Throws:

java.lang.AssertionError - If the Flic Application is not installed.

getInstance

public static void getInstance(Context context,
               FlicManagerInitializedCallback initializedCallback,
               FlicManagerUninitializedCallback uninitializedCallback)

Get the singleton instance of the manager.

Parameters:

context - An application/service/activity context. Context#getApplicationContext() on this object will be the context to use.

initializedCallback - A callback that will be called with the manager as parameter.

uninitializedCallback - If non-null, a callback that will be called if the Flic Application exits, or when destroyInstance() is called.

Throws:

java.lang.AssertionError - If the Flic Application is not installed.

isInitialized

public boolean isInitialized()

Is initialized.

Returns:

true if the manager has been initialized.

destroyInstance

public static void destroyInstance()

Clean resources and unregister all callbacks. Use getInstance(Context, io.flic.lib.FlicManagerInitializedCallback) to re-initialize.

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

getButtonByDeviceId

public FlicButton getButtonByDeviceId(java.lang.String deviceId)

Get a button by its MAC-address.

Parameters:

deviceId - The MAC address case insensitive.

Returns:

A button object or null if it has not been grabbed before.

getKnownButtons

public java.util.List<FlicButton> getKnownButtons()

Get a copy of the internal list of buttons.

Returns:

The list

initiateGrabButton

public void initiateGrabButton(Activity currentActivity)

Initiate a grab button sequence. Call this method to ask the Flic app to retrieve a button object. This calls startActivityForResult with the request code GRAB_BUTTON_REQUEST_CODE. The result retrieved in onActivityResult for currentActivity must be sent to the completeGrabButton method.

Parameters:

currentActivity - The current activity initiating the button grabbing.

completeGrabButton

public FlicButton completeGrabButton(int requestCode,
                            int resultCode,
                            Intent data)

Completes a grab button sequence. Call this from Activity#onActivityResult(int, int, Intent).

Parameters:

data - An intent received by onActivityResult

Returns:

The grabbed FlicButton, null on failure, if requestCode wasn't GRAB_BUTTON_REQUEST_CODE or if resultCode was not Activity#RESULT_OK.

forgetButton

public void forgetButton(FlicButton button)

Forget button. Disposes a button object and removes it from the internal list of known buttons. You will no longer get callbacks for this button.

Parameters:

button -