com.estimote.coresdk.common.config

Class EstimoteSDK

java.lang.Object

com.estimote.coresdk.common.config.EstimoteSDK

public class EstimoteSDK
extends java.lang.Object

The EstimoteSDK class contains static functions that handle global configuration for the Estimote SDK.

Author:

wiktor@estimote.com (Wiktor Gworek)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION Version of Estimote SDK for Android.

Constructor Summary

Constructors

Constructor and Description
EstimoteSDK()

Method Summary

Modifier and Type	Method and Description
static void	enableDebugLogging(boolean enableDebugLogging) Enables debug logging of the Estimote SDK.
static void	enableGpsPositioningForAnalytics(boolean enable) When GPS Positioning is turned on analytics events contains information about GPS Location.
static void	enableMonitoringAnalytics(boolean enable) Enables analytics requests on Enter/Exit monitoring events.
static void	enableRangingAnalytics(boolean enable) Enables analytics requests for ranging events.
static java.lang.String	getAppId()
static android.content.Context	getApplicationContext() Getters
static java.lang.String	getAppToken()
static java.lang.String	getGoogleApiKey()
static void	initialize(android.content.Context applicationContext, java.lang.String appId, java.lang.String appToken) Sets App ID and App Token, enabling communication with the Estimote Cloud API.
static boolean	isGpsPositionAnalyticsEnabled() Indicates current state of gps positioning analytics
static boolean	isMonitoringAnalyticsEnabled() Indicates current state of monitoring analytics.
static boolean	isRangingAnalyticsEnabled() Indicates current state of ranging analytics.
static void	setGoogleApiKey(java.lang.String key) Setups Google API key for resolving EIDs in Google cloud.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

Version of Estimote SDK for Android.

Constructor Detail

EstimoteSDK

public EstimoteSDK()

Method Detail

initialize

public static void initialize(android.content.Context applicationContext,
                              java.lang.String appId,
                              java.lang.String appToken)

Sets App ID and App Token, enabling communication with the Estimote Cloud API. You can find your API App ID and API App Token in the Apps section of the Estimote Cloud.

Parameters:

applicationContext - Android application context.

appId - Application ID.

appToken - Application token.

enableDebugLogging

public static void enableDebugLogging(boolean enableDebugLogging)

Enables debug logging of the Estimote SDK.

Parameters:

enableDebugLogging - Whether enable debug logging.

enableMonitoringAnalytics

public static void enableMonitoringAnalytics(boolean enable)

Enables analytics requests on Enter/Exit monitoring events. Analytics data is collected in the Estimote Cloud.

Parameters:

enable - flag indicating if analytics for monitoring should be enabled

enableRangingAnalytics

public static void enableRangingAnalytics(boolean enable)

Enables analytics requests for ranging events. Information about beacons and their Proximity is collected in the Estimote Cloud.

Parameters:

enable - flag indicating if analytics for ranging should be enabled

enableGpsPositioningForAnalytics

public static void enableGpsPositioningForAnalytics(boolean enable)

When GPS Positioning is turned on analytics events contains information about GPS Location.

Parameters:

enable - flag indicating if GPS Positioning should be enabled

setGoogleApiKey

public static void setGoogleApiKey(java.lang.String key)

Setups Google API key for resolving EIDs in Google cloud.

Parameters:

key - pregenerated user API key

isMonitoringAnalyticsEnabled

public static boolean isMonitoringAnalyticsEnabled()

Indicates current state of monitoring analytics.

Returns:

flag that indicates if analytics is enabled

isRangingAnalyticsEnabled

public static boolean isRangingAnalyticsEnabled()

Indicates current state of ranging analytics.

Returns:

flag that indicates if analytics is enabled

isGpsPositionAnalyticsEnabled

public static boolean isGpsPositionAnalyticsEnabled()

Indicates current state of gps positioning analytics

Returns:

flag that indicates if analytics is enabled

getApplicationContext

public static android.content.Context getApplicationContext()

Getters

getAppId

public static java.lang.String getAppId()

getAppToken

public static java.lang.String getAppToken()

getGoogleApiKey

public static java.lang.String getGoogleApiKey()