akonadi
#include <itemsync.h>

Public Types | |
enum | TransactionMode { SingleTransaction, MultipleTransactions, NoTransaction } |
Public Member Functions | |
ItemSync (const Collection &collection, QObject *parent=0) | |
~ItemSync () | |
void | deliveryDone () |
ItemFetchScope & | fetchScope () |
void | rollback () |
void | setFetchScope (ItemFetchScope &fetchScope) |
void | setFullSyncItems (const Item::List &items) |
void | setIncrementalSyncItems (const Item::List &changedItems, const Item::List &removedItems) |
void | setStreamingEnabled (bool enable) |
void | setTotalItems (int amount) |
void | setTransactionMode (TransactionMode mode) |
Protected Member Functions | |
void | doStart () |
void | slotResult (KJob *job) |
virtual bool | updateItem (const Item &storedItem, Item &newItem) |
Detailed Description
Syncs between items known to a client (usually a resource) and the Akonadi storage.
Remote Id must only be set by the resource storing the item, other clients should leave it empty, since the resource responsible for the target collection will be notified about the addition and then create a suitable remote Id.
There are two different forms of ItemSync usage:
- Full-Sync: meaning the client provides all valid items, i.e. any item not part of the list but currently stored in Akonadi will be removed
- Incremental-Sync: meaning the client provides two lists, one for items which are new or modified and one for items which should be removed. Any item not part of either list but currently stored in Akonadi will not be changed.
- Note:
- This is provided for convenience to implement "save all" like behavior, however it is strongly recommended to use single item jobs whenever possible, e.g. ItemCreateJob, ItemModifyJob and ItemDeleteJob
Member Enumeration Documentation
enum Akonadi::ItemSync::TransactionMode |
Transaction mode used by ItemSync.
- Since:
- 4.6
- Enumerator:
Definition at line 158 of file itemsync.h.
Constructor & Destructor Documentation
Akonadi::ItemSync::ItemSync | ( | const Collection & | collection, |
QObject * | parent = 0 |
||
) | [explicit] |
Creates a new item synchronizer.
- Parameters:
-
collection The collection we are syncing. parent The parent object.
Akonadi::ItemSync::~ItemSync | ( | ) |
Destroys the item synchronizer.
Member Function Documentation
void Akonadi::ItemSync::deliveryDone | ( | ) |
Notify ItemSync that all remote items have been delivered.
Only call this in streaming mode.
void Akonadi::ItemSync::doStart | ( | ) | [protected, virtual] |
This method must be reimplemented in the concrete jobs.
It will be called after the job has been started and a connection to the Akonadi backend has been established.
Implements Akonadi::Job.
ItemFetchScope& Akonadi::ItemSync::fetchScope | ( | ) |
Returns the item fetch scope.
Since this returns a reference it can be used to conveniently modify the current scope in-place, i.e. by calling a method on the returned reference without storing it in a local variable. See the ItemFetchScope documentation for an example.
- Returns:
- a reference to the current item fetch scope
- See also:
- setFetchScope() for replacing the current item fetch scope
void Akonadi::ItemSync::rollback | ( | ) |
Aborts the sync process and rolls back all not yet committed transactions.
Use this if an external error occurred during the sync process (such as the user canceling it).
- Since:
- 4.5
void Akonadi::ItemSync::setFetchScope | ( | ItemFetchScope & | fetchScope | ) |
Sets the item fetch scope.
The ItemFetchScope controls how much of an item's data is fetched from the server, e.g. whether to fetch the full item payload or only meta data.
- Parameters:
-
fetchScope The new scope for item fetch operations.
- See also:
- fetchScope()
void Akonadi::ItemSync::setFullSyncItems | ( | const Item::List & | items | ) |
Sets the full item list for the collection.
Usually the result of a full item listing.
- Warning:
- If the client using this is a resource, all items must have a valid remote identifier.
- Parameters:
-
items A list of items.
void Akonadi::ItemSync::setIncrementalSyncItems | ( | const Item::List & | changedItems, |
const Item::List & | removedItems | ||
) |
Sets the item lists for incrementally syncing the collection.
Usually the result of an incremental remote item listing.
- Warning:
- If the client using this is a resource, all items must have a valid remote identifier.
- Parameters:
-
changedItems A list of items added or changed by the client. removedItems A list of items deleted by the client.
void Akonadi::ItemSync::setStreamingEnabled | ( | bool | enable | ) |
Enable item streaming.
Item streaming means that the items delivered by setXItems() calls are delivered in chunks and you manually indicate when all items have been delivered by calling deliveryDone().
- Parameters:
-
enable true
to enable item streaming
void Akonadi::ItemSync::setTotalItems | ( | int | amount | ) |
Set the amount of items which you are going to return in total by using the setFullSyncItems() method.
- Parameters:
-
amount The amount of items in total.
void Akonadi::ItemSync::setTransactionMode | ( | TransactionMode | mode | ) |
Set the transaction mode to use for this sync.
- Note:
- You must call this method before starting the sync, changes afterwards lead to undefined results.
- Since:
- 4.6
virtual bool Akonadi::ItemSync::updateItem | ( | const Item & | storedItem, |
Item & | newItem | ||
) | [protected, virtual] |
Reimplement this method to customize the synchronization algorithm.
You can update the newItem
according to the storedItem
before it gets committed.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Thu Aug 2 2012 15:25:22 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.