From: Ajay Kishore <ajay.kishore@intel.com>
To: linux-bluetooth@vger.kernel.org
Subject: [PATCH v2 6/6] doc/obex-api: Update documentation
Date: Tue, 24 Dec 2019 10:33:02 +0530 [thread overview]
Message-ID: <1577163782-28759-2-git-send-email-ajay.kishore@intel.com> (raw)
In-Reply-To: <1577163782-28759-1-git-send-email-ajay.kishore@intel.com>
This adds documentation with the conversation listing feature
Signed-off-by: Ajay Kishore <ajay.kishore@intel.com>
---
doc/obex-api.txt | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 94 insertions(+)
diff --git a/doc/obex-api.txt b/doc/obex-api.txt
index f39355a..8f27b40 100644
--- a/doc/obex-api.txt
+++ b/doc/obex-api.txt
@@ -892,3 +892,97 @@ Properties string Folder [readonly]
boolean Protected [readonly]
Message protected flag
+
+Conversation Access hierarchy
+==============================
+
+Service org.bluez.obex
+Interface org.bluez.obex.Conversation1
+Object path [Session object path]
+
+Methods 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
+
+ Properties:
+ string id:
+
+ Conversation unique identification
+
+ string name:
+
+ Conversation name
+
+ string last_activity:
+
+ Conversation timestamp for the last activity
+
+ boolean read_status:
+
+ Conversation read flag
+
+ string version_counter:
+
+ 128 bits version counter.
+ The 'Conversation-Listing Version Counter',
+ 'Conversation Version Counter', and 'Folder
+ Version Counter' are used to detect if something
+ has changed
+
+ string summary:
+
+ Conversation summary
+
+ string display:
+
+ Conversation participants name
+
+ 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
+
+ uint16 priority:
+
+ Conversation participant priority
+
+ Possible errors: org.bluez.obex.Error.InvalidArguments
+ org.bluez.obex.Error.Failed
+
+
+Filter: uint16 MaxListCount:
+
+ Maximum number of items in the conversations.
+
+ 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.
+
+ boolean ReadStatus:
+
+ Filter converstions by read flag.
+
+ Possible values: True for read or False for unread
+
+ string Recipient:
+
+ Filter conversations by conversation-recipient.
--
2.7.4
next prev parent reply other threads:[~2019-12-24 5:26 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-24 5:03 [PATCH v2 4/6] obexd: Add parser for conversation element Ajay Kishore
2019-12-24 5:03 ` Ajay Kishore [this message]
2020-01-10 15:57 ` [PATCH v2 6/6] doc/obex-api: Update documentation Matias Karhumaa
2020-02-11 8:14 ` Kishore, Ajay
2020-01-10 16:04 ` [PATCH v2 4/6] obexd: Add parser for conversation element Matias Karhumaa
2020-02-11 8:07 ` Kishore, Ajay
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=1577163782-28759-2-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.