summaryrefslogtreecommitdiffstats
path: root/doc/message-api.txt
diff options
context:
space:
mode:
authorDenis Kenzior <denkenz@gmail.com>2011-03-18 16:18:43 -0500
committerDenis Kenzior <denkenz@gmail.com>2011-03-18 18:31:14 -0500
commitb0e6ccff1253b40a0c8da4284ba24c24c94d91bc (patch)
tree05c24408ebb8d55769ba1107a3532960d63d8cb9 /doc/message-api.txt
parent9a37a672bfd1ef4902f34871d92aa21748385c77 (diff)
downloadofono-b0e6ccff1253b40a0c8da4284ba24c24c94d91bc.tar.bz2
doc: Add Cancel method to Message API
Diffstat (limited to 'doc/message-api.txt')
-rw-r--r--doc/message-api.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/message-api.txt b/doc/message-api.txt
index 8d962fdc..3eb3d2b7 100644
--- a/doc/message-api.txt
+++ b/doc/message-api.txt
@@ -10,6 +10,15 @@ Methods dict GetProperties()
Returns properties for the message object. See
the properties section for available properties.
+ void Cancel()
+
+ Cancel a message that was previously sent. Only
+ messages that are waiting on queue can be cancelled and
+ it's not possible to cancel messages that already had
+ some parts sent.
+
+ Possible Errors: [service].Error.AccessDenied
+
Signals PropertyChanged(string name, variant value)
This signal indicates a changed value of the given