All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH 6/6] doc/obex-api: Update documentation
@ 2019-12-16  9:28 Ajay Kishore
  2019-12-16  9:28 ` [PATCH v2 5/5] obexd: Handle MAP Event Report v1.1 and v1.2 Ajay Kishore
  2019-12-18  0:13 ` [PATCH 6/6] doc/obex-api: Update documentation Luiz Augusto von Dentz
  0 siblings, 2 replies; 4+ messages in thread
From: Ajay Kishore @ 2019-12-16  9:28 UTC (permalink / raw)
  To: linux-bluetooth

This adds documentation with the conversation listing feature

Signed-off-by: Ajay Kishore <ajay.kishore@intel.com>
---
 doc/obex-api.txt | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)

diff --git a/doc/obex-api.txt b/doc/obex-api.txt
index f39355a..9a76159 100644
--- a/doc/obex-api.txt
+++ b/doc/obex-api.txt
@@ -712,6 +712,71 @@ 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: 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
+
+
 		void UpdateInbox(void)
 
 			Request remote to update its inbox.
-- 
2.7.4


^ permalink raw reply related	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2019-12-24  5:47 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-12-16  9:28 [PATCH 6/6] doc/obex-api: Update documentation Ajay Kishore
2019-12-16  9:28 ` [PATCH v2 5/5] obexd: Handle MAP Event Report v1.1 and v1.2 Ajay Kishore
2019-12-18  0:13 ` [PATCH 6/6] doc/obex-api: Update documentation Luiz Augusto von Dentz
2019-12-24  5:47   ` Kishore, Ajay

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.