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
