StartBleScanRequest.Builder

AI-generated Key Takeaways

• StartBleScanRequest.Builder is used to create new DataSourceRequests.

• You can set a callback to be used when BLE devices are found using setBleScanCallback.

• You can specify the data types to search for during the BLE scan using setDataTypes.

• You can set a timeout for the scan duration in seconds using setTimeoutSecs.

• The build() method finishes building the request and returns a StartBleScanRequest object.

public static class StartBleScanRequest.Builder extends Object

Builder used to create new DataSourceRequests.

Public Constructor Summary

Builder()

Public Method Summary

StartBleScanRequest	build() Finishes building and returns the request.
StartBleScanRequest.Builder	setBleScanCallback(BleScanCallback bleScanCallback) Sets the callback to be used when devices are found.
StartBleScanRequest.Builder	setDataTypes(DataType... dataTypes) Sets the desired data types to search for on the BLE scan.
StartBleScanRequest.Builder	setTimeoutSecs(int stopTimeSecs) Sets how long to wait before automatically stopping the scan, in seconds.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Constructors

public Builder ()

Public Methods

public StartBleScanRequest build ()

Finishes building and returns the request.

Throws

IllegalStateException	If the builder doesn't have enough data to build a valid request.

public StartBleScanRequest.Builder setBleScanCallback (BleScanCallback bleScanCallback)

Sets the callback to be used when devices are found. The callback must be set or build() will throw an exception.

Parameters

bleScanCallback	The callback to be called.

public StartBleScanRequest.Builder setDataTypes (DataType... dataTypes)

Sets the desired data types to search for on the BLE scan. We'll only return devices which match this data type. If no data types are set, the request will return all compatible devices.

Parameters

dataTypes	The data types to search for. These can be one of the data types listed in DataType, or a custom data type.

public StartBleScanRequest.Builder setTimeoutSecs (int stopTimeSecs)

Sets how long to wait before automatically stopping the scan, in seconds. If this method isn't called scans will stop after 10 seconds by default.

Parameters

stopTimeSecs	Duration of the scan before stopping. Must be a value between 1 and 60 seconds.