All of lore.kernel.org
 help / color / mirror / Atom feed
From: Luiz Augusto von Dentz <luiz.dentz@gmail.com>
To: linux-bluetooth@vger.kernel.org
Subject: [PATCH obexd 06/10] client-doc: Add documentation of MessageAccess.GetMessageListing
Date: Wed, 27 Jun 2012 15:04:51 +0300	[thread overview]
Message-ID: <1340798695-6785-6-git-send-email-luiz.dentz@gmail.com> (raw)
In-Reply-To: <1340798695-6785-1-git-send-email-luiz.dentz@gmail.com>

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

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


  parent reply	other threads:[~2012-06-27 12:04 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-06-27 12:04 [PATCH obexd 01/10] client: Change MessageAccess.GetFolderListing to not return raw xml Luiz Augusto von Dentz
2012-06-27 12:04 ` [PATCH obexd 02/10] test: Update map-client to the changes in GetFolderListing Luiz Augusto von Dentz
2012-06-27 12:04 ` [PATCH obexd 03/10] client-doc: Add documentation of MessageAccess.GetFolderListing Luiz Augusto von Dentz
2012-06-27 12:04 ` [PATCH obexd 04/10] client: Change MessageAccess.GetMessageListing to not return raw xml Luiz Augusto von Dentz
2012-06-27 12:04 ` [PATCH obexd 05/10] test: Update map-client to the changes in GetMessageListing Luiz Augusto von Dentz
2012-06-27 12:04 ` Luiz Augusto von Dentz [this message]
2012-06-27 12:04 ` [PATCH obexd 07/10] client: Use filter instead of dummy as argument name in MAP Luiz Augusto von Dentz
2012-06-27 12:04 ` [PATCH obexd 08/10] client-doc: Add documentation of MessageAccess.GetMessage Luiz Augusto von Dentz
2012-06-27 12:04 ` [PATCH obexd 09/10] client: Add MessageAccess.GetMessage implementation Luiz Augusto von Dentz
2012-06-27 12:04 ` [PATCH obexd 10/10] test: Add support for MessageAccess.GetMessage to map-client Luiz Augusto von Dentz
2012-07-03 18:28 [PATCH obexd 01/10] client: Change MessageAccess.GetFolderListing to not return raw xml Luiz Augusto von Dentz
2012-07-03 18:28 ` [PATCH obexd 06/10] client-doc: Add documentation of MessageAccess.GetMessageListing Luiz Augusto von Dentz

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=1340798695-6785-6-git-send-email-luiz.dentz@gmail.com \
    --to=luiz.dentz@gmail.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.