com.gallagher.security.mobileaccess.BluetoothScanMode Enum Reference

Public Member Functions
	BluetoothScanMode (int i)
int	getValue ()
boolean	isBackgroundMode ()
boolean	isForegroundMode ()

Static Public Member Functions
static BluetoothScanMode	from (int value)

Public Attributes
	BACKGROUND_OPPORTUNISTIC =(-1)
	BACKGROUND_LOW_POWER =(0)
	BACKGROUND_BALANCED =(1)
	BACKGROUND_LOW_LATENCY =(2)
	BACKGROUND_SCREEN_ON =(3)
	FOREGROUND_ONLY =(4)

Detailed Description

Enables control over the behaviour of scanning for BLE readers while the app is in the foreground and background

Constructor & Destructor Documentation

BluetoothScanMode()

com.gallagher.security.mobileaccess.BluetoothScanMode.BluetoothScanMode

(

int

i

)

                             {
        mValue = i;
    }

Member Function Documentation

from()

static BluetoothScanMode com.gallagher.security.mobileaccess.BluetoothScanMode.from ( int  value )

static

                                                    {
        for(BluetoothScanMode m : BluetoothScanMode.values()){
            if(m.mValue == value){
                return m;
            }
        }
        return null;
    }

getValue()

int com.gallagher.security.mobileaccess.BluetoothScanMode.getValue

(

)

                          {
        return mValue;
    }

isBackgroundMode()

boolean com.gallagher.security.mobileaccess.BluetoothScanMode.isBackgroundMode

(

)

Convenience method to test if the mode is a background mode or not

                                      {
        return this != FOREGROUND_ONLY;
    }

isForegroundMode()

boolean com.gallagher.security.mobileaccess.BluetoothScanMode.isForegroundMode

(

)

Convenience method to test if the mode is a foreground mode

                                      {
        return !isBackgroundMode();
    }

Member Data Documentation

BACKGROUND_BALANCED

com.gallagher.security.mobileaccess.BluetoothScanMode.BACKGROUND_BALANCED =(1)

The BLE service scans continuously in the background using android's SCAN_MODE_BALANCED It will switch to LOW_LATENCY while the screen is powered on

BACKGROUND_LOW_LATENCY

com.gallagher.security.mobileaccess.BluetoothScanMode.BACKGROUND_LOW_LATENCY =(2)

The BLE service scans continuously in the background using android's SCAN_MODE_LOW_LATENCY

BACKGROUND_LOW_POWER

com.gallagher.security.mobileaccess.BluetoothScanMode.BACKGROUND_LOW_POWER =(0)

The BLE service scans continuously in the background using android's SCAN_MODE_LOW_POWER. It will switch to LOW_LATENCY while the screen is powered on

BACKGROUND_OPPORTUNISTIC

com.gallagher.security.mobileaccess.BluetoothScanMode.BACKGROUND_OPPORTUNISTIC =(-1)

The BLE service scans continuously in the background using android's SCAN_MODE_OPPORTUNISTIC This is not recommended for use as it is very unlikely to yield good results

BACKGROUND_SCREEN_ON

com.gallagher.security.mobileaccess.BluetoothScanMode.BACKGROUND_SCREEN_ON =(3)

The BLE service does not scan in the background while the screen is off. It will switch to LOW_LATENCY while the screen is powered on

FOREGROUND_ONLY

com.gallagher.security.mobileaccess.BluetoothScanMode.FOREGROUND_ONLY =(4)

The BLE service does not scan in the background at all. It will switch to LOW_LATENCY when the app is in the foreground. If you set this scanMode, then the background service is not required and will not be used.

---

The documentation for this enum was generated from the following file:

• BluetoothScanMode.java