Linux bluetooth development
 help / color / mirror / Atom feed
From: Srinivasa Ragavan <srinivasa.ragavan.venkateswaran@intel.com>
To: linux-bluetooth@vger.kernel.org
Cc: Srinivasa Ragavan <srinivasa.ragavan.venkateswaran@intel.com>
Subject: [PATCH 3/4] client-doc: Add documentation for Message.SetProperty and Message.GetProperties
Date: Thu,  4 Oct 2012 19:52:39 +0530	[thread overview]
Message-ID: <1349360560-21631-3-git-send-email-srinivasa.ragavan.venkateswaran@intel.com> (raw)
In-Reply-To: <1349360560-21631-1-git-send-email-srinivasa.ragavan.venkateswaran@intel.com>

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

diff --git a/doc/client-api.txt b/doc/client-api.txt
index 25fd3e4..e680427 100644
--- a/doc/client-api.txt
+++ b/doc/client-api.txt
@@ -534,6 +534,85 @@ Methods		object, dict Get(string targetfile, boolean attachment)
 			The properties of this transfer are also returned along
 			with the object path, to avoid a call to GetProperties.
 
+		dict GetProperties()
+
+			Returns all properties for the message. See the
+			properties section for available properties.
+
+		void SetProperty (string name, variant value)
+
+			Sets value to the mentioned property.
+
+			Possible properties: Read and Deleted.
+
+
+Properties	string Subject [readonly]
+
+			Message subject
+
+		string Timestamp [readonly]
+
+			Message timestamp
+
+		string Sender [readonly]
+
+			Message sender name
+
+		string SenderAddress [readonly]
+
+			Message sender address
+
+		string ReplyTo [readonly]
+
+			Message Reply-To address
+
+		string Recipient [readonly]
+
+			Message recipient name
+
+		string RecipientAddress [readonly]
+
+			Message recipient address
+
+		string Type [readonly]
+
+			Message type
+
+			Possible values: "EMAIL", "SMS_GSM",
+			"SMS_CDMA" and "MMS"
+
+		uint64 Size [readonly]
+
+			Message size in bytes
+
+		string Status [readonly]
+
+			Message reception status
+
+			Possible values: "complete",
+			"fractioned" and "notification"
+
+		boolean Priority [readonly]
+
+			Message priority flag
+
+		boolean Read [read/write]
+
+			Message read flag
+
+		boolean Deleted [writeonly]
+
+			Message read flag
+
+		boolean Sent [readonly]
+
+			Message sent flag
+
+		boolean Protected [readonly]
+
+			Message protected flag
+
+
 Transfer hierarchy
 ==================
 
-- 
1.7.10.4


  parent reply	other threads:[~2012-10-04 14:22 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-10-04 14:22 [PATCH 1/4] client: Update the file offset to the beginning after writing to the file Srinivasa Ragavan
2012-10-04 14:22 ` [PATCH 2/4] client: Add Message.SetProperty and Message.GetProperties implementation Srinivasa Ragavan
2012-10-04 14:22 ` Srinivasa Ragavan [this message]
2012-10-04 14:22 ` [PATCH 4/4] test: Update map-client to include Message.SetProperty and Message.GetProperties Srinivasa Ragavan
2012-10-04 20:55 ` [PATCH 1/4] client: Update the file offset to the beginning after writing to the file Luiz Augusto von Dentz
  -- strict thread matches above, loose matches on Subject: below --
2012-10-04 13:30 Srinivasa Ragavan
2012-10-04 13:30 ` [PATCH 3/4] client-doc: Add documentation for Message.SetProperty and Message.GetProperties Srinivasa Ragavan
2012-10-03 11:31 [PATCH 1/4] client: Update the file offset to the beginning after writing to the file Srinivasa Ragavan
2012-10-03 11:31 ` [PATCH 3/4] client-doc: Add documentation for Message.SetProperty and Message.GetProperties Srinivasa Ragavan

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=1349360560-21631-3-git-send-email-srinivasa.ragavan.venkateswaran@intel.com \
    --to=srinivasa.ragavan.venkateswaran@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox