98 lines
3.1 KiB
C
98 lines
3.1 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
|
||
|
|
{
|
||
|
|
|
||
|
|
//==============================================================================
|
||
|
|
/**
|
||
|
|
An interface for handling analytics events collected by an Analytics object.
|
||
|
|
|
||
|
|
For basic analytics logging you can implement this interface and add your
|
||
|
|
class to an Analytics object.
|
||
|
|
|
||
|
|
For more advanced logging you may want to subclass
|
||
|
|
ThreadedAnalyticsDestination instead, which is more suitable for interacting
|
||
|
|
with web servers and other time consuming destinations.
|
||
|
|
|
||
|
|
@see Analytics, ThreadedAnalyticsDestination
|
||
|
|
|
||
|
|
@tags{Analytics}
|
||
|
|
*/
|
||
|
|
struct JUCE_API AnalyticsDestination
|
||
|
|
{
|
||
|
|
/** Contains information about an event to be logged. */
|
||
|
|
struct AnalyticsEvent
|
||
|
|
{
|
||
|
|
/** The name of the event. */
|
||
|
|
String name;
|
||
|
|
|
||
|
|
/** An optional integer representing the type of the event. You can use
|
||
|
|
this to indicate if the event was a screenview, session start,
|
||
|
|
exception, etc.
|
||
|
|
*/
|
||
|
|
int eventType;
|
||
|
|
|
||
|
|
/**
|
||
|
|
The timestamp of the event.
|
||
|
|
|
||
|
|
Timestamps are automatically applied by an Analytics object and are
|
||
|
|
derived from Time::getMillisecondCounter(). As such these timestamps
|
||
|
|
do not represent absolute times, but relative timings of events for
|
||
|
|
each user in each session will be accurate.
|
||
|
|
*/
|
||
|
|
uint32 timestamp;
|
||
|
|
|
||
|
|
/** The parameters of the event. */
|
||
|
|
StringPairArray parameters;
|
||
|
|
|
||
|
|
/** The user ID associated with the event. */
|
||
|
|
String userID;
|
||
|
|
|
||
|
|
/** Properties associated with the user. */
|
||
|
|
StringPairArray userProperties;
|
||
|
|
};
|
||
|
|
|
||
|
|
/** Constructor. */
|
||
|
|
AnalyticsDestination() = default;
|
||
|
|
|
||
|
|
/** Destructor. */
|
||
|
|
virtual ~AnalyticsDestination() = default;
|
||
|
|
|
||
|
|
/**
|
||
|
|
When an AnalyticsDestination is added to an Analytics object this method
|
||
|
|
is called when an analytics event is triggered from the Analytics
|
||
|
|
object.
|
||
|
|
|
||
|
|
Override this method to log the event information somewhere useful.
|
||
|
|
*/
|
||
|
|
virtual void logEvent (const AnalyticsEvent& event) = 0;
|
||
|
|
|
||
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (AnalyticsDestination)
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
} // namespace juce
|