com.estimote.coresdk.common.requirements

Class SystemRequirementsHelper

java.lang.Object

com.estimote.coresdk.common.requirements.SystemRequirementsHelper

public class SystemRequirementsHelper
extends java.lang.Object

Helper methods for checking requirements for beacon detection. It includes checking

• if Bluetooth is available on device: isBluetoothLeAvailable(Context)
• if Bluetooth is enabled: isBluetoothEnabled(Context)
• if Location Services are available: isLocationServiceForBluetoothLeEnabled(Context)
• if runtime permissions are granted: hasAnyLocationPermission(Context)

Estimote SDK periodically checks if following conditions are checked. If not met, an error log is printed. You can manually check all those conditions via checkAllPermissions(Context).

Author:

Wiktor Gworek (wiktor@estimote.com)

Constructor Summary

Constructors

Constructor and Description
SystemRequirementsHelper()

Method Summary

Modifier and Type	Method and Description
static boolean	checkAllPermissions(android.content.Context context) Returns false is any of following conditions are not met: Bluetooth permissions are granted (android.permission.BLUETOOTH and android.permission.BLUETOOTH_ADMIN). BeaconService is declared in AndroidManifest.xml. If running on Android M or later, Location Services must be turned on. If running on Android M or later and your app is targeting SDK < 23 (M), any location permission (ACCESS_COARSE_LOCATION or ACCESS_FINE_LOCATION) must be granted for background beacon detection. If running on Android M or later and your app is targeting SDK >= 23 (M), any location permission (ACCESS_COARSE_LOCATION or ACCESS_FINE_LOCATION) must be granted.
static boolean	hasAnyLocationPermission(android.content.Context context) Returns true if app has permission granted to ACCESS_FINE_LOCATION or ACCESS_COARSE_LOCATION.
static boolean	isBluetoothEnabled(android.content.Context context) Returns true if Bluetooth is enabled on the device.
static boolean	isBluetoothLeAvailable(android.content.Context context) Returns true if device supports Bluetooth Low Energy.
static boolean	isForegroundApp(android.content.Context context) This method was copied from Android's code: com.android.bluetooth.Utils#isForegroundApp.
static boolean	isLocationServiceForBluetoothLeEnabled(android.content.Context context) Returns true if Location Services are enabled and required for Bluetooth LE scanning.
static boolean	shouldShowCoarseLocationRequestPermissionRationale(android.app.Activity activity) Gets whether you should show UI with rationale for requesting ACCESS_COARSE_LOCATION permission.

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemRequirementsHelper

public SystemRequirementsHelper()

Method Detail

isBluetoothLeAvailable

public static boolean isBluetoothLeAvailable(android.content.Context context)

Returns true if device supports Bluetooth Low Energy.

Parameters:

context - Android context.

isBluetoothEnabled

public static boolean isBluetoothEnabled(android.content.Context context)

Returns true if Bluetooth is enabled on the device.

If not, you should ask user to enable it via:

   Intent enableBtIntent = new Intent(BluetoothAdapter.ACTION_REQUEST_ENABLE);
   startActivityForResult(enableBtIntent, REQUEST_ENABLE_BT);
 

Parameters:

context - Android context.

isLocationServiceForBluetoothLeEnabled

public static boolean isLocationServiceForBluetoothLeEnabled(android.content.Context context)

Returns true if Location Services are enabled and required for Bluetooth LE scanning.

Note: on Android L and earlier there is no need to have Location Services enabled for Bluetooth LE scanning and this method returns true.

If not, you should ask user to enable it:

   // It is recommended to show dialog with explanation.
   // Dialog title: Requesting location access
   // Dialog message: Detecting beacons requires Location to be enabled.We'll never access your GPS location without your knowledge.
   // OK button: Go to settings to enable
   // Cancel button: I don't want to do this now
   Intent intent = new Intent(Settings.ACTION_LOCATION_SOURCE_SETTINGS);
   activity.startActivity(intent);
 

Parameters:

context - Android context.

hasAnyLocationPermission

public static boolean hasAnyLocationPermission(android.content.Context context)

Returns true if app has permission granted to ACCESS_FINE_LOCATION or ACCESS_COARSE_LOCATION.

Parameters:

context - Android context.

checkAllPermissions

public static boolean checkAllPermissions(android.content.Context context)

Returns false is any of following conditions are not met:

• Bluetooth permissions are granted (android.permission.BLUETOOTH and android.permission.BLUETOOTH_ADMIN).
• BeaconService is declared in AndroidManifest.xml.
• If running on Android M or later, Location Services must be turned on.
• If running on Android M or later and your app is targeting SDK < 23 (M), any location permission (ACCESS_COARSE_LOCATION or ACCESS_FINE_LOCATION) must be granted for background beacon detection.
• If running on Android M or later and your app is targeting SDK >= 23 (M), any location permission (ACCESS_COARSE_LOCATION or ACCESS_FINE_LOCATION) must be granted.

If this method returns false, error with detailed description will be printed in the Android logs.

Returns:

True if described above conditions are met.

shouldShowCoarseLocationRequestPermissionRationale

public static boolean shouldShowCoarseLocationRequestPermissionRationale(android.app.Activity activity)

Gets whether you should show UI with rationale for requesting ACCESS_COARSE_LOCATION permission.

On Android L and earlier this method always returns false. Runtime permission request rationale was introduced on Android M.

Parameters:

activity - The target activity.

Returns:

Whether you can show permission rationale UI.

isForegroundApp

public static boolean isForegroundApp(android.content.Context context)

This method was copied from Android's code: com.android.bluetooth.Utils#isForegroundApp. In theory it should throw SecurityException for accessing running tasks but for some reason it works. Just to be bullet-proof if there is any exception throw, method will return true.