All of lore.kernel.org
 help / color / mirror / Atom feed
From: Ajay Kishore <ajay.kishore@intel.com>
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	[thread overview]
Message-ID: <1583398524-18749-6-git-send-email-ajay.kishore@intel.com> (raw)
In-Reply-To: <1583398524-18749-1-git-send-email-ajay.kishore@intel.com>

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
 =================
 
-- 
2.7.4


  parent reply	other threads:[~2020-03-05  9:18 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-05  8:55 [PATCH v3 1/6] obexd: Add initial support for MAP conversations Ajay Kishore
2020-03-05  8:55 ` [PATCH v3 2/6] obexd: Add parsers for conversation filters Ajay Kishore
2020-03-05  8:55 ` [PATCH v3 3/6] obexd: Get conversation listings Ajay Kishore
2020-03-05  8:55 ` [PATCH v3 4/6] obexd: Add parser for conversation element Ajay Kishore
2020-03-05  8:55 ` [PATCH v3 5/6] obexd: Handle MAP Event Report v1.1 and v1.2 Ajay Kishore
2020-03-05  8:55 ` Ajay Kishore [this message]
2020-03-05 19:53   ` [PATCH v3 6/6] doc/obex-api: Update documentation Luiz Augusto von Dentz
2020-03-05 19:58     ` Luiz Augusto von Dentz
  -- strict thread matches above, loose matches on Subject: below --
2020-02-11  6:36 [PATCH v2 1/6] obexd: Add initial support for MAP conversations Ajay Kishore
2020-02-11  6:36 ` [PATCH v3 6/6] doc/obex-api: Update documentation Ajay Kishore

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1583398524-18749-6-git-send-email-ajay.kishore@intel.com \
    --to=ajay.kishore@intel.com \
    --cc=linux-bluetooth@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.