Cubeacon

java.lang.Object
- com.eyro.cubeacon.Cubeacon

```
public final class Cubeacon
extends java.lang.Object
```
Singleton class for managing Cubeacon SDK.

Version:

2.0.0

Author:

Eyro Labs

See Also:

CBBootstrapRegion

Field Summary

Fields
Modifier and Type	Field and Description
`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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMonitoringListener(CBMonitoringListener listener)` Specifies an interface listener that should be called each time the `BeaconService` sees or stops seeing a `CBRegion` of beacons.
`void`	`addRangingListener(CBRangingListener listener)` Specifies an interface that should be called each time the `BeaconService` gets ranging data, which is nominally once per second when beacons are detected.
`void`	`connect(CBServiceListener listener)` Connect an Android `Activity` or `Service` to the `BeaconService`.
`void`	`disconnect(CBServiceListener listener)` Disconnect an Android `Activity` or `Service` from the `BeaconService`.
`static Cubeacon`	`getInstance()` Gets the instance of Cubeacon SDK.
`static java.lang.String`	`getSDKVersion()` Shows Cubeacon SDK version string.
`static void`	`initialize(android.content.Context context)` Initialize Cubeacon SDK.
`boolean`	`isConnected(CBServiceListener listener)` Check if the passed service listener is bound to the service.
`static boolean`	`isInitialized()` Check whether Cubeacon SDK is initialized.
`void`	`removeMonitoringListener(CBMonitoringListener listener)` Specifies a class to remove from the array of `CBMonitoringListener`.
`void`	`removeMonitoringListeners()` Remove all registered monitoring listeners.
`void`	`removeRangingListener(CBRangingListener listener)` Specifies an interface to remove from the array of `CBRangingListener`
`void`	`removeRangingListeners()` Remove all registered ranging listeners.
`void`	`setBackgroundIntervalScanPeriod(long p)` Sets the duration in milliseconds of each Bluetooth LE scan cycle to look for beacons.
`void`	`setBackgroundMode(boolean backgroundMode)` This method notifies the beacon service that the application is either moving to background mode or foreground mode.
`static void`	`setBackgroundPowerSaver(boolean flag)` Sets background power saver mode.
`void`	`setBackgroundScanPeriod(long p)` Sets the duration in milliseconds of each Bluetooth LE scan cycle to look for beacons.
`void`	`setForegroundIntervalScanPeriod(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`	`setRegionExitPeriod(long period)` Set region exit period in milliseconds.
`void`	`startMonitoringForRegion(CBRegion region)` Tells the `BeaconService` to start looking for beacons that match the passed `CBRegion` object.
`void`	`startMonitoringForRegions(java.util.List<CBRegion> regions)` Tells the `BeaconService` to start looking for beacons that match the passed list of `CBRegion` object.
`void`	`startRangingBeaconsInRegion(CBRegion region)` Tells the `BeaconService` to start looking for beacons that match the passed `CBRegion` object, and providing updates on the estimated distance every seconds while beacons in the CBRegion are visible.
`void`	`startRangingBeaconsInRegions(java.util.List<CBRegion> regions)` Tells the `BeaconService` to start looking for beacons that match the passed list of `CBRegion` object, and providing updates on the estimated distance every seconds while beacons in the CBRegion are visible.
`void`	`stopMonitoringForRegion(CBRegion region)` Tells the `BeaconService` to stop looking for beacons that match the passed `CBRegion` object.
`void`	`stopRangingBeaconsInRegion(CBRegion region)` Tells the `BeaconService` to stop looking for beacons that match the passed `CBRegion` object.
`void`	`updateScanPeriods()` Updates an already running scan with scanPeriod/betweenScanPeriod according to Background/Foreground state.

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

- Field Detail
  - 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
- Method Detail
  - initialize
```
public static void initialize(android.content.Context context)
```
    Initialize Cubeacon SDK.
    
    Parameters:
    
    context - The application context
  - getInstance
```
public static Cubeacon getInstance()
```
    Gets the instance of Cubeacon SDK.
    
    Returns:
    
    instance of Cubeacon SDK
  - isInitialized
```
public static boolean isInitialized()
```
    Check whether Cubeacon SDK is initialized.
    
    Returns:
    
    true if it is already initialized, false otherwise
  - getSDKVersion
```
public static java.lang.String getSDKVersion()
```
    Shows Cubeacon SDK version string.
    
    Returns:
    
    String of Cubeacon SDK version.
  - setBackgroundPowerSaver
```
public static void setBackgroundPowerSaver(boolean flag)
```
    Sets background power saver mode. If enabled, it can improve battery life by 60% by slowing down scanning beacons when your app is in the background.
    
    Parameters:
    
    flag - true to enable background power save
    
    See Also:
    
    setBackgroundMode(boolean)
  - 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 that 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), setForegroundIntervalScanPeriod(long), setBackgroundScanPeriod(long), setBackgroundIntervalScanPeriod(long)
  - 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 connect(CBServiceListener) or when switching between background/foreground. To have it effect on an already running scan (when the next cycle starts), call updateScanPeriods()
    
    Parameters:
    
    p - The foreground period to set
  - setForegroundIntervalScanPeriod
```
public void setForegroundIntervalScanPeriod(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 connect(CBServiceListener) or when switching between background/foreground. To have it effect on an already running scan (when the next cycle starts), call updateScanPeriods()
    
    Parameters:
    
    p - The foreground interval to set
  - 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 connect(CBServiceListener) or when switching between background/foreground. To have it effect on an already running scan (when the next cycle starts), call updateScanPeriods()
    
    Parameters:
    
    p - The background period to set
  - setBackgroundIntervalScanPeriod
```
public void setBackgroundIntervalScanPeriod(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 connect(CBServiceListener) or when switching between background/foreground. To have it effect on an already running scan (when the next cycle starts), call updateScanPeriods()
    
    Parameters:
    
    p - The background interval to set
  - updateScanPeriods
```
public void updateScanPeriods()
                       throws android.os.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:
    
    android.os.RemoteException - If the Cubeacon is not connected to the service.
  - setRegionExitPeriod
```
public static void setRegionExitPeriod(long period)
```
    Set region exit period in milliseconds.
    
    Parameters:
    
    period - The period when region exit
  - addMonitoringListener
```
public void addMonitoringListener(CBMonitoringListener listener)
```
    Specifies an interface listener that should be called each time the BeaconService sees or stops seeing a CBRegion of beacons.
    Permits to register severals CBMonitoringListener objects.
    Unregister the listener using removeMonitoringListener(CBMonitoringListener)
    
    Parameters:
    
    listener - The monitoring listener interface to add
    
    See Also:
    
    CBMonitoringListener, startMonitoringForRegion(CBRegion), CBRegion
  - removeMonitoringListener
```
public void removeMonitoringListener(CBMonitoringListener listener)
```
    Specifies a class to remove from the array of CBMonitoringListener.
    
    Parameters:
    
    listener - The monitoring interface listener to remove
    
    See Also:
    
    CBMonitoringListener, startMonitoringForRegion(CBRegion), CBRegion
  - removeMonitoringListeners
```
public void removeMonitoringListeners()
```
    Remove all registered monitoring listeners.
  - addRangingListener
```
public void addRangingListener(CBRangingListener listener)
```
    Specifies an interface 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 CBRangingListener objects.
    The listener must be unregistered using removeRangingListener(CBRangingListener)
    
    Parameters:
    
    listener - The ranging interface listener to add
    
    See Also:
    
    CBRangingListener, startRangingBeaconsInRegion(CBRegion), CBRegion
  - removeRangingListener
```
public void removeRangingListener(CBRangingListener listener)
```
    Specifies an interface to remove from the array of CBRangingListener
    
    Parameters:
    
    listener - The ranging interface listener to remove
    
    See Also:
    
    CBRangingListener
  - removeRangingListeners
```
public void removeRangingListeners()
```
    Remove all registered ranging listeners.
  - connect
```
public void connect(CBServiceListener listener)
```
    Connect an Android Activity or Service to the BeaconService. The Activity or Service must implement the listener interface so that it can get a callback when the service is ready to use.
    
    Parameters:
    
    listener - the Activity or Service that will receive the callback when the service is ready.
  - disconnect
```
public void disconnect(CBServiceListener listener)
```
    Disconnect an Android Activity or Service from the BeaconService. This should typically be called in the onDestroy() method.
    
    Parameters:
    
    listener - the Activity or Service that no longer needs to use the service.
    
    See Also:
    
    connect(CBServiceListener)
  - isConnected
```
public boolean isConnected(CBServiceListener listener)
```
    Check if the passed service listener is bound to the service.
    
    Parameters:
    
    listener - The service listener to check
    
    Returns:
    
    true is sercive already connected
    
    See Also:
    
    connect(CBServiceListener), disconnect(CBServiceListener)
  - startRangingBeaconsInRegion
```
public void startRangingBeaconsInRegion(CBRegion region)
                                 throws android.os.RemoteException
```
    Tells the BeaconService to start looking for beacons that match the passed CBRegion object, and providing updates on the estimated distance every seconds while beacons in the CBRegion are visible. Note that the Region's unique identifier must be retained to later call the stopRangingBeaconsInRegion(CBRegion) method.
    
    Parameters:
    
    region - The region to start ranging
    
    Throws:
    
    android.os.RemoteException - If the Cubeacon is not connected to the service.
    
    See Also:
    
    addRangingListener(CBRangingListener), stopRangingBeaconsInRegion(CBRegion), CBRangingListener, CBRegion
  - stopRangingBeaconsInRegion
```
public void stopRangingBeaconsInRegion(CBRegion region)
                                throws android.os.RemoteException
```
    Tells the BeaconService to stop looking for beacons that match the passed CBRegion object.
    
    Parameters:
    
    region - The region to stop ranging
    
    Throws:
    
    android.os.RemoteException - If the Cubeacon is not connected to the service.
    
    See Also:
    
    addRangingListener(CBRangingListener), startRangingBeaconsInRegion(CBRegion), CBRangingListener, CBRegion
  - startRangingBeaconsInRegions
```
public void startRangingBeaconsInRegions(java.util.List<CBRegion> regions)
                                  throws android.os.RemoteException
```
    Tells the BeaconService to start looking for beacons that match the passed list of CBRegion object, and providing updates on the estimated distance every seconds while beacons in the CBRegion are visible. Note that the Region's unique identifier must be retained to later call the stopRangingBeaconsInRegion(CBRegion) method.
    
    Parameters:
    
    regions - The list of region to start ranging
    
    Throws:
    
    android.os.RemoteException - If the Cubeacon is not connected to the service.
    
    See Also:
    
    addRangingListener(CBRangingListener), stopRangingBeaconsInRegion(CBRegion), CBRangingListener, CBRegion
  - startMonitoringForRegion
```
public void startMonitoringForRegion(CBRegion region)
                              throws android.os.RemoteException
```
    Tells the BeaconService to start looking for beacons that match the passed CBRegion object. Note that the Region's unique identifier must be retained to later call the stopMonitoringForRegion(CBRegion) method.
    
    Parameters:
    
    region - The region to start monitoring
    
    Throws:
    
    android.os.RemoteException - If the Cubeacon is not connected to the service.
    
    See Also:
    
    addMonitoringListener(CBMonitoringListener), stopMonitoringForRegion(CBRegion), CBMonitoringListener, CBRegion
  - stopMonitoringForRegion
```
public void stopMonitoringForRegion(CBRegion region)
                             throws android.os.RemoteException
```
    Tells the BeaconService to stop looking for beacons that match the passed CBRegion object.
    
    Parameters:
    
    region - The region to stop monitoring
    
    Throws:
    
    android.os.RemoteException - If the Cubeacon is not connected to the service.
    
    See Also:
    
    addMonitoringListener(CBMonitoringListener), startMonitoringForRegion(CBRegion), CBMonitoringListener, CBRegion
  - startMonitoringForRegions
```
public void startMonitoringForRegions(java.util.List<CBRegion> regions)
                               throws android.os.RemoteException
```
    Tells the BeaconService to start looking for beacons that match the passed list of CBRegion object. Note that the Region's unique identifier must be retained to later call the stopMonitoringForRegion(CBRegion) method.
    
    Parameters:
    
    regions - The list of region to start monitoring
    
    Throws:
    
    android.os.RemoteException - If the Cubeacon is not connected to the service.
    
    See Also:
    
    addMonitoringListener(CBMonitoringListener), stopMonitoringForRegion(CBRegion), CBMonitoringListener, CBRegion

Class Cubeacon

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FOREGROUND_SCAN_PERIOD

DEFAULT_FOREGROUND_BETWEEN_SCAN_PERIOD

DEFAULT_BACKGROUND_SCAN_PERIOD

DEFAULT_BACKGROUND_BETWEEN_SCAN_PERIOD

DEFAULT_EXIT_PERIOD

Method Detail

initialize

getInstance

isInitialized

getSDKVersion

setBackgroundPowerSaver

setBackgroundMode

setForegroundScanPeriod

setForegroundIntervalScanPeriod

setBackgroundScanPeriod

setBackgroundIntervalScanPeriod

updateScanPeriods

setRegionExitPeriod

addMonitoringListener

removeMonitoringListener

removeMonitoringListeners

addRangingListener

removeRangingListener

removeRangingListeners

connect

disconnect

isConnected

startRangingBeaconsInRegion

stopRangingBeaconsInRegion

startRangingBeaconsInRegions

startMonitoringForRegion

stopMonitoringForRegion

startMonitoringForRegions