Return-Path: From: Mikel Astiz To: CC: Mikel Astiz Subject: [RFC obexd 07/10] client-doc: ObjectPush sessions return transports Date: Thu, 24 Nov 2011 15:08:59 +0100 Message-ID: <1322143742-31182-8-git-send-email-mikel.astiz@bmw-carit.de> In-Reply-To: <1322143742-31182-1-git-send-email-mikel.astiz@bmw-carit.de> References: <1322143742-31182-1-git-send-email-mikel.astiz@bmw-carit.de> MIME-Version: 1.0 Content-Type: text/plain Sender: linux-bluetooth-owner@vger.kernel.org List-ID: --- doc/client-api.txt | 28 +++++++++++++++++++++++++--- 1 files changed, 25 insertions(+), 3 deletions(-) diff --git a/doc/client-api.txt b/doc/client-api.txt index eb06d6b..5a23c6e 100644 --- a/doc/client-api.txt +++ b/doc/client-api.txt @@ -55,22 +55,44 @@ Service org.openobex.client Interface org.openobex.ObjectPush Object path [variable prefix]/{session0,session1,...} -Methods void SendFiles(array{string} files, string destination) +Methods object SendFiles(array{string} files, string destination) Send one or multiple local files to the remote device, and the given destination. - 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. + + object 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. + + This object will represent the whole list of files in a + single transfer. + + object 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. + File Transfer hierarchy ======================= -- 1.7.6.4