QInsightTracker Class

Control the Qt Insight Tracker and send events to the back-end server. More...

Header:	`#include <QInsightTracker>`
CMake:	`find_package(Qt6 REQUIRED COMPONENTS InsightTracker)` `target_link_libraries(mytarget PRIVATE Qt6::InsightTracker)`
qmake:	`QT += insighttracker`
In QML:	InsightTracker
Inherits:	QObject

List of all members, including inherited members

Public Functions

	QInsightTracker()
	~QInsightTracker()
void	clearCache()
QInsightConfiguration *	configuration() const
void	dimensionData(const QString &key, QString &value) const
void	interaction(const QString &name, const QString &category = QString()) const
void	interaction(const QString &name, const QString &contextKey, double contextValue, const QString &category = QString()) const
bool	isEnabled() const
void	setEnabled(bool enabled)
void	startNewSession()
void	transition(const QString &name) const
void	transition(const QString &name, const QString &contextKey, double contextValue) const

Detailed Description

QInsightTracker provides a C++ API that can be used to control the tracker and to send events to the back-end server.

Member Function Documentation

QInsightTracker::QInsightTracker()

Constructs a tracker object. All tracker objects share the same back-end server and configuration.

`[noexcept default]` QInsightTracker::~QInsightTracker()

Destroys the tracker object and frees all allocated resources.

void QInsightTracker::clearCache()

Clear all events from the local cache.

QInsightConfiguration *QInsightTracker::configuration() const

Configure the tracker

See also QInsightConfiguration.

void QInsightTracker::dimensionData(const QString &key, QString &value) const

Send custom dimension data in key / value pair.

void QInsightTracker::interaction(const QString &name, const QString &category = QString()) const

Send a interaction event name. The optional category parameter can be used to filter tracking of the events.

void QInsightTracker::interaction(const QString &name, const QString &contextKey, double contextValue, const QString &category = QString()) const

Send a interaction event name with additional context data. Context data can be sent as a key/value pair in contextKey and contextValue. The optional category parameter can be used to filter tracking of the events.

bool QInsightTracker::isEnabled() const

Is tracking enabled. Returns true if tracking is enabled

See also QInsightTracker::setEnabled.

void QInsightTracker::setEnabled(bool enabled)

Enable or disable tracking.

See also QInsightTracker::isEnabled.

void QInsightTracker::startNewSession()

Start a new session A new session id is generated and then used in all subsequent events.

void QInsightTracker::transition(const QString &name) const

Send a transition event name. Use transition events to track the current state of the UI. Transition events can be sent whenever your application changes UI views or states, or whenever there are other UI flow changes such as dialog and notification pop-ups.

void QInsightTracker::transition(const QString &name, const QString &contextKey, double contextValue) const

Send a transition event name with additional context data. Context data can be sent as a key/value pair in contextKey and contextValue. Use transition events to track the current state of the UI. Transition events can be sent whenever your application changes UI views or states, or whenever there are other UI flow changes such as dialog and notification pop-ups.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.