AnalyticsDestination Struct Referenceabstract

An interface for handling analytics events collected by an Analytics object. More...

Inheritance diagram for AnalyticsDestination:

Classes

struct  AnalyticsEvent
 Contains information about an event to be logged. More...
 

Public Member Functions

 AnalyticsDestination ()=default
 Constructor. More...
 
virtual ~AnalyticsDestination ()
 Destructor. More...
 
virtual void logEvent (const AnalyticsEvent &event)=0
 When an AnalyticsDestination is added to an Analytics object this method is called when an analytics event is triggered from the Analytics object. More...
 

Detailed Description

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 also
Analytics, ThreadedAnalyticsDestination

Constructor & Destructor Documentation

◆ AnalyticsDestination()

AnalyticsDestination::AnalyticsDestination ( )
default

Constructor.

◆ ~AnalyticsDestination()

virtual AnalyticsDestination::~AnalyticsDestination ( )
virtual

Member Function Documentation

◆ logEvent()

virtual void AnalyticsDestination::logEvent ( const AnalyticsEvent event)
pure virtual

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.

Implemented in ThreadedAnalyticsDestination.


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