Split given/family name in updateContact command

[signal-cli] / man / signal-cli-dbus.5.adoc

diff --git a/man/signal-cli-dbus.5.adoc b/man/signal-cli-dbus.5.adoc
index 5d3d214cedc6c1d3527694d87404dc5d1d81a370..2a83e50ce7594dfc26780e07136e54ee0a4f7324 100644 (file)
--- a/man/signal-cli-dbus.5.adoc
+++ b/man/signal-cli-dbus.5.adoc
@@ -8,7 +8,7 @@ vim:set ts=4 sw=4 tw=82 noet:
 
 == Name
 
 
 == 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
 
 
 == 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.
 
 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
 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
 
 listAccounts() -> accountList<as>::
 * accountList : Array of all attached accounts in DBus object path form


@@ -122,7 +119,7 @@ The following methods listen to the account's object path, which is constructed
 
 getContactName(number<s>) -> name<s>::
 * number : Phone number
 
 getContactName(number<s>) -> name<s>::
 * number : Phone number

-* name : Contact's name in local storage (from the master device for a linked account, or the one set with setContactName); if not set, contact's profile name is used
+* name : Contact's name in local storage (from the primary device for a linked account, or the one set with setContactName); if not set, contact's profile name is used

 
 Exceptions: None
 
 
 Exceptions: None
 


@@ -237,9 +234,9 @@ Exceptions: Failure, InvalidNumber
 
 sendTyping(recipient<s>, stop<b>) -> <>::
 * recipient : Phone number of a single recipient
 
 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
 
 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
 
 
 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
 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