117 lines
4.0 KiB
C
117 lines
4.0 KiB
C
|
/*
|
||
|
|
==============================================================================
|
||
|
|
|
||
|
|
This file is part of the JUCE library.
|
||
|
|
Copyright (c) 2020 - Raw Material Software Limited
|
||
|
|
|
||
|
|
JUCE is an open source library subject to commercial or open-source
|
||
|
|
licensing.
|
||
|
|
|
||
|
|
By using JUCE, you agree to the terms of both the JUCE 6 End-User License
|
||
|
|
Agreement and JUCE Privacy Policy (both effective as of the 16th June 2020).
|
||
|
|
|
||
|
|
End User License Agreement: www.juce.com/juce-6-licence
|
||
|
|
Privacy Policy: www.juce.com/juce-privacy-policy
|
||
|
|
|
||
|
|
Or: You may also use this code under the terms of the GPL v3 (see
|
||
|
|
www.gnu.org/licenses).
|
||
|
|
|
||
|
|
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
|
||
|
|
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
|
||
|
|
DISCLAIMED.
|
||
|
|
|
||
|
|
==============================================================================
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace juce
|
||
|
|
{
|
||
|
|
|
||
|
|
//==============================================================================
|
||
|
|
/**
|
||
|
|
A singleton class to manage analytics data.
|
||
|
|
|
||
|
|
Use an Analytics object to manage sending analytics data to one or more
|
||
|
|
AnalyticsDestinations.
|
||
|
|
|
||
|
|
@see AnalyticsDestination, ThreadedAnalyticsDestination,
|
||
|
|
AnalyticsDestination::AnalyticsEvent
|
||
|
|
|
||
|
|
@tags{Analytics}
|
||
|
|
*/
|
||
|
|
class JUCE_API Analytics : public DeletedAtShutdown
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
//==============================================================================
|
||
|
|
/** Adds an AnalyticsDestination to the list of AnalyticsDestinations
|
||
|
|
managed by this Analytics object.
|
||
|
|
|
||
|
|
The Analytics class will take ownership of the AnalyticsDestination
|
||
|
|
passed to this function.
|
||
|
|
|
||
|
|
@param destination the AnalyticsDestination to manage
|
||
|
|
*/
|
||
|
|
void addDestination (AnalyticsDestination* destination);
|
||
|
|
|
||
|
|
/** 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.
|
||
|
|
*/
|
||
|
|
OwnedArray<AnalyticsDestination>& getDestinations();
|
||
|
|
|
||
|
|
/** Sets a user ID that will be added to all AnalyticsEvents sent to
|
||
|
|
AnalyticsDestinations.
|
||
|
|
|
||
|
|
@param newUserId the userId to add to AnalyticsEvents
|
||
|
|
*/
|
||
|
|
void setUserId (String newUserId);
|
||
|
|
|
||
|
|
/** Sets some user properties that will be added to all AnalyticsEvents sent
|
||
|
|
to AnalyticsDestinations.
|
||
|
|
|
||
|
|
@param properties the userProperties to add to AnalyticsEvents
|
||
|
|
*/
|
||
|
|
void setUserProperties (StringPairArray properties);
|
||
|
|
|
||
|
|
/** 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.
|
||
|
|
|
||
|
|
@param eventName the event name
|
||
|
|
@param parameters the event parameters
|
||
|
|
@param eventType (optional) an integer to indicate the event
|
||
|
|
type, which will be set to 0 if not supplied.
|
||
|
|
*/
|
||
|
|
void logEvent (const String& eventName, const StringPairArray& parameters, int eventType = 0);
|
||
|
|
|
||
|
|
/** Suspends analytics submissions to AnalyticsDestinations.
|
||
|
|
|
||
|
|
@param shouldBeSuspended if event submission should be suspended
|
||
|
|
*/
|
||
|
|
void setSuspended (bool shouldBeSuspended);
|
||
|
|
|
||
|
|
#ifndef DOXYGEN
|
||
|
|
JUCE_DECLARE_SINGLETON (Analytics, false)
|
||
|
|
#endif
|
||
|
|
|
||
|
|
private:
|
||
|
|
//==============================================================================
|
||
|
|
Analytics() = default;
|
||
|
|
~Analytics() override { clearSingletonInstance(); }
|
||
|
|
|
||
|
|
String userId;
|
||
|
|
StringPairArray userProperties;
|
||
|
|
|
||
|
|
bool isSuspended = false;
|
||
|
|
|
||
|
|
OwnedArray<AnalyticsDestination> destinations;
|
||
|
|
|
||
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Analytics)
|
||
|
|
};
|
||
|
|
|
||
|
|
} // namespace juce
|