doc: Add Cancel method to Message API
authorDenis Kenzior <denkenz@gmail.com>
Fri, 18 Mar 2011 21:18:43 +0000 (16:18 -0500)
committerDenis Kenzior <denkenz@gmail.com>
Fri, 18 Mar 2011 23:31:14 +0000 (18:31 -0500)
doc/message-api.txt

index 8d962fd..3eb3d2b 100644 (file)
@@ -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