From patchwork Thu Mar 5 08:55:24 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Kishore, Ajay" X-Patchwork-Id: 11421433 X-Patchwork-Delegate: luiz.dentz@gmail.com Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id B399F139A for ; Thu, 5 Mar 2020 09:18:59 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 93182208CD for ; Thu, 5 Mar 2020 09:18:59 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726764AbgCEJS7 (ORCPT ); Thu, 5 Mar 2020 04:18:59 -0500 Received: from mga14.intel.com ([192.55.52.115]:48950 "EHLO mga14.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725937AbgCEJS7 (ORCPT ); Thu, 5 Mar 2020 04:18:59 -0500 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga103.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 05 Mar 2020 01:18:58 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.70,517,1574150400"; d="scan'208";a="259126132" Received: from unknown (HELO ajay-desktop.iind.intel.com) ([10.223.96.133]) by orsmga002.jf.intel.com with ESMTP; 05 Mar 2020 01:18:58 -0800 From: Ajay Kishore To: linux-bluetooth@vger.kernel.org Subject: [PATCH v3 6/6] doc/obex-api: Update documentation Date: Thu, 5 Mar 2020 14:25:24 +0530 Message-Id: <1583398524-18749-6-git-send-email-ajay.kishore@intel.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1583398524-18749-1-git-send-email-ajay.kishore@intel.com> References: <1583398524-18749-1-git-send-email-ajay.kishore@intel.com> Sender: linux-bluetooth-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org This adds documentation with the conversation listing feature --- doc/obex-api.txt | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/doc/obex-api.txt b/doc/obex-api.txt index f39355a..ef81460 100644 --- a/doc/obex-api.txt +++ b/doc/obex-api.txt @@ -712,6 +712,44 @@ Methods void SetFolder(string name) Possible errors: org.bluez.obex.Error.InvalidArguments org.bluez.obex.Error.Failed + array{object, dict} ListConversations(string folder, dict filter) + + Returns an array containing the conversations found in the + given subfolder of the current folder, or in the current + folder if folder is empty. + + Possible Filters: MaxListCount, LastActivityBegin, LastActivityEnd, + ReadStatus, Recipient + + Each message is represented by an object path followed + by a dictionary of the properties. + + Properties: + + string id: + + Conversation unique identification + + string last_activity: + + Conversation timestamp for the last activity + + string chat_state: + + Conversation current chat state of the participants + + string presence_availability: + + Conversation participants availability + + string presence_text: + + User defined status of the conversation + + Possible errors: org.bluez.obex.Error.InvalidArguments + org.bluez.obex.Error.Failed + + void UpdateInbox(void) Request remote to update its inbox. @@ -799,6 +837,18 @@ Filter: uint16 Offset: Possible values: True for high priority or False for non-high priority + string LastActivityBegin: + + Filter conversations by starting period. + + Possible values: Date in "YYYYMMDDTHHMMSS" format. + + string LastActivityEnd: + + Filter conversations by ending period. + + Possible values: Date in "YYYYMMDDTHHMMSS" format. + Message hierarchy =================