com.swirl

Class BeaconManager

java.lang.Object

com.swirl.Manager

com.swirl.BeaconManager

public final class BeaconManager
extends Manager

The BeaconManager manages the creation, resolution and state of Beacon objects. It listens for BeaconAdvertisements put onto the EventBus by BeaconScanners and create a Beacon object to aggregate those advertisements. Once created, it attempts to resolve the beacon to fetch any associated metadata.

For resolved beacons, the BeaconManager periodically reevaluates the range and state of the beacon and generates beacon state events as needed. These events are: BeaconEnter, BeaconExit, BeaconDwell and BeaconNearest.

An instance of this class is loaded and started by the library. You do not interact with this class directly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BeaconManager.BeaconDiscoverEvent This event is generated when a beacon is discovered
class	BeaconManager.BeaconDwellEvent This event is generated periodically as the mobile device remains within a beacon.
class	BeaconManager.BeaconEnterEvent This event is generated when a beacon is entered.
class	BeaconManager.BeaconEvent BeaconEvent is the base class for all events generated by the BeaconManager.
class	BeaconManager.BeaconExitEvent This event is generated when a beacon is exited.
class	BeaconManager.BeaconNearestEvent This event is generated when the nearest beacon changes.
class	BeaconManager.BeaconResolveEvent This event is generated when a beacon is resolved

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_ALL_DEVICES
static int	FLAG_REGISTERED_DEVICE
static int	FLAG_UNREGISTERED_DEVICE Called to return the current list of recently sighted, active beacon devices

Constructor Summary

Constructors

Constructor and Description
BeaconManager()

Method Summary

Modifier and Type	Method and Description
Beacon	findBeacon(java.lang.String ident, java.lang.String urn)
void	findBeacon(java.lang.String identifier, java.lang.String urn, long timeout, java.util.concurrent.Executor queue, Completion completion)
java.util.List<Beacon>	getActiveBeacons() Called to return the current list of recently sighted, active beacons
java.util.List<Beacon>	getActiveDevices() Called to return the current list of recently sighted, active beacon devices
java.util.List<Beacon>	getActiveDevices(long age, int rssi, int flags)
java.util.List<Beacon>	getAllBeacons() Called to return the current list of Beacons
static BeaconManager	getInstance() Called to return the last BeaconManager created.
void	init(android.content.Context context, EventBus events, java.util.concurrent.ScheduledExecutorService executor) Called when the manager is created to provide its execution environment.
void	onEvent(BeaconAdvertisement advertisement)
void	start() This is called by the system when started.
void	stop() This is called by the system when stopped.

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_UNREGISTERED_DEVICE

public static final int FLAG_UNREGISTERED_DEVICE

Called to return the current list of recently sighted, active beacon devices

See Also:

Constant Field Values

FLAG_REGISTERED_DEVICE

public static final int FLAG_REGISTERED_DEVICE

See Also:

Constant Field Values

FLAG_ALL_DEVICES

public static final int FLAG_ALL_DEVICES

See Also:

Constant Field Values

Constructor Detail

BeaconManager

public BeaconManager()

Method Detail

init

public void init(android.content.Context context,
                 EventBus events,
                 java.util.concurrent.ScheduledExecutorService executor)

Description copied from class: Manager

Called when the manager is created to provide its execution environment.

Parameters:

context - The application context to use

events - The EventBus that the manager is a member of

executor - The Executor to use and on which events are dispatched

getInstance

public static BeaconManager getInstance()

Called to return the last BeaconManager created. (Should be only one) Can return null if no BeaconManager has been initialized.

Returns:

beaconManager

getAllBeacons

public java.util.List<Beacon> getAllBeacons()

Called to return the current list of Beacons

getActiveBeacons

public java.util.List<Beacon> getActiveBeacons()

Called to return the current list of recently sighted, active beacons

getActiveDevices

public java.util.List<Beacon> getActiveDevices()

Called to return the current list of recently sighted, active beacon devices

getActiveDevices

public java.util.List<Beacon> getActiveDevices(long age,
                                               int rssi,
                                               int flags)

start

public void start()

This is called by the system when started.

stop

public void stop()

This is called by the system when stopped.

findBeacon

public Beacon findBeacon(java.lang.String ident,
                         java.lang.String urn)

findBeacon

public void findBeacon(java.lang.String identifier,
                       java.lang.String urn,
                       long timeout,
                       java.util.concurrent.Executor queue,
                       Completion completion)

onEvent

public void onEvent(BeaconAdvertisement advertisement)