diff options
| author | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2014-02-10 12:45:29 +0200 |
|---|---|---|
| committer | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2014-02-20 13:57:55 +0200 |
| commit | da0a820a64f3611eba1d9a41100d1005ed973aae (patch) | |
| tree | 3b6150ef0eafab5a82a0a16418f3f82b5065a5f1 /doc/obex-api.txt | |
| parent | 8a0fb5f5258ffd9a3e92cc6d4685c413817cdf3d (diff) | |
| download | bluez-da0a820a64f3611eba1d9a41100d1005ed973aae.tar.gz | |
doc/obex-api: Update documentation
This adds Suspend and Resume methods and 'suspended' value as status in
the Transfer interface documentation.
Diffstat (limited to 'doc/obex-api.txt')
| -rw-r--r-- | doc/obex-api.txt | 26 |
1 files changed, 24 insertions, 2 deletions
diff --git a/doc/obex-api.txt b/doc/obex-api.txt index 1f22fea8e..9542a302d 100644 --- a/doc/obex-api.txt +++ b/doc/obex-api.txt @@ -90,12 +90,34 @@ Methods void Cancel() org.bluez.obex.Error.InProgress org.bluez.obex.Error.Failed + void Suspend() + + Suspend transference. + + Possible errors: org.bluez.obex.Error.NotAuthorized + org.bluez.obex.Error.NotInProgress + + Note that it is not possible to suspend transfers + which are queued which is why NotInProgress is listed + as possible error. + + void Resume() + + Resume transference. + + Possible errors: org.bluez.obex.Error.NotAuthorized + org.bluez.obex.Error.NotInProgress + + Note that it is not possible to resume transfers + which are queued which is why NotInProgress is listed + as possible error. + Properties string Status [readonly] Inform the current status of the transfer. - Possible values: "queued", "active", "complete" or - "error" + Possible values: "queued", "active", "suspended", + "complete" or "error" object Session [readonly] |