Akonadi::ResourceBase
#include <resourcebase.h>
Signals | |
void | attributesSynchronized (qlonglong collectionId) |
void | collectionTreeSynchronized () |
void | nameChanged (const QString &name) |
void | retrieveNextItemSyncBatch (int remainingBatchSize) |
void | synchronized () |
Signals inherited from Akonadi::AgentBase | |
void | abortRequested () |
void | advancedStatus (const QVariantMap &status) |
void | agentNameChanged (const QString &name) |
void | configurationDialogAccepted () |
void | configurationDialogRejected () |
void | error (const QString &message) |
void | onlineChanged (bool online) |
void | percent (int progress) |
void | reloadConfiguration () |
void | status (int status, const QString &message=QString()) |
void | warning (const QString &message) |
Protected Types | |
enum | SchedulePriority { Prepend , AfterChangeReplay , Append } |
Protected Slots | |
virtual void | abortActivity () |
virtual QString | dumpResourceToString () const |
int | itemSyncBatchSize () const |
virtual void | retrieveCollectionAttributes (const Akonadi::Collection &collection) |
virtual void | retrieveCollections ()=0 |
virtual AKONADIAGENTBASE_DEPRECATED bool | retrieveItem (const Akonadi::Item &item, const QSet< QByteArray > &parts) |
virtual void | retrieveItems (const Akonadi::Collection &collection)=0 |
virtual bool | retrieveItems (const Akonadi::Item::List &items, const QSet< QByteArray > &parts) |
virtual void | retrieveRelations () |
virtual void | retrieveTags () |
void | setItemSyncBatchSize (int batchSize) |
void | setScheduleAttributeSyncBeforeItemSync (bool) |
Additional Inherited Members | |
Public Types inherited from Akonadi::AgentBase | |
enum | Status { Idle = 0 , Running , Broken , NotConfigured } |
Properties inherited from QObject | |
objectName | |
Public Slots inherited from Akonadi::AgentBase | |
virtual void | configure (WId windowId) |
Public Attributes inherited from QObject | |
typedef | QObjectList |
Detailed Description
The base class for all Akonadi resources.
This class should be used as a base class by all resource agents, because it encapsulates large parts of the protocol between resource agent, agent manager and the Akonadi storage.
It provides many convenience methods to make implementing a new Akonadi resource agent as simple as possible.
How to write a resource
The following provides an overview of what you need to do to implement your own Akonadi resource. In the following, the term 'backend' refers to the entity the resource connects with Akonadi, be it a single file or a remote server.
- Todo
- Complete this (online/offline state management)
Basic Resource Framework
The following is needed to create a new resource:
- A new class deriving from Akonadi::ResourceBase, implementing at least all pure-virtual methods, see below for further details.
- call init() in your main() function.
- a .desktop file similar to the following example [Desktop Entry]Type=AkonadiResourceHelper integration between Akonadi and Qt.T qobject_cast(QObject *object)
Handling PIM Items
To follow item changes in the backend, the following steps are necessary:
- Implement retrieveItems() to synchronize all items in the given collection. If the backend supports incremental retrieval, implementing support for that is recommended to improve performance.
- Convert the items provided by the backend to Akonadi items. This typically happens either in retrieveItems() if you retrieved the collection synchronously (not recommended for network backends) or in the result slot of the asynchronous retrieval job. Converting means to create Akonadi::Item objects for every retrieved item. It's very important that every object has its remote identifier set.
- Call itemsRetrieved() or itemsRetrievedIncremental() respectively with the item objects created above. The Akonadi storage will then be updated automatically. Note that it is usually not necessary to manipulate any item in the Akonadi storage manually.
To fetch item data on demand, the method retrieveItem() needs to be reimplemented. Fetch the requested data there and call itemRetrieved() with the result item.
To write local changes back to the backend, you need to re-implement the following three methods:
- itemAdded()
- itemChanged()
- itemRemoved()
Note that these three functions don't get the full payload of the items by default, you need to change the item fetch scope of the change recorder to fetch the full payload. This can be expensive with big payloads, though.
Once you have handled changes in itemAdded() and itemChanged(), call changeCommitted(). Once you have handled changes in itemRemoved(), call changeProcessed(); These methods are called whenever a local item related to this resource is added, modified or deleted. They are only called if the resource is online, otherwise all changes are recorded and replayed as soon the resource is online again.
Handling Collections
To follow collection changes in the backend, the following steps are necessary:
- Implement retrieveCollections() to retrieve collections from the backend. If the backend supports incremental collections updates, implementing support for that is recommended to improve performance.
- Convert the collections of the backend to Akonadi collections. This typically happens either in retrieveCollections() if you retrieved the collection synchronously (not recommended for network backends) or in the result slot of the asynchronous retrieval job. Converting means to create Akonadi::Collection objects for every retrieved collection. It's very important that every object has its remote identifier and its parent remote identifier set.
- Call collectionsRetrieved() or collectionsRetrievedIncremental() respectively with the collection objects created above. The Akonadi storage will then be updated automatically. Note that it is usually not necessary to manipulate any collection in the Akonadi storage manually.
To write local collection changes back to the backend, you need to re-implement the following three methods:
- collectionAdded()
- collectionChanged()
collectionRemoved() Once you have handled changes in collectionAdded() and collectionChanged(), call changeCommitted(). Once you have handled changes in collectionRemoved(), call changeProcessed(); These methods are called whenever a local collection related to this resource is added, modified or deleted. They are only called if the resource is online, otherwise all changes are recorded and replayed as soon the resource is online again.
- Todo
- Convenience base class for collection-less resources
Definition at line 134 of file resourcebase.h.
Member Enumeration Documentation
◆ SchedulePriority
|
protected |
Describes the scheduling priority of a task that has been queued for execution.
- See also
- scheduleCustomTask
- Since
- 4.4
Definition at line 758 of file resourcebase.h.
Constructor & Destructor Documentation
◆ ResourceBase()
Creates a base resource.
- Parameters
-
id The instance id of the resource.
Definition at line 446 of file resourcebase.cpp.
◆ ~ResourceBase()
|
overrideprotecteddefault |
Destroys the base resource.
Member Function Documentation
◆ abortActivity
|
protectedvirtualslot |
Abort any activity in progress in the backend.
By default this method does nothing.
- Since
- 4.6
Definition at line 1479 of file resourcebase.cpp.
◆ attributesSynchronized
Emitted when a collection attributes synchronization has been completed.
- Parameters
-
collectionId The identifier of the collection whose attributes got synchronized.
- Since
- 4.6
◆ cancelTask() [1/2]
|
protected |
Stops the execution of the current task and continues with the next one.
Definition at line 1178 of file resourcebase.cpp.
◆ cancelTask() [2/2]
Stops the execution of the current task and continues with the next one.
Additionally an error message is emitted.
- Parameters
-
error additional error message to be emitted
Definition at line 1215 of file resourcebase.cpp.
◆ changeCommitted() [1/3]
|
protected |
Call whenever you have successfully handled or ignored a collection change notification.
This will update the remote identifier of collection
if necessary, as well as any other collection attributes. This implicitly calls changeProcessed().
- Parameters
-
collection The collection which changes have been handled.
Definition at line 690 of file resourcebase.cpp.
◆ changeCommitted() [2/3]
Resets the dirty flag of the given item and updates the remote id.
Call whenever you have successfully written changes back to the server. This implicitly calls changeProcessed().
- Parameters
-
item The changed item.
Definition at line 670 of file resourcebase.cpp.
◆ changeCommitted() [3/3]
Resets the dirty flag of the given tag and updates the remote id.
Call whenever you have successfully written changes back to the server. This implicitly calls changeProcessed().
- Parameters
-
tag Changed tag.
- Since
- 4.13
Definition at line 719 of file resourcebase.cpp.
◆ changesCommitted()
|
protected |
Resets the dirty flag of all given items and updates remote ids.
Call whenever you have successfully written changes back to the server. This implicitly calls changeProcessed().
- Parameters
-
items Changed items
- Since
- 4.11
Definition at line 675 of file resourcebase.cpp.
◆ clearCache()
|
protected |
Call this method to remove all items and collections of the resource from the server cache.
The method should not be used anymore
- See also
- invalidateCache()
- Since
- 4.3
Definition at line 1124 of file resourcebase.cpp.
◆ collectionAttributesRetrieved()
|
protected |
Call this method from retrieveCollectionAttributes() once the result is available.
- Parameters
-
collection The collection whose attributes got retrieved.
- Since
- 4.6
Definition at line 600 of file resourcebase.cpp.
◆ collectionsRetrievalDone()
|
protected |
Call this method to indicate you finished synchronizing the collection tree.
This is not needed if you use the built in syncing without collection streaming and call collectionsRetrieved() or collectionRetrievedIncremental() instead. If collection streaming is enabled, call this method once all collections have been delivered using collectionsRetrieved() or collectionsRetrievedIncremental().
Definition at line 797 of file resourcebase.cpp.
◆ collectionsRetrieved()
|
protected |
Call this to supply the full folder tree retrieved from the remote server.
- Parameters
-
collections A list of collections.
Definition at line 747 of file resourcebase.cpp.
◆ collectionsRetrievedIncremental()
|
protected |
Call this to supply incrementally retrieved collections from the remote server.
- Parameters
-
changedCollections Collections that have been added or changed. removedCollections Collections that have been deleted.
- See also
- collectionsRetrieved()
Definition at line 764 of file resourcebase.cpp.
◆ collectionTreeSynchronized
|
signal |
Emitted when a collection tree synchronization has been completed.
- Since
- 4.8
◆ currentCollection()
|
protected |
Returns the collection that is currently synchronized.
- Note
- Calling this method is only allowed during a collection synchronization task, that is directly or indirectly from retrieveItems().
Definition at line 1136 of file resourcebase.cpp.
◆ currentItem()
|
protected |
Returns the item that is currently retrieved.
- Note
- Calling this method is only allowed during fetching a single item, that is directly or indirectly from retrieveItem().
Definition at line 1145 of file resourcebase.cpp.
◆ currentItems()
|
protected |
Returns the items that are currently retrieved.
- Note
- Calling this method is only allowed during item fetch, that is directly or indirectly from retrieveItems(Akonadi::Item::List,QSet<QByteArray>)
Definition at line 1154 of file resourcebase.cpp.
◆ deferTask()
|
protected |
Suspends the execution of the current task and tries again to execute it.
This can be used to delay the task processing until the resource has reached a safe state, e.g. login to a server succeeded.
- Note
- This does not change the order of tasks so if there is no task with higher priority e.g. a custom task added with Prepend the deferred task will be processed again.
- Since
- 4.3
Definition at line 1222 of file resourcebase.cpp.
◆ doSetOnline()
|
overrideprotectedvirtual |
Inherited from AgentBase.
When going offline, the scheduler aborts the current task, so you should do the same in your resource, if the task implementation is asynchronous.
Reimplemented from Akonadi::AgentBase.
Definition at line 1232 of file resourcebase.cpp.
◆ dumpMemoryInfo()
|
protected |
Dumps memory usage information to stdout.
For now it outputs the result of glibc's mallinfo(). This is useful to check if your memory problems are due to poor management by glibc. Look for a high value on fsmblks when interpreting results. man mallinfo for more details.
- Since
- 4.11
Definition at line 1513 of file resourcebase.cpp.
◆ dumpMemoryInfoToString()
|
protected |
Returns a string with memory usage information.
- See also
- dumpMemoryInfo()
- Since
- 4.11
Definition at line 1519 of file resourcebase.cpp.
◆ dumpNotificationListToString()
|
protected |
Dump the contents of the current ChangeReplay.
- Since
- 4.8.1
Definition at line 1501 of file resourcebase.cpp.
◆ dumpResourceToString
◆ dumpSchedulerToString()
|
protected |
◆ init()
|
inlinestatic |
Use this method in the main function of your resource application to initialize your resource subclass.
This method also takes care of creating a KApplication object and parsing command line arguments.
- Note
- In case the given class is also derived from AgentBase::Observer it gets registered as its own observer (see AgentBase::Observer), e.g.
resourceInstance->registerObserver( resourceInstance );
- Parameters
-
argc number of arguments argv string arguments
Definition at line 167 of file resourcebase.h.
◆ invalidateCache()
|
protected |
Call this method to invalidate all cached content in collection
.
The method should be used when the backend indicated that the cached content is no longer valid.
- Parameters
-
collection parent of the content to be invalidated in cache
- Since
- 4.8
Definition at line 1130 of file resourcebase.cpp.
◆ itemRetrieved()
Call this method from retrieveItem() once the result is available.
- Parameters
-
item The retrieved item.
Definition at line 567 of file resourcebase.cpp.
◆ itemsRetrievalDone()
|
protected |
Call this method to indicate you finished synchronizing the current collection.
This is not needed if you use the built in syncing without item streaming and call itemsRetrieved() or itemsRetrievedIncremental() instead. If item streaming is enabled, call this method once all items have been delivered using itemsRetrieved() or itemsRetrievedIncremental().
- See also
- retrieveItems()
Definition at line 1109 of file resourcebase.cpp.
◆ itemsRetrieved()
|
protected |
Call this method to supply the full collection listing from the remote server.
Items not present in the list will be dropped from the Akonadi database.
If the remote server supports incremental listing, it's strongly recommended to use itemsRetrievedIncremental() instead.
- Parameters
-
items A list of items.
- See also
- itemsRetrievedIncremental().
Definition at line 1325 of file resourcebase.cpp.
◆ itemsRetrievedIncremental()
|
protected |
Call this method to supply incrementally retrieved items from the remote server.
- Parameters
-
changedItems Items changed in the backend. removedItems Items removed from the backend.
Definition at line 1352 of file resourcebase.cpp.
◆ itemSyncBatchSize
|
protectedslot |
Returns the batch size used during the item sync.
This can be used to throttle the item delivery.
- See also
- retrieveNextItemSyncBatch(int), retrieveItems(Akonadi::Collection)
- Since
- 4.14
Definition at line 945 of file resourcebase.cpp.
◆ name()
QString ResourceBase::name | ( | ) | const |
Returns the name of the resource.
Definition at line 509 of file resourcebase.cpp.
◆ nameChanged
This signal is emitted whenever the name of the resource has changed.
- Parameters
-
name The new name of the resource.
◆ relationsRetrieved()
|
protected |
Definition at line 1556 of file resourcebase.cpp.
◆ retrieveCollectionAttributes
|
protectedvirtualslot |
Retrieve the attributes of a single collection from the backend.
The collection to retrieve attributes for is provided as collection
. Add the attributes parts and call collectionAttributesRetrieved() when done.
- Parameters
-
collection The collection whose attributes should be retrieved.
- See also
- collectionAttributesRetrieved()
- Since
- 4.6
Definition at line 1428 of file resourcebase.cpp.
◆ retrieveCollections
Retrieve the collection tree from the remote server and supply it via collectionsRetrieved() or collectionsRetrievedIncremental().
◆ retrieveItem
|
protectedvirtualslot |
Retrieve a single item from the backend.
The item to retrieve is provided as item
. Add the requested payload parts and call itemRetrieved() when done.
- Parameters
-
item The empty item whose payload should be retrieved. Use this object when delivering the result instead of creating a new item to ensure conflict detection will work. parts The item parts that should be retrieved.
- Returns
- false if there is an immediate error when retrieving the item.
- See also
- itemRetrieved()
Definition at line 1445 of file resourcebase.cpp.
◆ retrieveItems [1/2]
|
protectedpure virtualslot |
Retrieve all (new/changed) items in collection collection
.
It is recommended to use incremental retrieval if the backend supports that and provide the result by calling itemsRetrievedIncremental(). If incremental retrieval is not possible, provide the full listing by calling itemsRetrieved( const Item::List& ). In any case, ensure that all items have a correctly set remote identifier to allow synchronizing with items already existing locally. In case you don't want to use the built-in item syncing code, store the retrieved items manually and call itemsRetrieved() once you are done.
- Parameters
-
collection The collection whose items to retrieve.
- See also
- itemsRetrieved( const Item::List& ), itemsRetrievedIncremental(), itemsRetrieved(), currentCollection(), batchSize()
◆ retrieveItems [2/2]
|
protectedvirtualslot |
Retrieve given items
from the backend.
Add the requested payload parts and call itemsRetrieved() when done. It is guaranteed that all items
in the list belong to the same Collection.
If the items are retrieved synchronously in this method, in case of an error emit error(const QString &) and return false
, which will cancel the current task. If the items are retrieved asynchronously, in case of an non-immediate error you need to call cancelTask() or cancelTask(const QString&) in the respective handler methods explicitly.
- Parameters
-
items The items whose payload should be retrieved. Use those objects when delivering the result instead of creating new items to ensure conflict detection will work. parts The item parts that should be retrieved.
- Returns
- false if there is an immediate error when retrieving the items.
- See also
- itemsRetrieved()
- Since
- 5.4
- Todo
- : Make this method pure virtual once retrieveItem() is gone
Definition at line 1463 of file resourcebase.cpp.
◆ retrieveNextItemSyncBatch
|
signal |
Emitted when the item synchronization processed the current batch and is ready for a new one.
Use this to throttle the delivery to not overload Akonadi.
Throttling can be used during item retrieval (retrieveItems(Akonadi::Collection)) in streaming mode. To throttle only deliver itemSyncBatchSize() items, and wait for this signal, then again deliver
- Parameters
-
remainingBatchSize items.
By always only providing the number of items required to process the batch, the items don't pile up in memory and items are only provided as fast as Akonadi can process them.
- See also
- batchSize()
- Since
- 4.14
◆ retrieveRelations
|
protectedvirtualslot |
Retrieve all relations from the backend.
- See also
- relationsRetrieved()
Definition at line 1439 of file resourcebase.cpp.
◆ retrieveTags
|
protectedvirtualslot |
Retrieve all tags from the backend.
- See also
- tagsRetrieved()
Definition at line 1433 of file resourcebase.cpp.
◆ scheduleCustomTask()
|
protected |
Schedules a custom task in the internal scheduler.
It will be queued with all other tasks such as change replays and retrieval requests and eventually executed by calling the specified method. With the priority parameter the time of execution of the Task can be influenced.
- See also
- SchedulePriority
- Parameters
-
receiver The object the slot should be called on. method The name of the method (and only the name, not signature, not SLOT(...) macro), that should be called to execute this task. The method has to be a slot and take a QVariant as argument. argument A QVariant argument passed to the method specified above. Use this to pass task parameters. priority Priority of the task. Use this to influence the position in the execution queue.
- Since
- 4.4
Definition at line 1416 of file resourcebase.cpp.
◆ setAutomaticProgressReporting()
void ResourceBase::setAutomaticProgressReporting | ( | bool | enabled | ) |
Enable or disable automatic progress reporting.
By default, it is enabled. When enabled, the resource will automatically emit the signals percent() and status() while syncing items or collections.
The automatic progress reporting is done on a per item / per collection basis, so if a finer granularity is desired, automatic reporting should be disabled and the subclass should emit the percent() and status() signals itself.
- Parameters
-
enabled Whether or not automatic emission of the signals is enabled.
- Since
- 4.7
Definition at line 1495 of file resourcebase.cpp.
◆ setCollectionStreamingEnabled()
|
protected |
Enable collection streaming, that is collections don't have to be delivered at once as result of a retrieveCollections() call but can be delivered by multiple calls to collectionsRetrieved() or collectionsRetrievedIncremental().
When all collections have been retrieved, call collectionsRetrievalDone().
- Parameters
-
enable true
if collection streaming should be enabled,false
by default
Definition at line 781 of file resourcebase.cpp.
◆ setDisableAutomaticItemDeliveryDone()
|
protected |
Disables the automatic completion of the item sync, based on the number of delivered items.
This ensures that the item sync only finishes once itemsRetrieved() is called, while still making it possible to use the automatic progress reporting based on setTotalItems().
- Note
- This needs to be called once, before the item sync is started.
- See also
- setTotalItems(int)
- Since
- 4.14
Definition at line 1307 of file resourcebase.cpp.
◆ setHierarchicalRemoteIdentifiersEnabled()
|
protected |
Indicate the use of hierarchical remote identifiers.
This means that it is possible to have two different items with the same remoteId in different Collections.
This should be called in the resource constructor as needed.
- Parameters
-
enable whether to enable use of hierarchical remote identifiers
- Since
- 4.4
Definition at line 1410 of file resourcebase.cpp.
◆ setItemMergingMode()
|
protected |
Set merge mode for item sync'ing.
Default merge mode is RIDMerge.
- Note
- This method must be called before first call to itemRetrieved(), itemsRetrieved() or itemsRetrievedIncremental().
- Parameters
-
mode Item merging mode (see ItemCreateJob for details on item merging)
- See also
- Akonadi::ItemSync::MergeMode
- Since
- 4.14.11
Definition at line 1489 of file resourcebase.cpp.
◆ setItemStreamingEnabled()
|
protected |
Enable item streaming, which is disabled by default.
Item streaming means that the resource can call setTotalItems(), and then itemsRetrieved() or itemsRetrievedIncremental() multiple times, in chunks. When all is done, the resource should call itemsRetrievalDone().
- Parameters
-
enable true
if items are delivered in chunks rather in one big block.
- See also
- setTotalItems(int)
Definition at line 1316 of file resourcebase.cpp.
◆ setItemSyncBatchSize
|
protectedslot |
Set the batch size used during the item sync.
The default is 10.
- See also
- retrieveNextItemSyncBatch(int)
- Since
- 4.14
Definition at line 951 of file resourcebase.cpp.
◆ setItemTransactionMode()
|
protected |
Set transaction mode for item sync'ing.
- Parameters
-
mode item transaction mode
- Since
- 4.6
Definition at line 1483 of file resourcebase.cpp.
◆ setKeepLocalCollectionChanges()
|
protected |
Allows to keep locally changed collection parts during the collection sync.
This is useful for resources to be able to provide default values during the collection sync, while preserving eventual more up-to date values.
Valid values are attribute types and "CONTENTMIMETYPE" for the collections content mimetypes.
By default this is enabled for the EntityDisplayAttribute.
- Parameters
-
parts A set parts for which local changes should be preserved.
- Since
- 4.14
Definition at line 813 of file resourcebase.cpp.
◆ setName()
This method is used to set the name of the resource.
Definition at line 504 of file resourcebase.cpp.
◆ setScheduleAttributeSyncBeforeItemSync
|
protectedslot |
Set to true to schedule an attribute sync before every item sync.
The default is false.
- Since
- 4.15
Definition at line 957 of file resourcebase.cpp.
◆ setTotalItems()
|
protected |
Call this method when you want to use the itemsRetrieved() method in streaming mode and indicate the amount of items that will arrive that way.
- Warning
- By default this will end the item sync automatically once sufficient items were delivered. To disable this and only make use of the progress reporting, use setDisableAutomaticItemDeliveryDone()
- Note
- The recommended way is therefore: setItemStreamingEnabled(true);setTotalItems(X); // X = sum of all items in all batcheswhile (...) {// or itemsRetrieved(...);}void setDisableAutomaticItemDeliveryDone(bool disable)Disables the automatic completion of the item sync, based on the number of delivered items.Definition resourcebase.cpp:1307void itemsRetrievalDone()Call this method to indicate you finished synchronizing the current collection.Definition resourcebase.cpp:1109void setTotalItems(int amount)Call this method when you want to use the itemsRetrieved() method in streaming mode and indicate the ...Definition resourcebase.cpp:1297void setItemStreamingEnabled(bool enable)Enable item streaming, which is disabled by default.Definition resourcebase.cpp:1316void itemsRetrievedIncremental(const Item::List &changedItems, const Item::List &removedItems)Call this method to supply incrementally retrieved items from the remote server.Definition resourcebase.cpp:1352
- Parameters
-
amount number of items that will arrive in streaming mode
Definition at line 1297 of file resourcebase.cpp.
◆ synchronize()
|
protected |
This method is called whenever the resource should start synchronize all data.
Definition at line 499 of file resourcebase.cpp.
◆ synchronizeCollection() [1/2]
|
protected |
This method is called whenever the collection with the given id
shall be synchronized.
Definition at line 1237 of file resourcebase.cpp.
◆ synchronizeCollection() [2/2]
|
protected |
This method is called whenever the collection with the given id
shall be synchronized.
- Parameters
-
recursive if true, a recursive synchronization is done
Definition at line 1242 of file resourcebase.cpp.
◆ synchronizeCollectionAttributes() [1/2]
|
protected |
Synchronizes the collection attributes.
- Parameters
-
col The id of the collection to synchronize
- Since
- 4.15
Definition at line 1270 of file resourcebase.cpp.
◆ synchronizeCollectionAttributes() [2/2]
|
protected |
This method is called whenever the collection with the given id
shall have its attributes synchronized.
- Parameters
-
id The id of the collection to synchronize
- Since
- 4.6
Definition at line 1276 of file resourcebase.cpp.
◆ synchronizeCollectionTree()
|
protected |
Refetches the Collections.
Definition at line 1163 of file resourcebase.cpp.
◆ synchronized
|
signal |
Emitted when a full synchronization has been completed.
◆ synchronizeRelations()
|
protected |
Refetches Relations.
Definition at line 1173 of file resourcebase.cpp.
◆ synchronizeTags()
|
protected |
Refetches Tags.
Definition at line 1168 of file resourcebase.cpp.
◆ tagsRetrieved()
|
protected |
Definition at line 1525 of file resourcebase.cpp.
◆ taskDone()
|
protected |
Indicate that the current task is finished.
Use this method from the slot called via scheduleCustomTaks(). As with all the other callbacks, make sure to either call taskDone() or cancelTask()/deferTask() on all exit paths, otherwise the resource will hang.
- Since
- 4.4
Definition at line 1422 of file resourcebase.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 3 2024 11:44:22 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.