BeaconManager (lib 1.0.20210112.0950 API)

java.lang.Object
- org.altbeacon.beacon.BeaconManager

public class BeaconManager
extends Object

A class used to set up interaction with beacons from an Activity or Service. This class is used in conjunction with BeaconConsumer interface, which provides a callback when the BeaconService is ready to use. Until this callback is made, ranging and monitoring of beacons is not possible. In the example below, an Activity implements the BeaconConsumer interface, binds to the service, then when it gets the callback saying the service is ready, it starts ranging.


  public class RangingActivity extends Activity implements BeaconConsumer {
      protected static final String TAG = "RangingActivity";
      private BeaconManager beaconManager = BeaconManager.getInstanceForApplication(this);
       @Override
      protected void onCreate(Bundle savedInstanceState) {
          super.onCreate(savedInstanceState);
          setContentView(R.layout.activity_ranging);
          beaconManager.bind(this);
      }
       @Override
      protected void onDestroy() {
          super.onDestroy();
          beaconManager.unbind(this);
      }
       @Override
      public void onBeaconServiceConnect() {
          beaconManager.setRangeNotifier(new RangeNotifier() {
               @Override
              public void didRangeBeaconsInRegion(Collection beacons, Region region) {
                  if (beacons.size() > 0) {
                      Log.i(TAG, "The first beacon I see is about "+beacons.iterator().next().getDistance()+" meters away.");
                  }
              }
          });

          try {
              beaconManager.startRangingBeaconsInRegion(new Region("myRangingUniqueId", null, null, null));
          } catch (RemoteException e) {
              e.printStackTrace();
          }
      }
  }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class BeaconManager.ServiceNotDeclaredException

Nested Classes
Modifier and Type	Class and Description
`class`	`BeaconManager.ServiceNotDeclaredException`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static BeaconSimulator`	`beaconSimulator`
`protected RangeNotifier`	`dataRequestNotifier`
`static long`	`DEFAULT_BACKGROUND_BETWEEN_SCAN_PERIOD` The default duration in milliseconds spent not scanning between each Bluetooth scan cycle when no ranging/monitoring clients are in the foreground
`static long`	`DEFAULT_BACKGROUND_SCAN_PERIOD` The default duration in milliseconds of the Bluetooth scan cycle when no ranging/monitoring clients are in the foreground
`static long`	`DEFAULT_EXIT_PERIOD` The default duration in milliseconds of region exit time
`static long`	`DEFAULT_FOREGROUND_BETWEEN_SCAN_PERIOD` The default duration in milliseconds spent not scanning between each Bluetooth scan cycle
`static long`	`DEFAULT_FOREGROUND_SCAN_PERIOD` The default duration in milliseconds of the Bluetooth scan cycle
`protected static String`	`distanceModelUpdateUrl`
`protected Set<MonitorNotifier>`	`monitorNotifiers`
`protected Set<RangeNotifier>`	`rangeNotifiers`
`protected static Class`	`rssiFilterImplClass` Default class for rssi filter/calculation implementation
`protected static BeaconManager`	`sInstance`

Constructor Summary

Constructors
Modifier Constructor and Description

protected BeaconManager(Context context)

Constructors
Modifier	Constructor and Description
`protected`	`BeaconManager(Context context)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addMonitorNotifier(MonitorNotifier notifier)` Specifies a class that should be called each time the `BeaconService` sees or stops seeing a Region of beacons.
`void`	`addRangeNotifier(RangeNotifier notifier)` Specifies a class that should be called each time the `BeaconService` gets ranging data, which is nominally once per second when beacons are detected.
`void`	`applySettings()` Call this method if you are running the scanner service in a different process in order to synchronize any configuration settings, including BeaconParsers to the scanner
`void`	`bind(BeaconConsumer consumer)` Binds an Android `Activity` or `Service` to the `BeaconService`.
`boolean`	`checkAvailability()` Check if Bluetooth LE is supported by this Android device, and if so, make sure it is enabled.
`protected void`	`checkIfMainProcess()`
`void`	`disableForegroundServiceScanning()` Disables a foreground scanning service, if previously configured.
`void`	`enableForegroundServiceScanning(Notification notification, int notificationId)` Configures the library to use a foreground service for bacon scanning.
`long`	`getBackgroundBetweenScanPeriod()`
`boolean`	`getBackgroundMode()`
`long`	`getBackgroundScanPeriod()`
`List<BeaconParser>`	`getBeaconParsers()` Gets a list of the active beaconParsers.
`static BeaconSimulator`	`getBeaconSimulator()`
`protected RangeNotifier`	`getDataRequestNotifier()`
`static String`	`getDistanceModelUpdateUrl()`
`long`	`getForegroundBetweenScanPeriod()`
`long`	`getForegroundScanPeriod()`
`Notification`	`getForegroundServiceNotification()`
`int`	`getForegroundServiceNotificationId()`
`static BeaconManager`	`getInstanceForApplication(Context context)` An accessor for the singleton instance of this class.
`static boolean`	`getManifestCheckingDisabled()` Returns whether manifest checking is disabled
`Collection<Region>`	`getMonitoredRegions()`
`MonitorNotifier`	`getMonitoringNotifier()` Deprecated. replaced by (@link #getMonitorNotifiers)
`Set<MonitorNotifier>`	`getMonitoringNotifiers()` Read-only access to the registered `MonitorNotifier` instances
`NonBeaconLeScanCallback`	`getNonBeaconLeScanCallback()`
`Collection<Region>`	`getRangedRegions()`
`RangeNotifier`	`getRangingNotifier()` Deprecated. replaced by (@link #getRangeNotifiers)
`Set<RangeNotifier>`	`getRangingNotifiers()` Read-only access to the registered `RangeNotifier` instances
`static long`	`getRegionExitPeriod()` Get region exit milliseconds
`static Class`	`getRssiFilterImplClass()`
`boolean`	`getScheduledScanJobsEnabled()`
`static boolean`	`isAndroidLScanningDisabled()` Determines if Android L Scanning is disabled by user selection
`boolean`	`isAnyConsumerBound()` Tells you if the any beacon consumer is bound to the service
`boolean`	`isBackgroundModeUninitialized()`
`boolean`	`isBound(BeaconConsumer consumer)` Tells you if the passed beacon consumer is bound to the service
`boolean`	`isMainProcess()` Determines if this BeaconManager instance is associated with the main application process that hosts the user interface.
`boolean`	`isRegionStatePersistenceEnabled()` Indicates whether region state preservation is enabled
`boolean`	`isScannerInDifferentProcess()` Determines if this BeaconManager instance is not part of the process hosting the beacon scanning service.
`static void`	`logDebug(String tag, String message)` Deprecated. This will be removed in a later release. Use `LogManager.d(String, String, Object...)` instead.
`static void`	`logDebug(String tag, String message, Throwable t)` Deprecated. This will be removed in a later release. Use `LogManager.d(Throwable, String, String, Object...)` instead.
`void`	`notifyException()`
`void`	`removeAllMonitorNotifiers()` Remove all the Monitor Notifiers.
`void`	`removeAllRangeNotifiers()` Remove all the Range Notifiers.
`boolean`	`removeMonitoreNotifier(MonitorNotifier notifier)` Deprecated. Misspelled. Replaced by `removeMonitorNotifier(org.altbeacon.beacon.MonitorNotifier)`
`boolean`	`removeMonitorNotifier(MonitorNotifier notifier)` Specifies a class to remove from the array of `MonitorNotifier`.
`boolean`	`removeRangeNotifier(RangeNotifier notifier)` Specifies a class to remove from the array of `RangeNotifier`
`void`	`requestStateForRegion(Region region)` Requests the current in/out state on the specified region.
`static void`	`setAndroidLScanningDisabled(boolean disabled)` Allows disabling use of Android L BLE Scanning APIs on devices with API 21+ If set to false (default), devices with API 21+ will use the Android L APIs to scan for beacons
`void`	`setBackgroundBetweenScanPeriod(long p)` Sets the duration in milliseconds spent not scanning between each Bluetooth LE scan cycle when no ranging/monitoring clients are in the foreground
`void`	`setBackgroundMode(boolean backgroundMode)` This method notifies the beacon service that the application is either moving to background mode or foreground mode.
`void`	`setBackgroundScanPeriod(long p)` Sets the duration in milliseconds of each Bluetooth LE scan cycle to look for beacons.
`static void`	`setBeaconSimulator(BeaconSimulator beaconSimulator)`
`protected void`	`setDataRequestNotifier(RangeNotifier notifier)`
`static void`	`setDebug(boolean debug)` Set to true if you want to show library debugging.
`static void`	`setDistanceModelUpdateUrl(String url)`
`void`	`setEnableScheduledScanJobs(boolean enabled)` Configures using a `ScanJob` run with the `JobScheduler` to perform scans rather than using a long-running `BeaconService` to do so.
`void`	`setForegroundBetweenScanPeriod(long p)` Sets the duration in milliseconds between each Bluetooth LE scan cycle to look for beacons.
`void`	`setForegroundScanPeriod(long p)` Sets the duration in milliseconds of each Bluetooth LE scan cycle to look for beacons.
`static void`	`setManifestCheckingDisabled(boolean disabled)` Allows disabling check of manifest for proper configuration of service.
`void`	`setMaxTrackingAge(int maxTrackingAge)` Set the period of time, in which a beacon did not receive new measurements
`void`	`setMonitorNotifier(MonitorNotifier notifier)` Deprecated. replaced by `addMonitorNotifier(org.altbeacon.beacon.MonitorNotifier)`
`void`	`setNonBeaconLeScanCallback(NonBeaconLeScanCallback callback)`
`void`	`setRangeNotifier(RangeNotifier notifier)` Deprecated. replaced by (@link #addRangeNotifier)
`static void`	`setRegionExitPeriod(long regionExitPeriod)` Set region exit period in milliseconds
`void`	`setRegionStatePeristenceEnabled(boolean enabled)` Deprecated. Misspelled. Replaced by `setRegionStatePersistenceEnabled(boolean)`
`void`	`setRegionStatePersistenceEnabled(boolean enabled)` Turns off saving the state of monitored regions to persistent storage so it is retained over app restarts.
`static void`	`setRssiFilterImplClass(Class c)`
`void`	`setScannerInSameProcess(boolean isScanner)` Reserved for internal use by the library.
`void`	`setSdkNotifier(SDKNotifier sdkNotifier)`
`static void`	`setsManifestCheckingDisabled(boolean disabled)` Deprecated.
`static void`	`setUseTrackingCache(boolean useTrackingCache)` Allow the library to use a tracking cache
`void`	`startMonitoringBeaconsInRegion(List<Region> regions)`
`void`	`startMonitoringBeaconsInRegion(Region region)` Tells the `BeaconService` to start looking for beacons that match the passed `Region` object.
`void`	`startRangingBeaconsInRegion(List<Region> regions)`
`void`	`startRangingBeaconsInRegion(Region region)` Tells the `BeaconService` to start looking for beacons that match the passed `Region` object, and providing updates on the estimated mDistance every seconds while beacons in the Region are visible.
`void`	`stopAllMonitoringBeaconsInRegion()`
`void`	`stopAllRangingBeaconsInRegion()`
`void`	`stopMonitoringBeaconsInRegion(List<Region> regions)`
`void`	`stopMonitoringBeaconsInRegion(Region region)` Tells the `BeaconService` to stop looking for beacons that match the passed `Region` object.
`void`	`stopRangingBeaconsInRegion(List<Region> regions)`
`void`	`stopRangingBeaconsInRegion(Region region)` Tells the `BeaconService` to stop looking for beacons that match the passed `Region` object and providing mDistance information for them.
`protected void`	`syncSettingsToService()`
`void`	`unbind(BeaconConsumer consumer)` Unbinds an Android `Activity` or `Service` to the `BeaconService`.
`void`	`updateScanPeriods()` Updates an already running scan with scanPeriod/betweenScanPeriod according to Background/Foreground state.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sInstance
```
@Nullable
protected static volatile BeaconManager sInstance
```
  - rangeNotifiers
```
@NonNull
protected final Set<RangeNotifier> rangeNotifiers
```
  - dataRequestNotifier
```
@Nullable
protected RangeNotifier dataRequestNotifier
```
  - monitorNotifiers
```
@NonNull
protected final Set<MonitorNotifier> monitorNotifiers
```
  - DEFAULT_FOREGROUND_SCAN_PERIOD
```
public static final long DEFAULT_FOREGROUND_SCAN_PERIOD
```
    The default duration in milliseconds of the Bluetooth scan cycle
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FOREGROUND_BETWEEN_SCAN_PERIOD
```
public static final long DEFAULT_FOREGROUND_BETWEEN_SCAN_PERIOD
```
    The default duration in milliseconds spent not scanning between each Bluetooth scan cycle
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BACKGROUND_SCAN_PERIOD
```
public static final long DEFAULT_BACKGROUND_SCAN_PERIOD
```
    The default duration in milliseconds of the Bluetooth scan cycle when no ranging/monitoring clients are in the foreground
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BACKGROUND_BETWEEN_SCAN_PERIOD
```
public static final long DEFAULT_BACKGROUND_BETWEEN_SCAN_PERIOD
```
    The default duration in milliseconds spent not scanning between each Bluetooth scan cycle when no ranging/monitoring clients are in the foreground
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EXIT_PERIOD
```
public static final long DEFAULT_EXIT_PERIOD
```
    The default duration in milliseconds of region exit time
    
    See Also:
    
    Constant Field Values
  - beaconSimulator
```
@Nullable
protected static BeaconSimulator beaconSimulator
```
  - distanceModelUpdateUrl
```
protected static String distanceModelUpdateUrl
```
  - rssiFilterImplClass
```
protected static Class rssiFilterImplClass
```
    Default class for rssi filter/calculation implementation
- Constructor Detail
  - BeaconManager
```
protected BeaconManager(@NonNull
                        Context context)
```
- Method Detail
  - setDebug
```
public static void setDebug(boolean debug)
```
    Set to true if you want to show library debugging.
    
    Parameters:
    
    debug - True turn on all logs for this library to be printed out to logcat. False turns off detailed logging.. This is a convenience method that calls setLogger to a verbose logger and enables verbose logging. For more fine grained control, use: LogManager.setLogger(org.altbeacon.beacon.logging.Logger) instead.
  - setSdkNotifier
```
public void setSdkNotifier(SDKNotifier sdkNotifier)
```
  - notifyException
```
public void notifyException()
```
  - setForegroundScanPeriod
```
public void setForegroundScanPeriod(long p)
```
    Sets the duration in milliseconds of each Bluetooth LE scan cycle to look for beacons. This function is used to setup the period before calling bind(org.altbeacon.beacon.BeaconConsumer) or when switching between background/foreground. To have it effect on an already running scan (when the next cycle starts), call updateScanPeriods()
    
    Parameters:
    
    p -
  - setForegroundBetweenScanPeriod
```
public void setForegroundBetweenScanPeriod(long p)
```
    Sets the duration in milliseconds between each Bluetooth LE scan cycle to look for beacons. This function is used to setup the period before calling bind(org.altbeacon.beacon.BeaconConsumer) or when switching between background/foreground. To have it effect on an already running scan (when the next cycle starts), call updateScanPeriods()
    
    Parameters:
    
    p -
  - setBackgroundScanPeriod
```
public void setBackgroundScanPeriod(long p)
```
    Sets the duration in milliseconds of each Bluetooth LE scan cycle to look for beacons. This function is used to setup the period before calling bind(org.altbeacon.beacon.BeaconConsumer) or when switching between background/foreground. To have it effect on an already running scan (when the next cycle starts), call updateScanPeriods()
    
    Parameters:
    
    p -
  - setBackgroundBetweenScanPeriod
```
public void setBackgroundBetweenScanPeriod(long p)
```
    Sets the duration in milliseconds spent not scanning between each Bluetooth LE scan cycle when no ranging/monitoring clients are in the foreground
    
    Parameters:
    
    p -
  - setRegionExitPeriod
```
public static void setRegionExitPeriod(long regionExitPeriod)
```
    Set region exit period in milliseconds
    
    Parameters:
    
    regionExitPeriod -
  - getRegionExitPeriod
```
public static long getRegionExitPeriod()
```
    Get region exit milliseconds
    
    Returns:
    
    exit region period in milliseconds
  - getInstanceForApplication
```
@NonNull
public static BeaconManager getInstanceForApplication(@NonNull
                                                               Context context)
```
    An accessor for the singleton instance of this class. A context must be provided, but if you need to use it from a non-Activity or non-Service class, you can attach it to another singleton or a subclass of the Android Application class.
  - isMainProcess
```
public boolean isMainProcess()
```
    Determines if this BeaconManager instance is associated with the main application process that hosts the user interface. This is normally true unless the scanning service or another servide is running in a separate process.
    
    Returns:
  - isScannerInDifferentProcess
```
public boolean isScannerInDifferentProcess()
```
    Determines if this BeaconManager instance is not part of the process hosting the beacon scanning service. This is normally false, except when scanning is hosted in a different process. This will always return false until the scanning service starts up, at which time it will be known if it is in a different process.
    
    Returns:
  - setScannerInSameProcess
```
public void setScannerInSameProcess(boolean isScanner)
```
    Reserved for internal use by the library.
  - checkIfMainProcess
```
protected void checkIfMainProcess()
```
  - getBeaconParsers
```
@NonNull
public List<BeaconParser> getBeaconParsers()
```
    Gets a list of the active beaconParsers.
    
    Returns:
    
    list of active BeaconParsers
  - checkAvailability
```
public boolean checkAvailability()
                          throws BleNotAvailableException
```
    Check if Bluetooth LE is supported by this Android device, and if so, make sure it is enabled.
    
    Returns:
    
    false if it is supported and not enabled
    
    Throws:
    
    BleNotAvailableException - if Bluetooth LE is not supported. (Note: The Android emulator will do this)
  - bind
```
public void bind(@NonNull
                 BeaconConsumer consumer)
```
    Binds an Android Activity or Service to the BeaconService. The Activity or Service must implement the beaconConsumer interface so that it can get a callback when the service is ready to use.
    
    Parameters:
    
    consumer - the Activity or Service that will receive the callback when the service is ready.
  - unbind
```
public void unbind(@NonNull
                   BeaconConsumer consumer)
```
    Unbinds an Android Activity or Service to the BeaconService. This should typically be called in the onDestroy() method.
    
    Parameters:
    
    consumer - the Activity or Service that no longer needs to use the service.
  - isBound
```
public boolean isBound(@NonNull
                       BeaconConsumer consumer)
```
    Tells you if the passed beacon consumer is bound to the service
    
    Parameters:
    
    consumer -
    
    Returns:
  - isAnyConsumerBound
```
public boolean isAnyConsumerBound()
```
    Tells you if the any beacon consumer is bound to the service
    
    Returns:
  - setBackgroundMode
```
public void setBackgroundMode(boolean backgroundMode)
```
    This method notifies the beacon service that the application is either moving to background mode or foreground mode. When in background mode, BluetoothLE scans to look for beacons are executed less frequently in order to save battery life. The specific scan rates for background and foreground operation are set by the defaults below, but may be customized. When ranging in the background, the time between updates will be much less frequent than in the foreground. Updates will come every time interval equal to the sum total of the BackgroundScanPeriod and the BackgroundBetweenScanPeriod.
    
    Parameters:
    
    backgroundMode - true indicates the app is in the background
    
    See Also:
    
    DEFAULT_FOREGROUND_SCAN_PERIOD, #DEFAULT_FOREGROUND_BETWEEN_SCAN_PERIOD;, #DEFAULT_BACKGROUND_SCAN_PERIOD;, #DEFAULT_BACKGROUND_BETWEEN_SCAN_PERIOD;, setForegroundScanPeriod(long p), setForegroundBetweenScanPeriod(long p), setBackgroundScanPeriod(long p), setBackgroundBetweenScanPeriod(long p)
  - setEnableScheduledScanJobs
```
public void setEnableScheduledScanJobs(boolean enabled)
```
    Configures using a `ScanJob` run with the `JobScheduler` to perform scans rather than using a long-running `BeaconService` to do so. Calling with true on devices older than Android L (5.0) will not apply the change as the JobScheduler is not available. This value defaults to true on Android O+ and false on devices with older OS versions. Accepting the default value of false is recommended on Android N and earlier because otherwise beacon scans may be run only once every 15 minutes in the background, and no low power scans may be performed between scanning cycles. Setting this value to false will disable ScanJobs when the app is run on Android 8+, which can prohibit delivery of callbacks when the app is in the background unless the scanning process is running in a foreground service. This method may only be called if bind() has not yet been called, otherwise an `IllegalStateException` is thown.
    
    Parameters:
    
    enabled -
  - getScheduledScanJobsEnabled
```
public boolean getScheduledScanJobsEnabled()
```
  - getBackgroundMode
```
public boolean getBackgroundMode()
```
  - getBackgroundScanPeriod
```
public long getBackgroundScanPeriod()
```
  - getBackgroundBetweenScanPeriod
```
public long getBackgroundBetweenScanPeriod()
```
  - getForegroundScanPeriod
```
public long getForegroundScanPeriod()
```
  - getForegroundBetweenScanPeriod
```
public long getForegroundBetweenScanPeriod()
```
  - isBackgroundModeUninitialized
```
public boolean isBackgroundModeUninitialized()
```
    Returns:
    
    indicator of whether any calls have yet been made to set the background mode
  - setRangeNotifier
```
@Deprecated
public void setRangeNotifier(@Nullable
                                         RangeNotifier notifier)
```
    Deprecated. replaced by (@link #addRangeNotifier)
    
    Specifies a class that should be called each time the BeaconService gets ranging data, which is nominally once per second when beacons are detected.
    IMPORTANT: Only one RangeNotifier may be active for a given application. If two different activities or services set different RangeNotifier instances, the last one set will receive all the notifications.
    
    Parameters:
    
    notifier - The RangeNotifier to register.
    
    See Also:
    
    RangeNotifier
  - addRangeNotifier
```
public void addRangeNotifier(@NonNull
                             RangeNotifier notifier)
```
    Specifies a class that should be called each time the BeaconService gets ranging data, which is nominally once per second when beacons are detected.
    Permits to register several RangeNotifier objects.
    The notifier must be unregistered using (@link #removeRangeNotifier)
    
    Parameters:
    
    notifier - The RangeNotifier to register.
    
    See Also:
    
    RangeNotifier
  - removeRangeNotifier
```
public boolean removeRangeNotifier(@NonNull
                                   RangeNotifier notifier)
```
    Specifies a class to remove from the array of RangeNotifier
    
    Parameters:
    
    notifier - The RangeNotifier to unregister.
    
    See Also:
    
    RangeNotifier
  - removeAllRangeNotifiers
```
public void removeAllRangeNotifiers()
```
    Remove all the Range Notifiers.
  - setMonitorNotifier
```
@Deprecated
public void setMonitorNotifier(@Nullable
                                           MonitorNotifier notifier)
```
    Deprecated. replaced by addMonitorNotifier(org.altbeacon.beacon.MonitorNotifier)
    
    Specifies a class that should be called each time the BeaconService sees or stops seeing a Region of beacons.
    IMPORTANT: Only one MonitorNotifier may be active for a given application. If two different activities or services set different MonitorNotifier instances, the last one set will receive all the notifications.
    
    Parameters:
    
    notifier - The MonitorNotifier to register.
    
    See Also:
    
    MonitorNotifier, startMonitoringBeaconsInRegion(Region), Region
  - addMonitorNotifier
```
public void addMonitorNotifier(@NonNull
                               MonitorNotifier notifier)
```
    Specifies a class that should be called each time the BeaconService sees or stops seeing a Region of beacons.
    Permits to register several MonitorNotifier objects.
    Unregister the notifier using removeMonitoreNotifier(org.altbeacon.beacon.MonitorNotifier)
    
    Parameters:
    
    notifier - The MonitorNotifier to register.
    
    See Also:
    
    MonitorNotifier, startMonitoringBeaconsInRegion(Region), Region
  - removeMonitoreNotifier
```
@Deprecated
public boolean removeMonitoreNotifier(@NonNull
                                                  MonitorNotifier notifier)
```
    Deprecated. Misspelled. Replaced by removeMonitorNotifier(org.altbeacon.beacon.MonitorNotifier)
    
    See Also:
    
    removeMonitorNotifier(org.altbeacon.beacon.MonitorNotifier)
  - removeMonitorNotifier
```
public boolean removeMonitorNotifier(@NonNull
                                     MonitorNotifier notifier)
```
    Specifies a class to remove from the array of MonitorNotifier.
    
    Parameters:
    
    notifier - The MonitorNotifier to unregister.
    
    See Also:
    
    MonitorNotifier, startMonitoringBeaconsInRegion(Region), Region
  - removeAllMonitorNotifiers
```
public void removeAllMonitorNotifiers()
```
    Remove all the Monitor Notifiers.
  - setRegionStatePeristenceEnabled
```
@Deprecated
public void setRegionStatePeristenceEnabled(boolean enabled)
```
    Deprecated. Misspelled. Replaced by setRegionStatePersistenceEnabled(boolean)
    
    See Also:
    
    setRegionStatePersistenceEnabled(boolean)
  - setRegionStatePersistenceEnabled
```
public void setRegionStatePersistenceEnabled(boolean enabled)
```
    Turns off saving the state of monitored regions to persistent storage so it is retained over app restarts. Defaults to enabled. When enabled, there will not be an "extra" region entry event when the app starts up and a beacon for a monitored region was previously visible within the past 15 minutes. Note that there is a limit to 50 monitored regions that may be persisted. If more than 50 regions are monitored, state is not persisted for any.
    
    Parameters:
    
    enabled - true to enable the region state persistence, false to disable it.
  - isRegionStatePersistenceEnabled
```
public boolean isRegionStatePersistenceEnabled()
```
    Indicates whether region state preservation is enabled
    
    Returns:
  - requestStateForRegion
```
public void requestStateForRegion(@NonNull
                                  Region region)
```
    Requests the current in/out state on the specified region. If the region is being monitored, this will cause an asynchronous callback on the `MonitorNotifier`'s `didDetermineStateForRegion` method. If it is not a monitored region, it will be ignored.
    
    Parameters:
    
    region -
  - startRangingBeaconsInRegion
```
public void startRangingBeaconsInRegion(@NonNull
                                        List<Region> regions)
                                 throws RemoteException
```
    Throws:
    
    RemoteException
  - stopRangingBeaconsInRegion
```
public void stopRangingBeaconsInRegion(@NonNull
                                       List<Region> regions)
                                throws RemoteException
```
    Throws:
    
    RemoteException
  - stopAllRangingBeaconsInRegion
```
public void stopAllRangingBeaconsInRegion()
                                   throws RemoteException
```
    Throws:
    
    RemoteException
  - startRangingBeaconsInRegion
```
public void startRangingBeaconsInRegion(@NonNull
                                        Region region)
                                 throws RemoteException
```
    Tells the BeaconService to start looking for beacons that match the passed Region object, and providing updates on the estimated mDistance every seconds while beacons in the Region are visible. Note that the Region's unique identifier must be retained to later call the stopRangingBeaconsInRegion method.
    
    Parameters:
    
    region -
    
    Throws:
    
    RemoteException
    
    See Also:
    
    setRangeNotifier(RangeNotifier), stopRangingBeaconsInRegion(Region region), RangeNotifier, Region
  - stopRangingBeaconsInRegion
```
public void stopRangingBeaconsInRegion(@NonNull
                                       Region region)
                                throws RemoteException
```
    Tells the BeaconService to stop looking for beacons that match the passed Region object and providing mDistance information for them.
    
    Parameters:
    
    region -
    
    Throws:
    
    RemoteException
    
    See Also:
    
    setMonitorNotifier(MonitorNotifier notifier), startMonitoringBeaconsInRegion(Region region), MonitorNotifier, Region
  - applySettings
```
public void applySettings()
```
    Call this method if you are running the scanner service in a different process in order to synchronize any configuration settings, including BeaconParsers to the scanner
    
    See Also:
    
    isScannerInDifferentProcess()
  - syncSettingsToService
```
protected void syncSettingsToService()
```
  - startMonitoringBeaconsInRegion
```
public void startMonitoringBeaconsInRegion(@NonNull
                                           List<Region> regions)
                                    throws RemoteException
```
    Throws:
    
    RemoteException
  - stopMonitoringBeaconsInRegion
```
public void stopMonitoringBeaconsInRegion(@NonNull
                                          List<Region> regions)
                                   throws RemoteException
```
    Throws:
    
    RemoteException
  - stopAllMonitoringBeaconsInRegion
```
public void stopAllMonitoringBeaconsInRegion()
                                      throws RemoteException
```
    Throws:
    
    RemoteException
  - startMonitoringBeaconsInRegion
```
public void startMonitoringBeaconsInRegion(@NonNull
                                           Region region)
                                    throws RemoteException
```
    Tells the BeaconService to start looking for beacons that match the passed Region object. Note that the Region's unique identifier must be retained to later call the stopMonitoringBeaconsInRegion method.
    
    Parameters:
    
    region -
    
    Throws:
    
    RemoteException
    
    See Also:
    
    setMonitorNotifier(MonitorNotifier), stopMonitoringBeaconsInRegion(Region region), MonitorNotifier, Region
  - stopMonitoringBeaconsInRegion
```
public void stopMonitoringBeaconsInRegion(@NonNull
                                          Region region)
                                   throws RemoteException
```
    Tells the BeaconService to stop looking for beacons that match the passed Region object. Note that the Region's unique identifier is used to match it to an existing monitored Region.
    
    Parameters:
    
    region -
    
    Throws:
    
    RemoteException
    
    See Also:
    
    setMonitorNotifier(MonitorNotifier), startMonitoringBeaconsInRegion(Region region), MonitorNotifier, Region
  - updateScanPeriods
```
public void updateScanPeriods()
                       throws RemoteException
```
    Updates an already running scan with scanPeriod/betweenScanPeriod according to Background/Foreground state. Change will take effect on the start of the next scan cycle.
    
    Throws:
    
    RemoteException - - If the BeaconManager is not bound to the service.
  - getMonitoringNotifier
```
@Deprecated
 @Nullable
public MonitorNotifier getMonitoringNotifier()
```
    Deprecated. replaced by (@link #getMonitorNotifiers)
    
    Returns:
    
    the first registered monitorNotifier
  - getMonitoringNotifiers
```
@NonNull
public Set<MonitorNotifier> getMonitoringNotifiers()
```
    Read-only access to the registered MonitorNotifier instances
    This provides a thread-safe "read-only" view of the Set of registered monitor notifiers. Attempts to modify the returned set, or its iterator, will throw an UnsupportedOperationException. Modifications to the underlying set should be made through addMonitorNotifier(MonitorNotifier) and removeMonitorNotifier(MonitorNotifier).
    
    Returns:
    
    a thread-safe unmodifiable view providing "read-only" access to the registered MonitorNotifier instances
    
    See Also:
    
    addMonitorNotifier(MonitorNotifier), removeMonitorNotifier(MonitorNotifier), Collections.unmodifiableSet(Set)
  - getRangingNotifier
```
@Deprecated
 @Nullable
public RangeNotifier getRangingNotifier()
```
    Deprecated. replaced by (@link #getRangeNotifiers)
    
    Returns:
    
    the first registered rangeNotifier
  - getRangingNotifiers
```
@NonNull
public Set<RangeNotifier> getRangingNotifiers()
```
    Read-only access to the registered RangeNotifier instances
    This provides a thread-safe "read-only" view of the Set of registered range notifiers. Attempts to modify the returned set, or its iterator, will throw an UnsupportedOperationException. Modifications to the underlying set should be made through addRangeNotifier(RangeNotifier) and removeRangeNotifier(RangeNotifier).
    
    Returns:
    
    a thread-safe unmodifiable view providing "read-only" access to the registered RangeNotifier instances
    
    See Also:
    
    addRangeNotifier(RangeNotifier), removeRangeNotifier(RangeNotifier), Collections.unmodifiableSet(Set)
  - getMonitoredRegions
```
@NonNull
public Collection<Region> getMonitoredRegions()
```
    Returns:
    
    the list of regions currently being monitored
  - getRangedRegions
```
@NonNull
public Collection<Region> getRangedRegions()
```
    Returns:
    
    the list of regions currently being ranged
  - logDebug
```
@Deprecated
public static void logDebug(String tag,
                                        String message)
```
    Deprecated. This will be removed in a later release. Use LogManager.d(String, String, Object...) instead.
    
    Convenience method for logging debug by the library
    
    Parameters:
    
    tag -
    
    message -
  - logDebug
```
@Deprecated
public static void logDebug(String tag,
                                        String message,
                                        Throwable t)
```
    Deprecated. This will be removed in a later release. Use LogManager.d(Throwable, String, String, Object...) instead.
    
    Convenience method for logging debug by the library
    
    Parameters:
    
    tag -
    
    message -
    
    t -
  - getDistanceModelUpdateUrl
```
public static String getDistanceModelUpdateUrl()
```
  - setDistanceModelUpdateUrl
```
public static void setDistanceModelUpdateUrl(@NonNull
                                             String url)
```
  - setRssiFilterImplClass
```
public static void setRssiFilterImplClass(@NonNull
                                          Class c)
```
  - getRssiFilterImplClass
```
public static Class getRssiFilterImplClass()
```
  - setUseTrackingCache
```
public static void setUseTrackingCache(boolean useTrackingCache)
```
    Allow the library to use a tracking cache
    
    Parameters:
    
    useTrackingCache -
  - setMaxTrackingAge
```
public void setMaxTrackingAge(int maxTrackingAge)
```
    Set the period of time, in which a beacon did not receive new measurements
    
    Parameters:
    
    maxTrackingAge - in milliseconds
  - setBeaconSimulator
```
public static void setBeaconSimulator(BeaconSimulator beaconSimulator)
```
  - getBeaconSimulator
```
@Nullable
public static BeaconSimulator getBeaconSimulator()
```
  - setDataRequestNotifier
```
protected void setDataRequestNotifier(@Nullable
                                      RangeNotifier notifier)
```
  - getDataRequestNotifier
```
@Nullable
protected RangeNotifier getDataRequestNotifier()
```
  - getNonBeaconLeScanCallback
```
@Nullable
public NonBeaconLeScanCallback getNonBeaconLeScanCallback()
```
  - setNonBeaconLeScanCallback
```
public void setNonBeaconLeScanCallback(@Nullable
                                       NonBeaconLeScanCallback callback)
```
  - isAndroidLScanningDisabled
```
public static boolean isAndroidLScanningDisabled()
```
    Determines if Android L Scanning is disabled by user selection
    
    Returns:
  - setAndroidLScanningDisabled
```
public static void setAndroidLScanningDisabled(boolean disabled)
```
    Allows disabling use of Android L BLE Scanning APIs on devices with API 21+ If set to false (default), devices with API 21+ will use the Android L APIs to scan for beacons
    
    Parameters:
    
    disabled -
  - setsManifestCheckingDisabled
```
@Deprecated
public static void setsManifestCheckingDisabled(boolean disabled)
```
    Deprecated.
    
    Deprecated misspelled method
    
    Parameters:
    
    disabled -
    
    See Also:
    
    setManifestCheckingDisabled(boolean)
  - setManifestCheckingDisabled
```
public static void setManifestCheckingDisabled(boolean disabled)
```
    Allows disabling check of manifest for proper configuration of service. Useful for unit testing
    
    Parameters:
    
    disabled -
  - getManifestCheckingDisabled
```
public static boolean getManifestCheckingDisabled()
```
    Returns whether manifest checking is disabled
  - enableForegroundServiceScanning
```
public void enableForegroundServiceScanning(Notification notification,
                                            int notificationId)
                                     throws IllegalStateException
```
    Configures the library to use a foreground service for bacon scanning. This allows nearly constant scanning on most Android versions to get around background limits, and displays an icon to the user to indicate that the app is doing something in the background, even on Android 8+. This will disable the user of the JobScheduler on Android 8 to do scans. Note that this method does not by itself enable constant scanning. The scan intervals will work as normal and must be configurd to specific values depending on how often you wish to scan.
    
    Parameters:
    
    notification - - the notification that will be displayed when beacon scanning is active, along with the icon that shows up in the status bar.
    
    Throws:
    
    IllegalStateException - if called after consumers are already bound to the scanning service
    
    See Also:
    
    setForegroundScanPeriod(long), This method requires a notification to display a message to the user about why the app is scanning in the background. The notification must include an icon that will be displayed in the top bar whenever the scanning service is running. If the BeaconService is configured to run in a different process, this call will have no effect.
  - disableForegroundServiceScanning
```
public void disableForegroundServiceScanning()
                                      throws IllegalStateException
```
    Disables a foreground scanning service, if previously configured.
    
    Throws:
    
    IllegalStateException - if called after consumers are already bound to the scanning service
    
    See Also:
    
    In order to call this method to disable a foreground service, you must unbind from the BeaconManager. You can then rebind after this call is made.
  - getForegroundServiceNotification
```
public Notification getForegroundServiceNotification()
```
    Returns:
    
    The notification shown for the beacon scanning service, if so configured
    
    See Also:
    
    enableForegroundServiceScanning(android.app.Notification, int)
  - getForegroundServiceNotificationId
```
public int getForegroundServiceNotificationId()
```
    Returns:
    
    The notification shown for the beacon scanning service, if so configured
    
    See Also:
    
    enableForegroundServiceScanning(android.app.Notification, int)

Class BeaconManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sInstance

rangeNotifiers

dataRequestNotifier

monitorNotifiers

DEFAULT_FOREGROUND_SCAN_PERIOD

DEFAULT_FOREGROUND_BETWEEN_SCAN_PERIOD

DEFAULT_BACKGROUND_SCAN_PERIOD

DEFAULT_BACKGROUND_BETWEEN_SCAN_PERIOD

DEFAULT_EXIT_PERIOD

beaconSimulator

distanceModelUpdateUrl

rssiFilterImplClass

Constructor Detail

BeaconManager

Method Detail

setDebug

setSdkNotifier

notifyException

setForegroundScanPeriod

setForegroundBetweenScanPeriod

setBackgroundScanPeriod

setBackgroundBetweenScanPeriod

setRegionExitPeriod

getRegionExitPeriod

getInstanceForApplication

isMainProcess

isScannerInDifferentProcess

setScannerInSameProcess

checkIfMainProcess

getBeaconParsers

checkAvailability

bind

unbind

isBound

isAnyConsumerBound

setBackgroundMode

setEnableScheduledScanJobs

getScheduledScanJobsEnabled

getBackgroundMode

getBackgroundScanPeriod

getBackgroundBetweenScanPeriod

getForegroundScanPeriod

getForegroundBetweenScanPeriod

isBackgroundModeUninitialized

setRangeNotifier

addRangeNotifier

removeRangeNotifier

removeAllRangeNotifiers

setMonitorNotifier

addMonitorNotifier

removeMonitoreNotifier

removeMonitorNotifier

removeAllMonitorNotifiers

setRegionStatePeristenceEnabled

setRegionStatePersistenceEnabled

isRegionStatePersistenceEnabled

requestStateForRegion

startRangingBeaconsInRegion

stopRangingBeaconsInRegion

stopAllRangingBeaconsInRegion

startRangingBeaconsInRegion

stopRangingBeaconsInRegion

applySettings

syncSettingsToService

startMonitoringBeaconsInRegion

stopMonitoringBeaconsInRegion

stopAllMonitoringBeaconsInRegion

startMonitoringBeaconsInRegion

stopMonitoringBeaconsInRegion

updateScanPeriods

getMonitoringNotifier

getMonitoringNotifiers

getRangingNotifier