com.polidea.rxandroidble2.scan

Class ScanSettings.Builder

java.lang.Object

com.polidea.rxandroidble2.scan.ScanSettings.Builder

All Implemented Interfaces:

ExternalScanSettingsExtension.Builder

Enclosing class:

ScanSettings

public static final class ScanSettings.Builder
extends java.lang.Object
implements ExternalScanSettingsExtension.Builder

Builder for ScanSettings.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ScanSettings	build() Build ScanSettings.
ScanSettings.Builder	setCallbackType(int callbackType) Set callback type for Bluetooth LE scan.
ScanSettings.Builder	setScanMode(int scanMode) Set scan mode for Bluetooth LE scan.
ScanSettings.Builder	setShouldCheckLocationServicesState(boolean shouldCheck) Set whether a check if Location Services are (any Location Provider is) turned on before scheduling a BLE scan start.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setScanMode

public ScanSettings.Builder setScanMode(int scanMode)

Set scan mode for Bluetooth LE scan.

Parameters:

scanMode - The scan mode can be one of ScanSettings.SCAN_MODE_LOW_POWER, ScanSettings.SCAN_MODE_BALANCED or ScanSettings.SCAN_MODE_LOW_LATENCY.

Throws:

java.lang.IllegalArgumentException - If the scanMode is invalid.

setCallbackType

public ScanSettings.Builder setCallbackType(int callbackType)

Set callback type for Bluetooth LE scan.

Parameters:

callbackType - The callback type flags for the scan.

Throws:

java.lang.IllegalArgumentException - If the callbackType is invalid.

setShouldCheckLocationServicesState

public ScanSettings.Builder setShouldCheckLocationServicesState(boolean shouldCheck)

Set whether a check if Location Services are (any Location Provider is) turned on before scheduling a BLE scan start. Some Android devices will not return any ScanResult if Location Services are disabled. If set to true and Location Services are off a BleScanException will be emitted.

Default: true.

Specified by:

setShouldCheckLocationServicesState in interface ExternalScanSettingsExtension.Builder

Parameters:

shouldCheck - true if Location Services should be checked before the scan

Returns:

the builder

build

public ScanSettings build()

Build ScanSettings.