[PATCH obexd 06/10] client-doc: Add documentation of MessageAccess.GetMessageListing

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



From: Luiz Augusto von Dentz <luiz.von.dentz@xxxxxxxxx>

---
 doc/client-api.txt |   24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/doc/client-api.txt b/doc/client-api.txt
index 5a960e1..1ad9001 100644
--- a/doc/client-api.txt
+++ b/doc/client-api.txt
@@ -361,6 +361,30 @@ Methods		void SetFolder(string name)
 
 				string Name : Folder name
 
+		array{dict} GetMessageListing(string folder, dict filter)
+
+			Returns a dictionary containing information about
+			the messages in the given folder.
+
+			The following keys are defined:
+
+				string Handle : Message handle
+				string Subject : Message subject
+				string Timestamp: Message timestamp
+				string Sender: Message sender name
+				string SenderAddress: Message sender address
+				string ReplyTo: Message Reply-To address
+				string Recipient: Message recipient name
+				string RecipientAddress: Message recipient
+							 address
+				string Type: Message type
+				uint64 Size: Message size in bytes
+				string Status: Message reception status
+				boolean Priority: Message priority flag
+				boolean Read: Message read flag
+				boolean Sent: Message sent flag
+				boolean Protected: Message protected flag
+
 Transfer hierarchy
 ==================
 
-- 
1.7.10.2

--
To unsubscribe from this list: send the line "unsubscribe linux-bluetooth" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Bluez Devel]     [Linux Wireless Networking]     [Linux Wireless Personal Area Networking]     [Linux ATH6KL]     [Linux USB Devel]     [Linux Media Drivers]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [Big List of Linux Books]

  Powered by Linux