diff options
| author | Mikel Astiz <mikel.astiz@bmw-carit.de> | 2012-06-04 11:37:49 +0200 |
|---|---|---|
| committer | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2012-06-04 14:11:01 +0300 |
| commit | e73d0898446aceabf5c0737c9e5d5ebd2e5932e9 (patch) | |
| tree | 315a09645a40635b609ec85b5f0576cf19a00201 | |
| parent | 9952ca8cbe7369abd31d68cc1ec286ea7f4e4951 (diff) | |
| download | obexd-e73d0898446aceabf5c0737c9e5d5ebd2e5932e9.tar.gz | |
client-doc: FileTransfer sessions return transfers
| -rw-r--r-- | doc/client-api.txt | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/doc/client-api.txt b/doc/client-api.txt index a57f6c2..2c7c03c 100644 --- a/doc/client-api.txt +++ b/doc/client-api.txt @@ -138,21 +138,32 @@ Methods void ChangeFolder(string folder) uint64 Accessed : Last access uint64 Created : Creation date - void GetFile(string targetfile, string sourcefile) + object, dict GetFile(string targetfile, string sourcefile) Copy the source file (from remote device) to the target file (on local filesystem). - A new Transfer object is created to represent this - transaction. + 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. - void PutFile(string sourcefile, string targetfile) + The properties of this transfer are also returned along + with the object path, to avoid a call to GetProperties. + + object, dict PutFile(string sourcefile, string targetfile) Copy the source file (from local filesystem) to the target file (on remote device). - A new Transfer object is created to represent this - transaction. + 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. void CopyFile(string sourcefile, string targetfile) |