A singleton class to manage analytics data.
More...
#include <juce_Analytics.h>
A singleton class to manage analytics data.
Use an Analytics object to manage sending analytics data to one or more AnalyticsDestinations.
- See also
- AnalyticsDestination, ThreadedAnalyticsDestination, AnalyticsDestination::AnalyticsEvent
@tags{Analytics}
◆ Analytics()
juce::Analytics::Analytics |
( |
| ) |
|
|
privatedefault |
◆ ~Analytics()
juce::Analytics::~Analytics |
( |
| ) |
|
|
inlineoverrideprivate |
◆ addDestination()
◆ deleteAll()
static void juce::DeletedAtShutdown::deleteAll |
( |
| ) |
|
|
staticinherited |
Deletes all extant objects.
This shouldn't be used by applications, as it's called automatically in the shutdown code of the JUCEApplicationBase class.
◆ getDestinations()
Returns the array of AnalyticsDestinations managed by this class.
If you have added any subclasses of ThreadedAnalyticsDestination to this class then you can remove them from this list to force them to flush any pending events.
◆ logEvent()
Sends an AnalyticsEvent to all AnalyticsDestinations.
The AnalyticsEvent will be timestamped, and will have the userId and userProperties populated by values previously set by calls to setUserId and setUserProperties. The name, parameters and type will be populated by the arguments supplied to this function.
- Parameters
-
eventName | the event name |
parameters | the event parameters |
eventType | (optional) an integer to indicate the event type, which will be set to 0 if not supplied. |
◆ setSuspended()
void juce::Analytics::setSuspended |
( |
bool |
shouldBeSuspended | ) |
|
Suspends analytics submissions to AnalyticsDestinations.
- Parameters
-
shouldBeSuspended | if event submission should be suspended |
◆ setUserId()
void juce::Analytics::setUserId |
( |
String |
newUserId | ) |
|
Sets a user ID that will be added to all AnalyticsEvents sent to AnalyticsDestinations.
- Parameters
-
newUserId | the userId to add to AnalyticsEvents |
◆ setUserProperties()
Sets some user properties that will be added to all AnalyticsEvents sent to AnalyticsDestinations.
- Parameters
-
properties | the userProperties to add to AnalyticsEvents |
◆ destinations
◆ isSuspended
bool juce::Analytics::isSuspended = false |
|
private |
◆ userId
String juce::Analytics::userId |
|
private |
◆ userProperties
The documentation for this class was generated from the following file: