• BlackBerry Dynamics
  • Runtime library for iOS applications
  • 12.1.1.43
BAFBlackberryAnalytics Class Reference

Class for BlackBerry Analytics. More...

#import <BlackberryDynamics/GD/BAFBlackberryAnalytics.h>

Inheritance diagram for BAFBlackberryAnalytics:

Description

BlackBerry Analytics

BlackBerry Analytics provides developers and UEM administrators metrics about the BlackBerry Dynamics apps and devices in an organization's environment. BlackBerry Dynamics apps with this feature enabled by their administrator will periodically send events (including startup, crash information) and data (including OS, minutes used, app name, version) to the BlackBerry Analytics platform. The BlackBerry Analytics platform processes and compiles the events and data into dashboard reports. An app developer can optionally use this programmatic interface to record usage of custom features or events within their app to enable these metrics to be included within the Analytics dashboard.

For more information, see the BlackBerry Analytics documentation.

Class Methods

(void) + trackFeatureEvent:withFeatureName:completion:
 Record feature events to analyse the period a specific app feature is used. More...
 
(void) + trackApplicationEvent:withValue:forKey:completion:
 Record adoption events to analyse the frequency of specific user actions or events. More...
 

Method Documentation

◆ trackFeatureEvent:withFeatureName:completion:

+ (void) trackFeatureEvent: (BAFAnalyticsEvent event
withFeatureName: (NSString *_Nonnull)  featureName
completion: (_Nullable BAFAnalyticsResponseCompletion completion 

Call to record an event that has a start point (a "feature active event") followed by a stop point (a "feature inactive event"). The start and stop points provide a period of time where the feature was active. This type of event is typically used to measure user engagement of app features. The name that is used to track a feature must be unique within the app.

Parameters
eventBAFAnalyticsEvent specifies the type of event. For example, FEATURE_ACTIVE or FEATURE_INACTIVE.
featureNameNSString containing the name of the feature for a given event.
completionThe completion block to be invoked when the operation completes. BAFAnalyticsResponse will return RECORD_SUCCESS if event is valid or a specific error otherwise.

◆ trackApplicationEvent:withValue:forKey:completion:

+ (void) trackApplicationEvent: (BAFAnalyticsEvent event
withValue: (NSString *_Nonnull)  eventValue
forKey: (NSString *_Nonnull)  eventKey
completion: (_Nullable BAFAnalyticsResponseCompletion completion 

Call to record an event which occurs in your application. An adoption event has two attributes, key and value. The key must be unique within the app, and the value is a count of the number of times a specific event occurs (for example, an event key called "Emails deleted" that tracks the number of emails deleted by a user). The adoption event value should be the string representation of the integer count. An app can combine events and record a single event.

Parameters
eventAnalyticsEvent specifies the type of event. In this case use ADOPTION_EVENT.
eventValueNSString containing the event value to record for the given event key.
eventKeyNSString to define the name of the event.
completionThe completion block to be invoked when the operation completes. BAFAnalyticsResponse will return RECORD_SUCCESS if event is valid or a specific error otherwise.

The documentation for this class was generated from the following file: