no.nordicsemi.android.support.v18.scanner

Class ScanCallback

java.lang.Object

no.nordicsemi.android.support.v18.scanner.ScanCallback

public abstract class ScanCallback
extends Object

Bluetooth LE scan callbacks. Scan results are reported using these callbacks.

See Also:

BluetoothLeScannerCompat.startScan(no.nordicsemi.android.support.v18.scanner.ScanCallback)

Field Summary

Fields

Modifier and Type	Field and Description
static int	SCAN_FAILED_ALREADY_STARTED Fails to start scan as BLE scan with the same settings is already started by the app.
static int	SCAN_FAILED_APPLICATION_REGISTRATION_FAILED Fails to start scan as app cannot be registered.
static int	SCAN_FAILED_FEATURE_UNSUPPORTED Fails to start power optimized scan as this feature is not supported.
static int	SCAN_FAILED_INTERNAL_ERROR Fails to start scan due an internal error
static int	SCAN_FAILED_OUT_OF_HARDWARE_RESOURCES Fails to start scan as it is out of hardware resources.
static int	SCAN_FAILED_SCANNING_TOO_FREQUENTLY Fails to start scan as application tries to scan too frequently.

Constructor Summary

Constructors

Constructor and Description
ScanCallback()

Method Summary

Modifier and Type	Method and Description
void	onBatchScanResults(List<ScanResult> results) Callback when batch results are delivered.
void	onScanFailed(int errorCode) Callback when scan could not be started.
void	onScanResult(int callbackType, ScanResult result) Callback when a BLE advertisement has been found.

Methods inherited from class java.lang.Object

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

Field Detail

SCAN_FAILED_ALREADY_STARTED

public static final int SCAN_FAILED_ALREADY_STARTED

Fails to start scan as BLE scan with the same settings is already started by the app.

See Also:

Constant Field Values

SCAN_FAILED_APPLICATION_REGISTRATION_FAILED

public static final int SCAN_FAILED_APPLICATION_REGISTRATION_FAILED

Fails to start scan as app cannot be registered.

See Also:

Constant Field Values

SCAN_FAILED_INTERNAL_ERROR

public static final int SCAN_FAILED_INTERNAL_ERROR

Fails to start scan due an internal error

See Also:

Constant Field Values

SCAN_FAILED_FEATURE_UNSUPPORTED

public static final int SCAN_FAILED_FEATURE_UNSUPPORTED

Fails to start power optimized scan as this feature is not supported.

See Also:

Constant Field Values

SCAN_FAILED_OUT_OF_HARDWARE_RESOURCES

public static final int SCAN_FAILED_OUT_OF_HARDWARE_RESOURCES

Fails to start scan as it is out of hardware resources.

See Also:

Constant Field Values

SCAN_FAILED_SCANNING_TOO_FREQUENTLY

public static final int SCAN_FAILED_SCANNING_TOO_FREQUENTLY

Fails to start scan as application tries to scan too frequently.

See Also:

Constant Field Values

Constructor Detail

ScanCallback

public ScanCallback()

Method Detail

onScanResult

public void onScanResult(int callbackType,
                         ScanResult result)

Callback when a BLE advertisement has been found.

Parameters:

callbackType - Determines how this callback was triggered. Could be one of ScanSettings.CALLBACK_TYPE_ALL_MATCHES, ScanSettings.CALLBACK_TYPE_FIRST_MATCH or ScanSettings.CALLBACK_TYPE_MATCH_LOST

result - A Bluetooth LE scan result.

onBatchScanResults

public void onBatchScanResults(List<ScanResult> results)

Callback when batch results are delivered.

Parameters:

results - List of scan results that are previously scanned.

onScanFailed

public void onScanFailed(int errorCode)

Callback when scan could not be started.

Parameters:

errorCode - Error code (one of SCAN_FAILED_*) for scan failure.