diff options
author | Mikel Astiz <mikel.astiz@bmw-carit.de> | 2012-06-04 11:37:53 +0200 |
---|---|---|
committer | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2012-06-04 14:11:01 +0300 |
commit | 39fd49737442d9364e38251690913e0dfee630f2 (patch) | |
tree | 658ab8b09998b496591a17d65b429d5f709a3508 | |
parent | 4a63ac94ddc6613a0a0a1e5ea510e6fc8426d2e2 (diff) | |
download | obexd-39fd49737442d9364e38251690913e0dfee630f2.tar.gz |
client-doc: PhonebookAccess sessions return transfers
-rw-r--r-- | doc/client-api.txt | 31 |
1 files changed, 26 insertions, 5 deletions
diff --git a/doc/client-api.txt b/doc/client-api.txt index 5a3e252..17c15bb 100644 --- a/doc/client-api.txt +++ b/doc/client-api.txt @@ -205,10 +205,21 @@ Methods void Select(string location, string phonebook) "mch": missing call history "cch": combination of ich och mch - string PullAll() + object, dict PullAll(string targetfile) Return the entire phonebook object from the PSE server - in plain string with vcard format. + in plain string with vcard format, 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. array{string vcard, string name} List() @@ -216,10 +227,20 @@ Methods void Select(string location, string phonebook) vcard : name paired string, for example "1.vcf" : "John". - string Pull(string vcard) + object, dict Pull(string vcard, string targetfile) - Retrieve the vcard in the current phonebook object - for example : Pull("0.vcf") + Retrieve the vcard in the current phonebook object 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. array{string vcard, string name} Search(string field, string value) |