summaryrefslogtreecommitdiff
path: root/meshmc/libraries/ganalytics/include/ganalytics.h
blob: 8c6550a922fb1b4d39122f7f5346eb620c68b015 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/* SPDX-FileCopyrightText: 2026 Project Tick
 * SPDX-FileContributor: Project Tick
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 *   MeshMC - A Custom Launcher for Minecraft
 *   Copyright (C) 2026 Project Tick
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#pragma once

#include <QObject>
#include <QVariantMap>

class QNetworkAccessManager;
class GAnalyticsWorker;

class GAnalytics : public QObject
{
	Q_OBJECT
	Q_ENUMS(LogLevel)

  public:
	explicit GAnalytics(const QString& trackingID, const QString& clientID,
						const int version, QObject* parent = 0);
	~GAnalytics();

  public:
	enum LogLevel { Debug, Info, Error };

	int version();

	void setLogLevel(LogLevel logLevel);
	LogLevel logLevel() const;

	// Getter and Setters
	void setViewportSize(const QString& viewportSize);
	QString viewportSize() const;

	void setLanguage(const QString& language);
	QString language() const;

	void setAnonymizeIPs(bool anonymize);
	bool anonymizeIPs();

	void setSendInterval(int milliseconds);
	int sendInterval() const;

	void enable(bool state = true);
	bool isEnabled();

	/// Get or set the network access manager. If none is set, the class creates
	/// its own on the first request
	void setNetworkAccessManager(QNetworkAccessManager* networkAccessManager);
	QNetworkAccessManager* networkAccessManager() const;

  public slots:
	void sendScreenView(const QString& screenName,
						const QVariantMap& customValues = QVariantMap());
	void sendEvent(const QString& category, const QString& action,
				   const QString& label = QString(),
				   const QVariant& value = QVariant(),
				   const QVariantMap& customValues = QVariantMap());
	void sendException(const QString& exceptionDescription,
					   bool exceptionFatal = true,
					   const QVariantMap& customValues = QVariantMap());
	void startSession();
	void endSession();

  private:
	GAnalyticsWorker* d;

	friend QDataStream& operator<<(QDataStream& outStream,
								   const GAnalytics& analytics);
	friend QDataStream& operator>>(QDataStream& inStream,
								   GAnalytics& analytics);
};

QDataStream& operator<<(QDataStream& outStream, const GAnalytics& analytics);
QDataStream& operator>>(QDataStream& inStream, GAnalytics& analytics);