maryjane/syncevolution
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

PIM Manager: document D-Bus errors

Browse source 
org._01.pim.contacts.Manager.Aborted may be useful if the caller of
SyncPeer() wants to distinguish between sync failures (BadStatus) and
intentionally aborted syncs.
This commit is contained in:
Patrick Ohly 2012-09-20 14:01:12 +02:00
parent d1d9ec2406
commit 8084191132
1 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/dbus/server/pim/pim-manager-api.txt
View file

@ -153,14 +153,24 @@ Error handling
D-Bus error messages are not localized. They are meant for debugging,
not for displaying to the user. In cases where the caller may be able
to do something about an error, specific error codes could be defined
and returned as part of the API. However, typically errors are generic
and the caller simply has to assume that the PIM storage is currently
unusable.
to do something about an error, specific error codes are defined as
part of the API. However, typically errors are generic and the caller
simply has to assume that the PIM storage is currently unusable.
Unless noted otherwise, calls return when the requested operation is
complete.
The following errors are defined. In addition to the D-Bus name of the
error they provide a textual error description.
org._01.pim.contacts.Manager.Aborted
Some operation was intentionally aborted instead of letting it
complete. Typically not an error.
org._01.pim.contacts.Manager.BadStatus
A generic error report. The error description is a string
which gives further information for debugging.
API
===