KNSCore::Transaction

KNSCore
Transaction

#include <transaction.h>

Inheritance diagram for KNSCore::Transaction:

Signals
void	finished ()

void	signalEntryEvent (const KNSCore::Entry &entry, KNSCore::Entry::EntryEvent event)

void	signalErrorCode (KNSCore::ErrorCode::ErrorCode errorCode, const QString &message, const QVariant &metadata)

void	signalMessage (const QString &message)

Public Member Functions
bool	isFinished () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Static Public Member Functions
static Transaction *	adopt (EngineBase *engine, const Entry &entry)

static Transaction *	install (EngineBase *engine, const Entry &entry, int linkId=1)

static Transaction *	installLatest (EngineBase *engine, const Entry &entry)

static Transaction *	installLinkId (EngineBase *engine, const Entry &entry, quint8 linkId)

static Transaction *	uninstall (EngineBase *engine, const Entry &entry)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList

Properties inherited from QObject
	objectName

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

KNewStuff Transaction.

Exposes different actions that can be done on an entry and means to track them to completion.

To create a Transaction we should call one of the static methods that represent the different actions we can take. These will return the Transaction and we can use it to track mesages, the entries' states and eventually its completion using the @m finished signal.

The Transaction will delete itself once it has finished.

Since: 6.0

Definition at line 37 of file transaction.h.

Member Function Documentation

◆ adopt()

Transaction * Transaction::adopt	(	EngineBase *	engine,
		const Entry &	entry )

static

Adopt the entry from engine using the adoption command.

For more information, see the documentation about AdoptionCommand from the knsrc file.

Definition at line 427 of file transaction.cpp.

◆ install()

Transaction * Transaction::install	(	EngineBase *	engine,
		const Entry &	entry,
		int	linkId = 1 )

static

Performs an install on the given entry from the engine.

Parameters

linkId specifies which of the assets we want to see installed.

Returns: a Transaction object that we can use to track the progress to completion

Deprecated: since 6.9, use installLatest or installLinkId instead

Definition at line 261 of file transaction.cpp.

◆ installLatest()

Transaction * Transaction::installLatest	(	EngineBase *	engine,
		const Entry &	entry )

staticnodiscard

Performs an install of the latest version on the given entry from the engine.

The latest version is determined using heuristics. If you want tight control over which offering gets installed you need to use installLinkId and manually figure out the id.

Returns: a Transaction object that we can use to track the progress to completion

Since: 6.9

Definition at line 267 of file transaction.cpp.

◆ installLinkId()

Transaction * Transaction::installLinkId	(	EngineBase *	engine,
		const Entry &	entry,
		quint8	linkId )

staticnodiscard

Performs an install on the given entry from the engine.

Parameters

linkId specifies which of the assets we want to see installed.

Returns: a Transaction object that we can use to track the progress to completion

Since: 6.9

Definition at line 272 of file transaction.cpp.

◆ isFinished()

bool Transaction::isFinished ( ) const

Returns: true as soon as the Transaction is completed as it gets ready to clean itself up

Definition at line 469 of file transaction.cpp.

◆ signalEntryEvent

void KNSCore::Transaction::signalEntryEvent	(	const KNSCore::Entry &	entry,
		KNSCore::Entry::EntryEvent	event )

signal

Informs about how the entry has changed.

Parameters

event nature of the change

◆ signalErrorCode

void KNSCore::Transaction::signalErrorCode	(	KNSCore::ErrorCode::ErrorCode	errorCode,
		const QString &	message,
		const QVariant &	metadata )

signal

Fires in the case of any critical or serious errors, such as network or API problems.

Parameters

errorCode	Represents the specific type of error which has occurred
message	A human-readable message which can be shown to the end user
metadata	Any additional data which might be helpful to further work out the details of the error (see KNSCore::Entry::ErrorCode for the metadata details)

See also: KNSCore::Entry::ErrorCode

◆ signalMessage

void KNSCore::Transaction::signalMessage ( const QString & message )

signal

Provides the message to update our users about how the Transaction progressed.

◆ uninstall()

Transaction * Transaction::uninstall	(	EngineBase *	engine,
		const Entry &	entry )

static

Uninstalls the given entry from the engine.

It reverses the step done when @m install was called.

Returns: a Transaction object that we can use to track the progress to completion

Definition at line 386 of file transaction.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KNewStuff

KNSCore::Transaction

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ adopt()

◆ install()

◆ installLatest()

◆ installLinkId()

◆ isFinished()

◆ signalEntryEvent

◆ signalErrorCode

◆ signalMessage

◆ uninstall()