QtAutoUpdater::UpdateInfo Class Reference

Provides information about updates for components. More...

#include <updateinfo.h>

Public Member Functions
	UpdateInfo ()
	Default constructor.
	UpdateInfo (QVariant identifier, QString name, QVersionNumber version, QVariantMap data={})
	Initializing constructor.
	UpdateInfo (const UpdateInfo &other)
	Copy constructor.
	UpdateInfo (UpdateInfo &&other) noexcept
	Move constructor.
UpdateInfo &	operator= (const UpdateInfo &other)
	Copy assignment operator.
UpdateInfo &	operator= (UpdateInfo &&other) noexcept
	Move assignment operator.
bool	operator== (const UpdateInfo &other) const
	Equality operator.
bool	operator!= (const UpdateInfo &other) const
	Inequality operator.
QVariant	identifier () const
	READ accessor for UpdateInfo::identifier.
QString	name () const
	READ accessor for UpdateInfo::name.
QVersionNumber	version () const
	READ accessor for UpdateInfo::version.
QVariantMap	data () const
	READ accessor for UpdateInfo::data.
void	setIdentifier (QVariant identifier)
	WRITE accessor for UpdateInfo::identifier.
void	setName (QString name)
	WRITE accessor for UpdateInfo::name.
void	setVersion (QVersionNumber version)
	WRITE accessor for UpdateInfo::version.
void	setData (QVariantMap data)
	WRITE accessor for UpdateInfo::data.
void	setData (const QString &key, const QVariant &value)
	WRITE accessor for UpdateInfo::data.

Properties
QVariant	identifier
	An unspecified identifier for the update. More...
QString	name
	The name of the component that has an update. More...
QVersionNumber	version
	The new version for that compontent. More...
QVariantMap	data
	Additional properties of the update. More...

Detailed Description

Provides information about updates for components.

A data gadget that holds details about updates. It is used to present updates information. While id, name and version are common to all backends, any additional information, like size, old versions, etc. are different for each backend and stored within the data property.

See also

Updater Backend Plugins

Definition at line 14 of file updateinfo.h.

Property Documentation

data

QtAutoUpdater::UpdateInfo::data

readwrite

Additional properties of the update.

Default: <empty map>

What this map contains depends fully on the backend and any additional information it may provide. Check the Updater Backend Plugins documentation for more details.

Accessors
READ	data()
WRITE	setData()

See also

UpdateInfo::version, Updater Backend Plugins

Definition at line 25 of file updateinfo.h.

identifier

QtAutoUpdater::UpdateInfo::identifier

readwrite

An unspecified identifier for the update.

Default: <invalid>

This id is different for each backend regarding both it's type and value. The only assumption you can make about this id is, that it is comparable. You should never actually read the data of the returned QVariant. Only use it index in a map or similar, to identify update information.

Accessors
READ	identifier()
WRITE	setIdentifier()

See also

UpdateInfo::name

Definition at line 19 of file updateinfo.h.

name

QtAutoUpdater::UpdateInfo::name

readwrite

The name of the component that has an update.

Default: <empty>

This should be a human readable name as returned by the backends. There are no assumptions you can make regarding the format, language, etc. of this name. It is unique to each backend and follows the package conventions of that backend.

Accessors
READ	name()
WRITE	setName()

See also

UpdateInfo::identifier

Definition at line 21 of file updateinfo.h.

version

QtAutoUpdater::UpdateInfo::version

readwrite

The new version for that compontent.

Default: <empty version>

The version can be used to compare versions of components or to be displayed to the user. It may not be the full version string of the underlying backend, as QVersionNumber strips versions down to segments only.

Accessors
READ	version()
WRITE	setVersion()

See also

UpdateInfo::data

Definition at line 23 of file updateinfo.h.

---

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

• updateinfo.h
• updateinfo.dox