QtUtilities::Updater Class Reference

The Updater class allows downloading and applying an update. More...

#include <updater.h>

Inheritance diagram for QtUtilities::Updater:

Collaboration diagram for QtUtilities::Updater:

Classes
struct	Update

Public Types
using	VerifyFunction = std::function<QString(const Update &)>

Public Slots
bool	performUpdate (const QString &downloadUrl, const QString &signatureUrl)
void	abortUpdate ()

Signals
void	inProgressChanged (bool inProgress)
void	updateFailed (const QString &error)
void	updateStored ()
void	updatePercentageChanged (qint64 bytesReceived, qint64 bytesTotal)
void	updateStatusChanged (const QString &statusMessage)

Public Member Functions
	Updater (const QString &executableName, QObject *parent=nullptr)
	Updater (const QString &executableName, const QString &signatureExtension, QObject *parent=nullptr)
	~Updater () override
bool	isInProgress () const
QString	overallStatus () const
const QString &	error () const
const QString &	statusMessage () const
const QString &	storedPath () const
void	setNetworkAccessManager (QNetworkAccessManager *nm)
void	setVerifier (VerifyFunction &&verifyFunction)

Properties
bool	inProgress
QString	overallStatus
QString	error
QString	statusMessage
QString	storedPath

Detailed Description

The Updater class allows downloading and applying an update.

Remarks

This class is experimental and might be changed in incompatible ways (API and ABI wise) or completely removed in further minor/patch releases.

Definition at line 124 of file updater.h.

Member Typedef Documentation

VerifyFunction

using QtUtilities::Updater::VerifyFunction = std::function<QString(const Update &)>

Definition at line 139 of file updater.h.

Constructor & Destructor Documentation

Updater() [1/2]

QtUtilities::Updater::Updater ( const QString & executableName, QObject * parent = nullptr )

explicit

Definition at line 673 of file updater.cpp.

Updater() [2/2]

QtUtilities::Updater::Updater ( const QString & executableName, const QString & signatureExtension, QObject * parent = nullptr )

explicit

Definition at line 678 of file updater.cpp.

~Updater()

QtUtilities::Updater::~Updater ( )

override

Definition at line 698 of file updater.cpp.

Member Function Documentation

abortUpdate

void QtUtilities::Updater::abortUpdate ( )

slot

Definition at line 785 of file updater.cpp.

error()

const QString & QtUtilities::Updater::error

(

)

const

Definition at line 720 of file updater.cpp.

inProgressChanged

void QtUtilities::Updater::inProgressChanged ( bool inProgress )

signal

isInProgress()

bool QtUtilities::Updater::isInProgress

(

)

const

Definition at line 702 of file updater.cpp.

overallStatus()

QString QtUtilities::Updater::overallStatus

(

)

const

Definition at line 711 of file updater.cpp.

performUpdate

bool QtUtilities::Updater::performUpdate ( const QString & downloadUrl, const QString & signatureUrl )

slot

Definition at line 769 of file updater.cpp.

setNetworkAccessManager()

void QtUtilities::Updater::setNetworkAccessManager

(

QNetworkAccessManager *

nm

)

Definition at line 744 of file updater.cpp.

setVerifier()

void QtUtilities::Updater::setVerifier

(

VerifyFunction &&

verifyFunction

)

Definition at line 753 of file updater.cpp.

statusMessage()

const QString & QtUtilities::Updater::statusMessage

(

)

const

Definition at line 725 of file updater.cpp.

storedPath()

const QString & QtUtilities::Updater::storedPath

(

)

const

Definition at line 734 of file updater.cpp.

updateFailed

void QtUtilities::Updater::updateFailed ( const QString & error )

signal

updatePercentageChanged

void QtUtilities::Updater::updatePercentageChanged ( qint64 bytesReceived, qint64 bytesTotal )

signal

updateStatusChanged

void QtUtilities::Updater::updateStatusChanged ( const QString & statusMessage )

signal

updateStored

void QtUtilities::Updater::updateStored ( )

signal

Property Documentation

error

QString QtUtilities::Updater::error

read

Definition at line 128 of file updater.h.

inProgress

bool QtUtilities::Updater::inProgress

read

Definition at line 126 of file updater.h.

overallStatus

QString QtUtilities::Updater::overallStatus

read

Definition at line 127 of file updater.h.

statusMessage

QString QtUtilities::Updater::statusMessage

read

Definition at line 129 of file updater.h.

storedPath

QString QtUtilities::Updater::storedPath

read

Definition at line 130 of file updater.h.

---

The documentation for this class was generated from the following files:

• setup/updater.h
• setup/updater.cpp