]> nmode's Git Repositories - signal-cli/blobdiff - man/signal-cli-dbus.5.adoc
Implement sendPayment notification command
[signal-cli] / man / signal-cli-dbus.5.adoc
index 5d3d214cedc6c1d3527694d87404dc5d1d81a370..a475eadc66c89b768f05c2a76a8cd77440b9c717 100644 (file)
@@ -8,7 +8,7 @@ vim:set ts=4 sw=4 tw=82 noet:
 
 == Name
 
-DBus API for signal-cli - A commandline and dbus interface for the Signal messenger
+signal-cli-dbus - A commandline and dbus interface for the Signal messenger
 
 == Synopsis
 
@@ -64,15 +64,12 @@ link(newDeviceName<s>) -> deviceLinkUri<s>::
 
 Returns a URI of the form "sgnl://linkdevice?uuid=...".
 This can be piped to a QR encoder to create a display that can be captured by a Signal smartphone client.
-For example:
 
-[source]
+For example:
 
-----
+```
 dbus-send --session --dest=org.asamk.Signal --type=method_call --print-reply /org/asamk/Signal org.asamk.Signal.link string:"My secondary client" | tr '\n' '\0' | sed 's/.*string //g' | sed 's/\"//g' | qrencode -s10 -tANSI256
-----
-
-Exceptions: Failure
+```
 
 listAccounts() -> accountList<as>::
 * accountList : Array of all attached accounts in DBus object path form
@@ -237,9 +234,9 @@ Exceptions: Failure, InvalidNumber
 
 sendTyping(recipient<s>, stop<b>) -> <>::
 * recipient : Phone number of a single recipient
-* targetSentTimestamp : True, if typing state should be stopped
+* stop : True, if typing state should be stopped
 
-Exceptions: Failure, GroupNotFound, UntrustedIdentity
+Exceptions: Failure, UntrustedIdentity
 
 setContactBlocked(number<s>, block<b>) -> <>::
 * number : Phone number affected by method
@@ -353,6 +350,12 @@ sendGroupMessage(message<s>, attachments<as>, groupId<ay>) -> timestamp<x>::
 
 Exceptions: GroupNotFound, Failure, AttachmentInvalid, InvalidGroupId
 
+sendGroupTyping(groupId<ay>, stop<b>) -> <>::
+* groupId : Byte array representing the internal group identifier
+* stop : True, if typing state should be stopped
+
+Exceptions: Failure, GroupNotFound, UntrustedIdentity
+
 sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
 * emoji : Unicode grapheme cluster of the emoji
 * remove : Boolean, whether a previously sent reaction (emoji) should be removed