com.polidea.rxandroidble2.scan

Interface BackgroundScanner

All Known Implementing Classes:

BackgroundScannerImpl

public interface BackgroundScanner

Method Summary

Modifier and Type	Method and Description
java.util.List<ScanResult>	onScanResultReceived(android.content.Intent intent) Callback that may be used to map received Intent from a PendingIntent based scan to a handy RxAndroidBLE enabled ScanResult
void	scanBleDeviceInBackground(android.app.PendingIntent callbackIntent, ScanSettings scanSettings, ScanFilter... scanFilters) Submits a scan request that will work even if your process gets killed by the system.
void	stopBackgroundBleScan(android.app.PendingIntent callbackIntent) Stops previously initiated scan with a PendingIntent callback.

Method Detail

scanBleDeviceInBackground

void scanBleDeviceInBackground(android.app.PendingIntent callbackIntent,
                               ScanSettings scanSettings,
                               ScanFilter... scanFilters)

Submits a scan request that will work even if your process gets killed by the system. You can use this API to maintain a background scan without a need to keep your application foreground and active. The system will manage the scan for you and will wake your process up once a result is available.

When the PendingIntent is delivered, the Intent passed to the receiver or activity will contain one or more of the extras BluetoothLeScanner.EXTRA_CALLBACK_TYPE, BluetoothLeScanner.EXTRA_ERROR_CODE and BluetoothLeScanner.EXTRA_LIST_SCAN_RESULT to indicate the result of the scan.

Parameters:

scanSettings - Scan settings

scanFilters - Filtering settings

callbackIntent - Intent that will be executed when the scan result becomes available

Throws:

BleScanException - thrown if not possible to start the scan

stopBackgroundBleScan

void stopBackgroundBleScan(android.app.PendingIntent callbackIntent)

Stops previously initiated scan with a PendingIntent callback.

Parameters:

callbackIntent - A callback intent that was previously used to initiate a scan

onScanResultReceived

java.util.List<ScanResult> onScanResultReceived(android.content.Intent intent)

Callback that may be used to map received Intent from a PendingIntent based scan to a handy RxAndroidBLE enabled ScanResult

Parameters:

intent - Intent containing scan result or an error code

Returns:

Parsed scan result, ready to use with a RxAndroidBLE

Throws:

BleScanException - scan failure