ESTAnalyticsManager

@interface ESTAnalyticsManager : NSObject

ESTAnalyticsManager class is responsible for registering analytics requests and events, triggered by ranging and monitoring CLBeaconRegion. Manager sends to Estimote Cloud up to 100 registered analytics events every 20 seconds.

Warning

Important: works only with iBeacon devices returned by ESTBeaconManager and `ESTSecureBeaconManager.
  • Method allows to track analytics event for given region. Analytics events will be cached and sent to Estimote Cloud.

    Warning

    If ESTGPSPositionManager is enabled then ESTAnalyticsManager will create analytic event with GPS location assigned.

    Declaration

    Objective-C

    - (void)registerAnalyticsEventWithRegion:(CLBeaconRegion *)region
                                        type:(ESTAnalyticsEventType)eventType;

    Swift

    func registerAnalyticsEvent(with region: CLBeaconRegion!, type eventType: ESTAnalyticsEventType)

    Parameters

    region

    CLBeaconRegion object, for which analytics events will be tracked

    eventType

    ESTAnalyticsEventType enum of tracked analytics events

  • Method allows sending stored analytics events to Estimote Cloud.

    Declaration

    Objective-C

    - (void)sendRegisteredEvents;

    Swift

    func sendRegisteredEvents()
  • Method returns ESTAnalyticsEventType enum for given CLProximity.

    Declaration

    Objective-C

    + (ESTAnalyticsEventType)getEventTypeForProximity:(CLProximity)proximity;

    Swift

    class func getEventType(for proximity: CLProximity) -> ESTAnalyticsEventType
  • 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

  • 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

  • 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

  • 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

  • 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