Skip to content

Commit

Permalink
doc/obex-api: Update documentation
Browse files Browse the repository at this point in the history
This adds Suspend and Resume methods and 'suspended' value as status in
the Transfer interface documentation.
  • Loading branch information
Vudentz committed Feb 20, 2014
1 parent 8a0fb5f commit da0a820
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions doc/obex-api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down

0 comments on commit da0a820

Please sign in to comment.