com.idevicesinc.sweetblue.utils

Class BluetoothEnabler

java.lang.Object

com.idevicesinc.sweetblue.utils.BluetoothEnabler

public class BluetoothEnabler
extends Object

This class is used to handle the new hairy logic for getting bluetooth low-energy scan results that is introduced with Build.VERSION_CODES.M. With Build.VERSION_CODES.M you need to have Manifest.permission.ACCESS_COARSE_LOCATION or Manifest.permission.ACCESS_FINE_LOCATION in your AndroidManifest.xml, and also enable them at runtime, AND also make sure location services are on.

See more information at https://github.com/iDevicesInc/SweetBlue/wiki/Android-BLE-Issues#android-m-issues

This class is simply a convenience that wraps various helper methods of BleManager (see the "See Also" section, which has enough links that it might give you an idea of why BluetoothEnabler was written). As such you don't need to use it, but in combination with BluetoothEnabler.DefaultBluetoothEnablerFilter it comes in handy as a one-line addition to most simple apps.

See Also:

BleManager.isLocationEnabledForScanning(), BleManager.isLocationEnabledForScanning_byManifestPermissions(), BleManager.isLocationEnabledForScanning_byRuntimePermissions(), BleManager.isLocationEnabledForScanning_byOsServices(), BleManager.turnOnLocationWithIntent_forPermissions(Activity, int), BleManager.turnOnLocationWithIntent_forOsServices(Activity, int), BleManager.turnOnWithIntent(Activity, int), BleManager.willLocationPermissionSystemDialogBeShown(Activity), https://github.com/iDevicesInc/SweetBlue/wiki/Android-BLE-Issues#android-m-issues

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BluetoothEnabler.BluetoothEnablerFilter Provide an implementation to BluetoothEnabler(Activity, BluetoothEnablerFilter) to receive callbacks or simply use the provided class BluetoothEnabler.DefaultBluetoothEnablerFilter by calling start(Activity).
static class	BluetoothEnabler.DefaultBluetoothEnablerFilter A default implementation of BluetoothEnablerListener used in start(Activity).

Method Summary

Modifier and Type	Method and Description
BluetoothEnabler.BluetoothEnablerFilter.Stage	getStage() Returns the current BluetoothEnabler.BluetoothEnablerFilter.Stage the enabler is on
boolean	isDone()
boolean	isEnabled(BluetoothEnabler.BluetoothEnablerFilter.Stage stage) Returns whether the passed BluetoothEnabler.BluetoothEnablerFilter.Stage has been enabled.
boolean	isPerformingSystemCall()
static void	onActivityOrPermissionResult_static(int requestCode) Static equivalent of onActivityOrPermissionResult(int) that you can use to call down into the singleton created by start(Activity, BluetoothEnablerFilter) (or overloads).
void	onActivityOrPermissionResult(int requestCode) A potentially-required method to be placed in your activity's Activity.onRequestPermissionsResult(int, String[], int[]) and Activity.onActivityResult(int, int, Intent) methods.
static void	resume_static(BluetoothEnabler.BluetoothEnablerFilter.Please please) Static equivalent of resume(BluetoothEnablerFilter.Please) that you can use to call down into the singleton created by start(Activity, BluetoothEnablerFilter) (or overloads).
void	resume(BluetoothEnabler.BluetoothEnablerFilter.Please please) Resume the enabler with the given Please.
static BluetoothEnabler	start(Activity activity) Overload of start(Activity, BluetoothEnablerFilter) that uses an instance of BluetoothEnabler.DefaultBluetoothEnablerFilter.
static BluetoothEnabler	start(Activity activity, BluetoothEnabler.BluetoothEnablerFilter filter) Kicks off the complex flow needed to fully enable Bluetooth on Build versions greater than or equal to Build.VERSION_CODES.M.
static BluetoothEnabler	start(Context context) Overload of start(Activity) but given Context must be an Activity.
static BluetoothEnabler	start(Context context, BluetoothEnabler.BluetoothEnablerFilter filter) Overload of start(Activity, BluetoothEnablerFilter) but given Context must be an Activity.

Methods inherited from class java.lang.Object

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

Method Detail

start

public static BluetoothEnabler start(Context context)

Overload of start(Activity) but given Context must be an Activity.

start

public static BluetoothEnabler start(Context context,
                                     BluetoothEnabler.BluetoothEnablerFilter filter)

Overload of start(Activity, BluetoothEnablerFilter) but given Context must be an Activity.

resume_static

public static void resume_static(BluetoothEnabler.BluetoothEnablerFilter.Please please)

Static equivalent of resume(BluetoothEnablerFilter.Please) that you can use to call down into the singleton created by start(Activity, BluetoothEnablerFilter) (or overloads).

onActivityOrPermissionResult_static

public static void onActivityOrPermissionResult_static(int requestCode)

Static equivalent of onActivityOrPermissionResult(int) that you can use to call down into the singleton created by start(Activity, BluetoothEnablerFilter) (or overloads).

start

public static BluetoothEnabler start(Activity activity)

Overload of start(Activity, BluetoothEnablerFilter) that uses an instance of BluetoothEnabler.DefaultBluetoothEnablerFilter.

start

public static BluetoothEnabler start(Activity activity,
                                     BluetoothEnabler.BluetoothEnablerFilter filter)

Kicks off the complex flow needed to fully enable Bluetooth on Build versions greater than or equal to Build.VERSION_CODES.M.

onActivityOrPermissionResult

public void onActivityOrPermissionResult(int requestCode)

A potentially-required method to be placed in your activity's Activity.onRequestPermissionsResult(int, String[], int[]) and Activity.onActivityResult(int, int, Intent) methods. This method will re-connect the enabler after the app is re-entered. Otherwise, the enabler won't continue unless BluetoothEnabler.BluetoothEnablerFilter.Please.withImplicitActivityResultHandling() is called.

isEnabled

public boolean isEnabled(BluetoothEnabler.BluetoothEnablerFilter.Stage stage)

Returns whether the passed BluetoothEnabler.BluetoothEnablerFilter.Stage has been enabled.

resume

public void resume(BluetoothEnabler.BluetoothEnablerFilter.Please please)

Resume the enabler with the given Please. Enabler will continue where is left off.

getStage

public BluetoothEnabler.BluetoothEnablerFilter.Stage getStage()

Returns the current BluetoothEnabler.BluetoothEnablerFilter.Stage the enabler is on

isPerformingSystemCall

public boolean isPerformingSystemCall()

isDone

public boolean isDone()