Akonadi::TodoPurger Class
Class to delete completed to-dos. More...
| Header: | #include <todopurger.h> |
| CMake: | find_package(KPim6AkonadiCalendar REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::AkonadiCalendar) |
| Inherits: | QObject |
Public Functions
| TodoPurger(QObject *parent = nullptr) | |
| QString & | lastError() const |
| void | purgeCompletedTodos() |
| void | setCalendar(const CalendarBase::Ptr &calendar) |
| void | setIncidenceChager(Akonadi::IncidenceChanger *changer) |
Signals
| void | todosPurged(bool success, int numDeleted, int numIgnored) |
Detailed Description
Author: Sérgio Martins <iamsergio@gmail.com>
Member Function Documentation
[explicit] TodoPurger::TodoPurger(QObject *parent = nullptr)
Creates a new TodoPurger instance.
QString &TodoPurger::lastError() const
Use this after receiving the an unsuccessful todosPurged() signal to get a i18n error message.
void TodoPurger::purgeCompletedTodos()
Deletes completed to-dos. A to-do with incomplete children won't be deleted.
See also purgeCompletedTodos().
void TodoPurger::setCalendar(const CalendarBase::Ptr &calendar)
Sets the calendar to be used for retrieving the to-do hierarchy. If you don't call this method, an internal FetchJobCalendar will be created. Use this if you want to reuse an existing calendar, for performance reasons for example.
void TodoPurger::setIncidenceChager(Akonadi::IncidenceChanger *changer)
Sets an IncidenceChanger. If you don't call this method, an internal IncidenceChanger will be created. Use this if you want more control over the deletion operations, like iTip management, ACL, undo/redo support.
[signal] void TodoPurger::todosPurged(bool success, int numDeleted, int numIgnored)
Emitted when purging completed to-dos finished. success True if the operation could be completed.
numDeleted Number of to-dos that were deleted. numIgnored Number of completed to-dos that weren't deleted because they are read-only or have incomplete or read-only children.
See also lastError().