diff options
Diffstat (limited to 'src/dbus/server/pim/pim-manager-api.txt')
| -rw-r--r-- | src/dbus/server/pim/pim-manager-api.txt | 26 |
1 files changed, 22 insertions, 4 deletions
diff --git a/src/dbus/server/pim/pim-manager-api.txt b/src/dbus/server/pim/pim-manager-api.txt index 7b28643b..3283c7c4 100644 --- a/src/dbus/server/pim/pim-manager-api.txt +++ b/src/dbus/server/pim/pim-manager-api.txt @@ -238,13 +238,21 @@ Methods: part of the active address books, it will be removed automatically. - void SyncPeer(string uid) + dict SyncPeer(string uid) Retrieve contacts from the peer and ensure that the local cache is identical to the address book of the peer. The call - returns once the operation is complete. Only if there was no - error can the caller assume that the cache is up-to-date. - Otherwise it is in an undefined state. + returns once the operation is complete. + + Only if there was no error can the caller assume that the cache + is up-to-date. In this case, a string to variant dictionary + is returned which provided additional information about the sync. + The content of the dictionary is implementation dependent. + + If the call fails, no dictionary is returned and the local + cache may or may not be up-to-date. It may or may not have been + updated. The caller needs to check the local cache to find out + what it contains. void StopSync(string uid) @@ -307,6 +315,16 @@ Methods: Remove the contact and all of its associated data (like the photo, if the photo file is owned by the contact storage). +Signals: + + SyncProgress(string uid, string event, dict data) + + Provides information about a running sync for the peer with + the given "uid". The "event" string describes what happened + and the "data" dictionary provides further information about + it with a mapping from event specific string keys to variants + as value. + Service: org._01.pim.contacts Interface: org._01.pim.contacts.ViewControl |