KUserFeedback::Provider Class

Member Function Documentation

[explicit] Provider::Provider(QObject *parent = nullptr)

Create a new feedback provider.

parent The parent object.

void Provider::addDataSource(KUserFeedback::AbstractDataSource *source)

Adds a data source for telemetry data collection.

source The data source to add. The Provider takes ownership of source.

int Provider::applicationStartsUntilEncouragement() const

Returns the amount of application starts before an encouragement message is shown.

See also setApplicationStartsUntilEncouragement().

int Provider::applicationUsageTimeUntilEncouragement() const

Returns the amount of application usage time before an encouragement message is shown.

See also setApplicationUsageTimeUntilEncouragement().

KUserFeedback::AbstractDataSource *Provider::dataSource(const QString &id) const

Returns a data source with matched id

id data source unique identifier

Returns pointer to found data source or nullptr if data source is not found

QVector<KUserFeedback::AbstractDataSource *> Provider::dataSources() const

Returns all data sources that have been added to this provider.

See also addDataSource.

[signal] void Provider::dataSourcesChanged()

Emitted when a data source is added or removed.

QString Provider::describeDataSources() const

Returns a string with each source and its enable mode.

[signal] void Provider::enabledChanged()

Emitted when the global enabled state changed.

int Provider::encouragementDelay() const

Returns the current encouragement delay in seconds.

See also setEncouragementDelay().

int Provider::encouragementInterval() const

Returns the current encouragement interval.

See also setEncouragementInterval().

QUrl Provider::feedbackServer() const

Returns the current feedback server URL.

See also setFeedbackServer().

bool Provider::isEnabled() const

Returns whether feedback functionality is enabled on this system.

This should be checked everywhere showing feedback UI to the user to respect the global "kill switch" for this. Provider does check this internally for encouragements, surveys and telemetry submission.

[slot] void Provider::load()

Manually load settings of the provider and all added data sources.

Automatically invoked after object construction and changing product ID.

QString Provider::productIdentifier() const

Returns the current product identifier.

See also setProductIdentifier().

[signal] void Provider::providerSettingsChanged()

Emitted when any provider setting changed.

[since 1.1.0] void Provider::restoreDefaults()

Set the telemetry mode and the survey interval back to their default values.

This function was introduced in 1.1.0.

See also telemetryMode() and surveyInterval().

void Provider::setApplicationStartsUntilEncouragement(int starts)

Set the amount of application starts until the encouragement message should be shown.

The default is -1, ie. no encouragement based on application starts.

starts The amount of application starts after which an encouragement message should be displayed.

See also applicationStartsUntilEncouragement().

void Provider::setApplicationUsageTimeUntilEncouragement(int secs)

Set the amount of usage time until the encouragement message should be shown.

The default is -1, ie. no encouragement based on application usage time.

secs Amount of seconds until the encouragement should be shown.

See also applicationUsageTimeUntilEncouragement().

void Provider::setEnabled(bool enabled)

Set the global (user-wide) activation state for feedback functionality.

See also isEnabled.

void Provider::setEncouragementDelay(int secs)

Set the delay after application start for the earliest display of the encouragement message.

The default is 300, ie. 5 minutes after the application start.

secs Amount of seconds after the application start for the earliest display of an encouragement message.

See also encouragementDelay(), setApplicationStartsUntilEncouragement, and setApplicationUsageTimeUntilEncouragement.

void Provider::setEncouragementInterval(int days)

Sets the interval after the encouragement should be repeated.

Encouragement messages are only repeated if no feedback options have been enabled.

The default is -1, that is no repeated encouragement at all.

days Days between encouragement messages, 0 disables repeated encouragements.

See also encouragementInterval().

void Provider::setFeedbackServer(const QUrl &url)

Set the feedback server URL.

This must be called with an appropriate URL for this class to be operational.

url The URL of the feedback server.

See also feedbackServer().

void Provider::setProductIdentifier(const QString &productId)

Set the product identifier.

This is used to distinguish independent products on the same server.

If this is not specified, the product identifier is derived from the application name organisation domain specified in QCoreApplication.

productId Unique product identifier, as configured on the feedback server.

See also productIdentifier().

void Provider::setSubmissionInterval(int days)

Set the automatic submission interval in days.

This must be called with a positive number for this class to be operational, as the default is -1 (no submission ever).

See also submissionInterval().

void Provider::setSurveyInterval(int days)

Sets the minimum time in days between two surveys.

-1 indicates no surveys should be requested.

0 indicates no minimum time between surveys at all (i.e. bother the user as often as you want).

See also surveyInterval().

void Provider::setTelemetryMode(KUserFeedback::Provider::TelemetryMode mode)

Set which telemetry data should be submitted.

See also telemetryMode().

[signal] void Provider::showEncouragementMessage()

Indicate that the encouragement notice should be shown.

[slot] void Provider::store()

Manually store settings of the provider and all added data sources.

Will be automatically invoked upon QCoreApplication::aboutToQuit() signal.

int Provider::submissionInterval() const

Returns the current submission interval.

Returns days between telemetry submissions, or -1 if submission is off.

See also setSubmissionInterval().

[slot] void Provider::submit()

Manually submit currently recorded data.

[signal] void Provider::surveyAvailable(const KUserFeedback::SurveyInfo &survey)

Emitted whenever there is a new survey available that can be presented to the user.

[slot] void Provider::surveyCompleted(const KUserFeedback::SurveyInfo &info)

Marks the given survey as completed. This avoids getting further notification about the same survey.

int Provider::surveyInterval() const

Returns the minimum time between two surveys in days.

The default is -1 (no surveys enabled).

See also setSurveyInterval().

[signal] void Provider::surveyIntervalChanged()

Emitted when the survey interval changed.

KUserFeedback::Provider::TelemetryMode Provider::telemetryMode() const

Returns the current telemetry collection mode.

The default is NoTelemetry.

See also setTelemetryMode().

[signal] void Provider::telemetryModeChanged()

Emitted when the telemetry collection mode has changed.