diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2012-12-10 23:03:24 +0100 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2012-12-10 23:03:24 +0100 |
| commit | 535f90da9b207e6dc90e19b275050199c0b8c6da (patch) | |
| tree | f6e65f5ab91e4532834eb558c0982f9ba10800b9 /doc/obex-agent-api.txt | |
| parent | f37facb3bd7c53d3b7629cb53b22a05a952bfa27 (diff) | |
| download | bluez-535f90da9b207e6dc90e19b275050199c0b8c6da.tar.gz | |
doc: Add API documentation from obexd repository
Diffstat (limited to 'doc/obex-agent-api.txt')
| -rw-r--r-- | doc/obex-agent-api.txt | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/obex-agent-api.txt b/doc/obex-agent-api.txt new file mode 100644 index 000000000..20181a60d --- /dev/null +++ b/doc/obex-agent-api.txt @@ -0,0 +1,31 @@ +obexd Agent API description +********************************** + +Copyright (C) 2007-2010 Nokia Corporation +Copyright (C) 2007-2010 Marcel Holtmann <marcel@holtmann.org> + + +Agent hierarchy +=============== + +Service unique name +Interface org.bluez.obex.Agent +Object path freely definable + +Methods + string Authorize(object transfer, string bt_address, string name, + string type, int32 length, int32 time) + + This method gets called when the service daemon + needs to accept/reject a Bluetooth object push request. + Returns the full path (including the filename) where + the object shall be stored. + + Possible errors: org.bluez.obex.Error.Rejected + org.bluez.obex.Error.Canceled + + void Cancel() + + This method gets called to indicate that the agent + request failed before a reply was returned. It cancels + the previous request. |