ESTConfig

@interface ESTConfig : NSObject

ESTConfig is used to configure Estimote Cloud API. It allows to authorize app using AppID and AppToken and configure Estimote Analytics settings.

Estimote API Credentials

  • 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 Account Settings section of the Estimote Cloud.

    Declaration

    Objective-C

    + (void)setupAppID:(nonnull NSString *)appID
       andAppToken:(nonnull NSString *)appToken;

    Swift

    class func setupAppID(_ appID: String, andAppToken appToken: String)

    Parameters

    appID

    The API App ID.
    appToken

    The API App Token.

  • Returns currently used App ID.

    Declaration

    Objective-C

    + (NSString *_Nullable)appID;

    Swift

    class func appID() -> String?

    Return Value

    currently used App ID.

  • Returns currently used App Token.

    Declaration

    Objective-C

    + (NSString *_Nullable)appToken;

    Swift

    class func appToken() -> String?

    Return Value

    currently used App Token.

  • Checks if App ID and App Token were set.

    Declaration

    Objective-C

    + (BOOL)isAuthorized;

    Swift

    class func isAuthorized() -> Bool

  • Conveniece for current framework’s version.

    Declaration

    Objective-C

    + (nonnull NSString *)currentFrameworkVersion;

    Swift

    class func currentFrameworkVersion() -> String

    Return Value

    Framework’s version.

Google API Credentials

  • Sets Google API Key, enabling communication with Google API.

    You can get it from Google Developer Console ( https://console.developers.google.com ) using project credentials settings. Google API Key is required to properly resolve Eddystone-EID packet.

    Declaration

    Objective-C

    + (void)setupGoogleAPIKey:(nonnull NSString *)googleAPIKey;

    Swift

    class func setupGoogleAPIKey(_ googleAPIKey: String)

    Parameters

    googleAPIKey

    Google API Key.

  • Returns currently used Google API Key.

    Declaration

    Objective-C

    + (NSString *_Nullable)googleAPIKey;

    Swift

    class func googleAPIKey() -> String?

    Return Value

    currently used Google API Key.

Analytics settings

  • Deprecated

    Starting from SDK 4.1.1 this method is deprecated. Please use [ESTAnalyticsManager enableMonitoringAnalytics:]

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

    Declaration

    Objective-C

    + (void)enableMonitoringAnalytics:(BOOL)enable;

    Swift

    class func enableMonitoringAnalytics(_ enable: Bool)

    Parameters

    enable

    flag indicating if analytics for monitoring should be enabled

  • Deprecated

    Starting from SDK 4.1.1 this method is deprecated. Please use [ESTAnalyticsManager enableRangingAnalytics:]

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

    Declaration

    Objective-C

    + (void)enableRangingAnalytics:(BOOL)enable;

    Swift

    class func enableRangingAnalytics(_ enable: Bool)

    Parameters

    enable

    flag indicating if analytics for ranging should be enabled

  • Deprecated

    Starting from SDK 4.1.1 this method is deprecated. Please use [ESTAnalyticsManager enableGPSPositioningForAnalytics:]

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

    Declaration

    Objective-C

    + (void)enableGPSPositioningForAnalytics:(BOOL)enable;

    Swift

    class func enableGPSPositioning(forAnalytics enable: Bool)

    Parameters

    enable

    flag indicating if GPS Positioning should be enabled

  • Deprecated

    Starting from SDK 4.1.1 this method is deprecated. Please use [ESTAnalyticsManager isMonitoringAnalyticsEnabled:]

    Indicates current state of monitoring analytics.

    Declaration

    Objective-C

    + (BOOL)isMonitoringAnalyticsEnabled;

    Swift

    class func isMonitoringAnalyticsEnabled() -> Bool

    Return Value

    flag that indicates if analytics is enabled

  • Deprecated

    Starting from SDK 4.1.1 this method is deprecated. Please use [ESTAnalyticsManager isRangingAnalyticsEnabled:]

    Indicates current state of ranging analytics.

    Declaration

    Objective-C

    + (BOOL)isRangingAnalyticsEnabled;

    Swift

    class func isRangingAnalyticsEnabled() -> Bool

    Return Value

    flag that indicates if analytics is enabled