KNSCore::Transaction Class
class KNSCore::TransactionKNewStuff Transaction. More...
| Header: | #include <Transaction> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS NewStuff)target_link_libraries(mytarget PRIVATE KF6::NewStuff) |
| Since: | 6.0 |
| Inherits: | QObject |
Public Functions
| bool | isFinished() const |
Signals
| 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) |
Static Public Members
| KNSCore::Transaction * | adopt(KNSCore::EngineBase *engine, const KNSCore::Entry &entry) |
(since 6.9) KNSCore::Transaction * | installLatest(KNSCore::EngineBase *engine, const KNSCore::Entry &entry) |
(since 6.9) KNSCore::Transaction * | installLinkId(KNSCore::EngineBase *engine, const KNSCore::Entry &entry, quint8 linkId) |
| KNSCore::Transaction * | uninstall(KNSCore::EngineBase *engine, const KNSCore::Entry &entry) |
Detailed Description
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 finished signal.
The Transaction will delete itself once it has finished.
Member Function Documentation
[static] KNSCore::Transaction *Transaction::adopt(KNSCore::EngineBase *engine, const KNSCore::Entry &entry)
Adopt the entry from engine using the adoption command.
For more information, see the documentation about AdoptionCommand from the knsrc file.
[static, since 6.9] KNSCore::Transaction *Transaction::installLatest(KNSCore::EngineBase *engine, const KNSCore::Entry &entry)
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
This function was introduced in 6.9.
[static, since 6.9] KNSCore::Transaction *Transaction::installLinkId(KNSCore::EngineBase *engine, const KNSCore::Entry &entry, quint8 linkId)
Performs an install on the given entry from the engine.
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
This function was introduced in 6.9.
bool Transaction::isFinished() const
Returns true as soon as the Transaction is completed as it gets ready to clean itself up
[signal] void Transaction::signalEntryEvent(const KNSCore::Entry &entry, KNSCore::Entry::EntryEvent event)
Informs about how the entry has changed
event nature of the change
[signal] void Transaction::signalErrorCode(KNSCore::ErrorCode::ErrorCode errorCode, const QString &message, const QVariant &metadata)
Fires in the case of any critical or serious errors, such as network or API problems.
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::ErrorCode.
[signal] void Transaction::signalMessage(const QString &message)
Provides the message to update our users about how the Transaction progressed
[static] KNSCore::Transaction *Transaction::uninstall(KNSCore::EngineBase *engine, const KNSCore::Entry &entry)
Uninstalls the given entry from the engine.
It reverses the step done when install() was called. Returns a Transaction object that we can use to track the progress to completion