From da0a820a64f3611eba1d9a41100d1005ed973aae Mon Sep 17 00:00:00 2001 From: Luiz Augusto von Dentz Date: Mon, 10 Feb 2014 12:45:29 +0200 Subject: [PATCH] doc/obex-api: Update documentation This adds Suspend and Resume methods and 'suspended' value as status in the Transfer interface documentation. --- doc/obex-api.txt | 26 ++++++++++++++++++++++++-- 1 file 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] -- 2.47.3