com.eyro.cubeacon

Class CBBootstrapRegion

java.lang.Object

com.eyro.cubeacon.CBBootstrapRegion

public class CBBootstrapRegion
extends java.lang.Object

Class allowing a user to set up background launching of an app when a user enters a beacon Region. Simply constructing and holding a reference to this class will cause background scanning for beacons to start on Android device startup. If a matching beacon is detected, the CBBootstrapListener didEnterRegion method will be called, allowing the application to launch an Activity, send a local notification, or perform any other action desired.

Using this class as described above will also cause beacon scanning to start back up after power is connected or disconnected from a device if the user has force terminated the app.

IMPORTANT NOTE: The CBBootstrapRegion class registers an internal CBMonitoringListener with the Cubeacon. If you use the CBBootstrapRegion , your application must not manually register a second CBMonitoringListener, otherwise it will unregister the one configured by the CBBootstrapRegion, effectively disabling it. When using the CBBootstrapRegion, any custom monitoring code must therefore be placed in the callback methods in the CBMonitoringListener implementation passed to the CBBootstrapRegion.

Version:

2.0.0

Author:

Eyro Labs

Constructor Summary

Constructors

Constructor and Description
CBBootstrapRegion()

Method Summary

Modifier and Type	Method and Description
void	addBootstrapRegion(CBRegion region) Add a new bootstrap region for scanning.
void	disable() Used to disable additional bootstrap callbacks after the first is received.
void	removeBootstrapRegion(CBRegion region) Remove a given region for scanning.
static void	setup(CBBootstrapListener listener, CBRegion region) Initialize to bootstrap your Application on an entry/exit from a single region.
static void	setup(CBBootstrapListener listener, java.util.List<CBRegion> regions) Initialize to bootstrap your Application on an entry/exit from multiple region.

Methods inherited from class java.lang.Object

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

Constructor Detail

CBBootstrapRegion

public CBBootstrapRegion()

Method Detail

setup

public static void setup(CBBootstrapListener listener,
                         CBRegion region)

Initialize to bootstrap your Application on an entry/exit from a single region.

Parameters:

listener - The listener for bootstrap region

region - The region for scanning

setup

public static void setup(CBBootstrapListener listener,
                         java.util.List<CBRegion> regions)

Initialize to bootstrap your Application on an entry/exit from multiple region.

Parameters:

listener - The listener for bootstrap region

regions - The list of region for scanning

disable

public void disable()

Used to disable additional bootstrap callbacks after the first is received. Unless this is called, your application will be get additional calls as the supplied regions are entered or exited.

addBootstrapRegion

public void addBootstrapRegion(CBRegion region)

Add a new bootstrap region for scanning.

Parameters:

region - The region to add

removeBootstrapRegion

public void removeBootstrapRegion(CBRegion region)

Remove a given region for scanning.

Parameters:

region - The region to remove