QInsightConfiguration Class

{
    "server" : "collect-insight.qt.io",
    "token" : "00000000-0000-0000-0000-000000000000",
    "device_model" :  "model 1",
    "device_variant" : "a",
    "device_screen_type" : "NON_TOUCH",
    "platform" : "app",
    "app_build" : "1.2.3",
    "storage" : "SQLITE",
    "storage_path" : "",
    "sync" : {
        "interval" : {
            "seconds" : 0
            "minutes" : 0
            "hours" : 1
            "days" : 0
            "months" : 0
        },
        "max_batch_size" : 100
    }
}

Member Function Documentation

QInsightConfiguration::QInsightConfiguration(QObject *parent = nullptr)

Construct a new configuration object with the given parent.

QString QInsightConfiguration::appBuild() const

Returns current application's build version.

Note: Getter function for property appBuild.

See also setAppBuild().

int QInsightConfiguration::batchSize() const

Returns current sync batch size.

Note: Getter function for property batchSize.

See also setBatchSize().

QStringList QInsightConfiguration::categories()

Returns currently enabled categories.

Note: Getter function for property categories.

See also setCategories().

QString QInsightConfiguration::deviceModel() const

Returns current device model.

Note: Getter function for property deviceModel.

See also setDeviceModel().

QString QInsightConfiguration::deviceScreenType() const

Returns current screen type.

Note: Getter function for property deviceScreenType.

See also setDeviceScreenType().

QString QInsightConfiguration::deviceVariant() const

Returns current device variant.

Note: Getter function for property deviceVariant.

See also setDeviceVariant().

QStringList QInsightConfiguration::events()

Returns currently enabled events.

Note: Getter function for property event.

See also setEvents().

bool QInsightConfiguration::isValid()

Returns true if configuratio is valid.

bool QInsightConfiguration::load()

Load existing configurations from a file. Returns true is configuration was successfully loaded.

QString QInsightConfiguration::platform() const

Returns current platform.

Note: Getter function for property platform.

See also setPlatform().

QString QInsightConfiguration::server() const

Returns current server address.

Note: Getter function for property server.

See also setServer().

void QInsightConfiguration::setAppBuild(const QString &appBuild)

Set application's build version appBuild.

Note: Setter function for property appBuild.

See also appBuild().

void QInsightConfiguration::setBatchSize(int batchSize)

Set sync batch size to batchSize. Defines how many events are sent to network in one go.

Note: Setter function for property batchSize.

See also batchSize().

void QInsightConfiguration::setCategories(const QStringList &categories)

Set list of enabled categories to categories.

Note: Setter function for property categories.

See also categories().

void QInsightConfiguration::setDeviceModel(const QString &deviceModel)

Set device model to deviceModel.

Note: Setter function for property deviceModel.

See also deviceModel().

void QInsightConfiguration::setDeviceScreenType(const QString &deviceScreenType)

Set device screen type to deviceScreenType.

Note: Setter function for property deviceScreenType.

See also deviceScreenType().

void QInsightConfiguration::setDeviceVariant(const QString &deviceVariant)

Set device variant to deviceVariant.

Note: Setter function for property deviceVariant.

See also deviceVariant().

void QInsightConfiguration::setEvents(const QStringList &events)

Set list of enabled events to events.

Note: Setter function for property event.

See also events().

void QInsightConfiguration::setPlatform(const QString &platform)

Set platform to platform

Note: Setter function for property platform.

See also platform().

void QInsightConfiguration::setServer(const QString &server)

Set server address to server.

Note: Setter function for property server.

See also server().

void QInsightConfiguration::setStoragePath(const QString &storagePath)

Set storage path to storagePath.

Note: Setter function for property storagePath.

See also storagePath().

void QInsightConfiguration::setStorageSize(int storageSize)

Set storage size to storageSize.

Note: Setter function for property storageSize.

See also storageSize().

void QInsightConfiguration::setStorageType(const QString &storageType)

Set storage type to storageType.

Note: Setter function for property storageType.

See also storageType().

void QInsightConfiguration::setSyncInterval(int syncInterval)

Set sync interval to syncInterval seconds.

Note: Setter function for property syncInterval.

See also syncInterval().

void QInsightConfiguration::setToken(const QString &token)

Set server token to token.

Note: Setter function for property token.

See also token().

void QInsightConfiguration::setUserId(const QString &userId)

Set user identifier to userId. If userId is empty, a generated random UUID will be used.

Note: Setter function for property userId.

See also userId().

QString QInsightConfiguration::storagePath() const

Returns current storage path.

Note: Getter function for property storagePath.

See also setStoragePath().

int QInsightConfiguration::storageSize() const

Returns current storage size.

Note: Getter function for property storageSize.

See also setStorageSize().

QString QInsightConfiguration::storageType() const

Returns current storage type.

Note: Getter function for property storageType.

See also setStorageType().

int QInsightConfiguration::syncInterval() const

Returns current sync interval in seconds.

Note: Getter function for property syncInterval.

See also setSyncInterval().

QString QInsightConfiguration::token() const

Returns current server token.

Note: Getter function for property token.

See also setToken().

QString QInsightConfiguration::userId()

Returns current user identifier used in the tracked events.

Note: Getter function for property userId.

See also setUserId().