com.idevicesinc.sweetblue

Class ScanOptions

java.lang.Object

com.idevicesinc.sweetblue.ScanOptions

public final class ScanOptions
extends java.lang.Object

Class used to feed options for scanning via BleManager.startScan(ScanOptions).

Constructor Summary

Constructors

Constructor and Description
ScanOptions()
ScanOptions(DiscoveryListener listener_nullable)
ScanOptions(ScanFilter scanFilter)
ScanOptions(ScanFilter scanFilter, DiscoveryListener listener_nullable)

Method Summary

Modifier and Type	Method and Description
ScanOptions	asHighPriority(boolean highPriority) This will set the scan to be of the highest priority.
ScanOptions	forceIndefinite(boolean force) Force a indefinite scan.
ScanFilter.ApplyMode	getApplyMode()
DiscoveryListener	getDiscoveryListener()
Interval	getPauseTime()
android.app.PendingIntent	getPendingIntent()
ScanFilter	getScanFilter()
Interval	getScanTime()
boolean	isContinuous() Returns true if this instance is a periodic scan, or indefinite.
boolean	isForceIndefinite()
boolean	isPeriodic()
boolean	isPriorityScan()
ScanOptions	scanFor(Interval time) Scan for the specified amount of time.
ScanOptions	scanInfinitely() Scan indefinitely until BleManager.stopScan() is called.
ScanOptions	scanPeriodically(Interval scanTime, Interval pauseTime) Do a periodic scan.
ScanOptions	withDiscoveryListener(DiscoveryListener listener) Set a DiscoveryListener for this scan.
ScanOptions	withPendingIntent(android.app.PendingIntent pendingIntent) NOTE: This will only work for devices running android 8 (Oreo) or higher (API level 26+).
ScanOptions	withScanFilter(ScanFilter filter) Set a ScanFilter for this scan.
ScanOptions	withScanFilterApplyMode(ScanFilter.ApplyMode applyMode) Set a ScanFilter.ApplyMode for this scan.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanOptions

public ScanOptions()

ScanOptions

public ScanOptions(ScanFilter scanFilter)

ScanOptions

public ScanOptions(DiscoveryListener listener_nullable)

ScanOptions

public ScanOptions(ScanFilter scanFilter,
                   DiscoveryListener listener_nullable)

Method Detail

scanInfinitely

public final ScanOptions scanInfinitely()

Scan indefinitely until BleManager.stopScan() is called. If this is called after scanPeriodically(Interval, Interval), this will override the periodic scan.

scanFor

public final ScanOptions scanFor(Interval time)

Scan for the specified amount of time. This method implies a one-time scan. If you want to perform a periodic scan, then use scanPeriodically(Interval, Interval) instead. If this is called after scanPeriodically(Interval, Interval), it will override the periodic scan.

forceIndefinite

public final ScanOptions forceIndefinite(boolean force)

Force a indefinite scan. If you choose to scan indefinitely, and don't set this, SweetBlue will automatically pause the scan, and resume it shortly thereafter, to make sure scan results keep coming in as expected. If you pass in true here, the scan will just run until you call BleManager.stopScan(). There's really no reason to do this, but it's left in here to be flexible.

scanPeriodically

public final ScanOptions scanPeriodically(Interval scanTime,
                                          Interval pauseTime)

Do a periodic scan. If you want to do a one-time scan, then use scanFor(Interval) instead.

withScanFilter

public final ScanOptions withScanFilter(ScanFilter filter)

Set a ScanFilter for this scan.

withScanFilterApplyMode

public final ScanOptions withScanFilterApplyMode(ScanFilter.ApplyMode applyMode)

Set a ScanFilter.ApplyMode for this scan.

withDiscoveryListener

public final ScanOptions withDiscoveryListener(DiscoveryListener listener)

Set a DiscoveryListener for this scan.

withPendingIntent

public final ScanOptions withPendingIntent(android.app.PendingIntent pendingIntent)

NOTE: This will only work for devices running android 8 (Oreo) or higher (API level 26+). If a scan is started with this option on a device running android 7 or lower, a scan will not be started. You must make sure to check the result of BleManager.startScan() to know if a scan started. NOTE 2: DiscoveryListener is ignored when using this feature. Set a PendingIntent for the system to use as a callback to your application when new devices are discovered. This is a special scan in that you will get back native BluetoothDevice instances in your activity/receiver. It is recommended to use BleManager.getDevices(Intent) to convert the native android bluetooth device instances to BleDevice instances for you. To execute a scan properly, you need to create a PendingIntent like below:

 
     PendingIntent pIntent = PendingIntent.getBroadcast(activity, 42, new Intent(activity, MyScanReceiver.class), PendingIntent.FLAG_UPDATE_CURRENT);
 
 

You also must remember to create a class which extends BroadcastReceiver, and this class must be added to your AndroidManifest.xml file. eg:

     
           <receiver android:name="com.myapp.MyScanReceiver" >
             <intent-filter>
                 <action android:name="com.myapp.ACTION_FOUND" />
             </intent-filter>
         </receiver> 
     
 

asHighPriority

public final ScanOptions asHighPriority(boolean highPriority)

This will set the scan to be of the highest priority. This should ONLY be used if you absolutely need it! With this active, ONLY scanning will happen (even if you call connect on a device, or read/write, etc), until you call BleManager.stopScan().

getScanTime

public final Interval getScanTime()

getPauseTime

public final Interval getPauseTime()

getScanFilter

public final ScanFilter getScanFilter()

getApplyMode

public final ScanFilter.ApplyMode getApplyMode()

getDiscoveryListener

public final DiscoveryListener getDiscoveryListener()

getPendingIntent

public final android.app.PendingIntent getPendingIntent()

isPeriodic

public final boolean isPeriodic()

isPriorityScan

public final boolean isPriorityScan()

isForceIndefinite

public final boolean isForceIndefinite()

isContinuous

public boolean isContinuous()

Returns true if this instance is a periodic scan, or indefinite.