com.reelyactive.blesdk.support.ble

Class ScanSettings.Builder

java.lang.Object

com.reelyactive.blesdk.support.ble.ScanSettings.Builder

Enclosing class:

ScanSettings

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

Builder for ScanSettings.

Constructor Summary

Constructors

Constructor and Description
ScanSettings.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
ScanSettings	build() Build ScanSettings.
ScanSettings.Builder	setCallbackType(int callbackType) Set callback type for Bluetooth LE scan.
ScanSettings.Builder	setReportDelayMillis(long reportDelayMillis) Set report delay timestamp for Bluetooth LE scan.
ScanSettings.Builder	setScanMode(int scanMode) Set scan mode for Bluetooth LE scan.
ScanSettings.Builder	setScanResultType(int scanResultType) Set scan result type for Bluetooth LE scan.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanSettings.Builder

public ScanSettings.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.

setScanResultType

public ScanSettings.Builder setScanResultType(int scanResultType)

Set scan result type for Bluetooth LE scan.

Parameters:

scanResultType - Type for scan result, could be either ScanSettings.SCAN_RESULT_TYPE_FULL or ScanSettings.SCAN_RESULT_TYPE_ABBREVIATED.

Throws:

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

setReportDelayMillis

public ScanSettings.Builder setReportDelayMillis(long reportDelayMillis)

Set report delay timestamp for Bluetooth LE scan.

Parameters:

reportDelayMillis - Set to 0 to be notified of results immediately. Values > 0 causes the scan results to be queued up and delivered after the requested delay or when the internal buffers fill up.

Throws:

java.lang.IllegalArgumentException - If reportDelayMillis < 0.

build

public ScanSettings build()

Build ScanSettings.