com.eyro.cubeacon

Class CBApp

java.lang.Object

com.eyro.cubeacon.CBApp

public final class CBApp
extends java.lang.Object

Singleton class for managing Cubeacon SDK

Version:

1.5.0

Author:

Eyro Labs

Field Summary

Fields

Modifier and Type	Field and Description
com.eyro.cubeacon.helper.ImageLoader	imageLoader

Method Summary

Modifier and Type	Method and Description
void	createService() Creating Cubeacon SDK service.
static void	enableDebugLogging() Enable Cubeacon SDK debug logging.
static void	enableDebugLogging(boolean isDebugMode) Deprecated. Use enableDebugLogging() instead.
static void	enableDownloadImage(boolean flag) Deprecated. Method to initialize flag of download brochure image on CBApp#refreshBeaconInBackground.
static void	exitSDK(android.app.Activity activity) Deprecated. Use stopService instead.
void	getDataInBackground(RequestCallback callback) Request the latest beacon and storyline data in background thread.
static CBApp	getInstance() Gets the instance of Cubeacon SDK.
static java.lang.String	getSDKVersion() Shows Cubeacon SDK version
static void	initialize(android.content.Context context, java.lang.String propertiesFile) Initialize Cubeacon SDK.
static void	initialize(android.content.Context applicationContext, java.lang.String propertiesFile, java.lang.String cbId, java.lang.String cbKey, java.lang.String kiiAppId, java.lang.String kiiAppKey, java.lang.String kiiSite) Initialize Cubeacon SDK.
static void	refreshBeaconInBackground(android.content.Context context, com.eyro.cubeacon.CBConstant.RefreshCallback callback) Deprecated. Use getDataInBackground instead.
void	setBeaconListener(android.content.Context context) Setting up beacon listener for internal activity.
void	setBeaconListener(android.content.Context context, BeaconListener listener) Setting up beacon listener for external activity.
void	setScanPeriod(ScanningMode mode) Setting up beacon scan period for foreground and background scanning.
static void	setup(android.content.Context context, java.lang.String propertiesFile) Deprecated. Use initialize(Context, String) instead.
static void	setup(android.content.Context applicationContext, java.lang.String cbId, java.lang.String cbKey, java.lang.String kiiAppId, java.lang.String kiiAppKey, java.lang.String kiiSite, boolean applyStoryline, boolean showBackgroundAlert, boolean showForegroundAlert, boolean showAlertOnEnter, boolean showAlertOnExit, java.lang.String defaultAlertTitle, java.lang.String defaultAlertMessage) Deprecated. Use initialize(Context, String, String, String, String, String, String) instead.
void	startService() Starting Cubeacon SDK service.
void	stopService() Stopping all Cubeacon SDK service.

Methods inherited from class java.lang.Object

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

Field Detail

imageLoader

public final com.eyro.cubeacon.helper.ImageLoader imageLoader

Method Detail

setup

@Deprecated
public static void setup(android.content.Context applicationContext,
                                     java.lang.String cbId,
                                     java.lang.String cbKey,
                                     java.lang.String kiiAppId,
                                     java.lang.String kiiAppKey,
                                     java.lang.String kiiSite,
                                     boolean applyStoryline,
                                     boolean showBackgroundAlert,
                                     boolean showForegroundAlert,
                                     boolean showAlertOnEnter,
                                     boolean showAlertOnExit,
                                     java.lang.String defaultAlertTitle,
                                     java.lang.String defaultAlertMessage)

Deprecated. Use initialize(Context, String, String, String, String, String, String) instead.

Method to initialize setup of Cubeacon SDK.

Parameters:

applicationContext - the application context

cbId - the Cubeacon App Id

cbKey - the Cubeacon App Key

kiiAppId - the Kii App Id

kiiAppKey - the Kii App Key

kiiSite - the Kii Site

applyStoryline - boolean to indicate if storyline mode is applied

showBackgroundAlert - boolean to indicate if showing background alert

showForegroundAlert - boolean to indicate if showing foreground alert

showAlertOnEnter - boolean to indicate if showing alert on enter beacon

showAlertOnExit - boolean to indicate if showing alert on exit beacon

defaultAlertTitle - default String of alert title

defaultAlertMessage - default String of alert message

setup

@Deprecated
public static void setup(android.content.Context context,
                                     java.lang.String propertiesFile)

Deprecated. Use initialize(Context, String) instead.

Method to initialize setup of Cubeacon SDK.

Parameters:

context - the application context

propertiesFile - the properties file

initialize

public static void initialize(android.content.Context context,
                              java.lang.String propertiesFile)

Initialize Cubeacon SDK.

Parameters:

context - the application context

propertiesFile - the properties file

initialize

public static void initialize(android.content.Context applicationContext,
                              java.lang.String propertiesFile,
                              java.lang.String cbId,
                              java.lang.String cbKey,
                              java.lang.String kiiAppId,
                              java.lang.String kiiAppKey,
                              java.lang.String kiiSite)

Initialize Cubeacon SDK.

Parameters:

applicationContext - the application context

propertiesFile - the properties file

cbId - the Cubeacon App Id

cbKey - the Cubeacon App Key

kiiAppId - the Kii App Id

kiiAppKey - the Kii App Key

kiiSite - the Kii Site

getInstance

public static CBApp getInstance()

Gets the instance of Cubeacon SDK.

Returns:

instance of Cubeacon SDK

getSDKVersion

public static java.lang.String getSDKVersion()

Shows Cubeacon SDK version

Returns:

String of Cubeacon SDK version

enableDebugLogging

@Deprecated
public static void enableDebugLogging(boolean isDebugMode)

Deprecated. Use enableDebugLogging() instead.

Method to initialize flag of debug logging.

Parameters:

isDebugMode - the boolean status to enable/disable debug logging

enableDebugLogging

public static void enableDebugLogging()

Enable Cubeacon SDK debug logging.

enableDownloadImage

@Deprecated
public static void enableDownloadImage(boolean flag)

Deprecated. Method to initialize flag of download brochure image on CBApp#refreshBeaconInBackground.

Parameters:

flag - the boolean status to enable/disable download brochure image

refreshBeaconInBackground

@Deprecated
public static void refreshBeaconInBackground(android.content.Context context,
                                                         com.eyro.cubeacon.CBConstant.RefreshCallback callback)

Deprecated. Use getDataInBackground instead.

Request/get the latest data from Cloud using non blocking thread.

Parameters:

context - the context from activity

callback - the callback function that called after refreshBeaconInBackground complete

setBeaconListener

public void setBeaconListener(android.content.Context context)

Setting up beacon listener for internal activity.

Parameters:

context - context where beacon listener used

setBeaconListener

public void setBeaconListener(android.content.Context context,
                              BeaconListener listener)

Setting up beacon listener for external activity.

Parameters:

context - context where beacon listener used

listener - beacon listener

setScanPeriod

public void setScanPeriod(ScanningMode mode)

Setting up beacon scan period for foreground and background scanning.

Parameters:

mode - the Enum ScanningMode

createService

public void createService()

Creating Cubeacon SDK service.

exitSDK

@Deprecated
public static void exitSDK(android.app.Activity activity)

Deprecated. Use stopService instead.

Destroy all Cubeacon SDK service when exit app

Parameters:

activity - Activity where Cubeacon SDK exit

stopService

public void stopService()

Stopping all Cubeacon SDK service.

startService

public void startService()

Starting Cubeacon SDK service.

getDataInBackground

public void getDataInBackground(RequestCallback callback)

Request the latest beacon and storyline data in background thread.

Parameters:

callback - callback interface that called when getting data complete