summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMikel Astiz <mikel.astiz@bmw-carit.de>2012-06-04 11:37:45 +0200
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2012-06-04 14:11:00 +0300
commit193ea911dacd4ddfd1c545788705533363914441 (patch)
tree7c49a9aab17c878737c74b657375e9d4d191d727 /doc
parent1b3b94d00c8556a3e8caecd5c6e34053ee90e700 (diff)
downloadobexd-193ea911dacd4ddfd1c545788705533363914441.tar.gz
client-doc: ObjectPush sessions return transfers
Diffstat (limited to 'doc')
-rw-r--r--doc/client-api.txt34
1 files changed, 31 insertions, 3 deletions
diff --git a/doc/client-api.txt b/doc/client-api.txt
index 3b5444d..a57f6c2 100644
--- a/doc/client-api.txt
+++ b/doc/client-api.txt
@@ -63,21 +63,49 @@ Service org.openobex.client
Interface org.openobex.ObjectPush
Object path [variable prefix]/{session0,session1,...}
-Methods void SendFile(string sourcefile)
+Methods object, dict SendFile(string sourcefile)
Send one local file to the remote device.
- void PullBusinessCard(string targetfile)
+ The returned path represents the newly created transfer,
+ which should be used to find out if the content has been
+ successfully transferred or if the operation fails.
+
+ The properties of this transfer are also returned along
+ with the object path, to avoid a call to GetProperties.
+
+ object, dict PullBusinessCard(string targetfile)
Request the business card from a remote device and
store it in the local file.
- void ExchangeBusinessCards(string clientfile, string targetfile)
+ If an empty target file is given, a name will be
+ automatically calculated for the temporary file.
+
+ The returned path represents the newly created transfer,
+ which should be used to find out if the content has been
+ successfully transferred or if the operation fails.
+
+ The properties of this transfer are also returned along
+ with the object path, to avoid a call to GetProperties.
+
+ object, dict ExchangeBusinessCards(string clientfile,
+ string targetfile)
Push the client's business card to the remote device
and then retrieve the remote business card and store
it in a local file.
+ If an empty target file is given, a name will be
+ automatically calculated for the temporary file.
+
+ The returned path represents the newly created transfer,
+ which should be used to find out if the content has been
+ successfully transferred or if the operation fails.
+
+ The properties of this transfer are also returned along
+ with the object path, to avoid a call to GetProperties.
+
File Transfer hierarchy
=======================