diff options
author | Srinivasa Ragavan <srinivasa.ragavan.venkateswaran@intel.com> | 2012-10-04 19:52:39 +0530 |
---|---|---|
committer | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2012-10-04 23:52:48 +0300 |
commit | b22ffdf9925ec34f6b579aa7cdcfad22d85edd1d (patch) | |
tree | 5baf4443ff98a54cf4463b6910495b0dfc7804c0 | |
parent | a32048faafd890c4ea5e48045692f5769c262d0b (diff) | |
download | obexd-b22ffdf9925ec34f6b579aa7cdcfad22d85edd1d.tar.gz |
client-doc: Add documentation for Message.SetProperty and Message.GetProperties
-rw-r--r-- | doc/client-api.txt | 79 |
1 files changed, 79 insertions, 0 deletions
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 ================== |