implement DBus submitRateLimitChallenge method (#763)

[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 6b5d1a8607c2b6652776b4b98e1dc186acb425fb..594c29416a9a32d88cca2bc6a22e48204cea0d18 100755 (executable)
--- a/man/signal-cli-dbus.5.adoc
+++ b/man/signal-cli-dbus.5.adoc
@@ -110,12 +110,15 @@ updateGroup(groupId<ay>, newName<s>, members<as>, avatar<s>) -> groupId<ay>::
 
 Exceptions: AttachmentInvalid, Failure, InvalidNumber, GroupNotFound
 
-updateProfile(newName<s>, about <s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>::
-* newName     : New name for your own profile (empty if unchanged)
+updateProfile(name<s>, about<s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>::
+updateProfile(givenName<s>, familyName<s>, about<s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>::
+* name        : Name for your own profile (empty if unchanged)
+* givenName   : Given name for your own profile (empty if unchanged)
+* familyName  : Family name for your own profile (empty if unchanged)
 * about       : About message for profile (empty if unchanged)
 * aboutEmoji  : Emoji for profile (empty if unchanged)
 * avatar      : Filename of avatar picture for profile (empty if unchanged)
-* remove      : Set to 1 if the existing avatar picture should be removed
+* remove      : Set to true if the existing avatar picture should be removed
 
 Exceptions: Failure
 
@@ -360,8 +363,14 @@ uploadStickerPack(stickerPackPath<s>) -> url<s>::
 
 Exception: Failure
 
-== Signals
+submitRateLimitChallenge(challenge<s>, captcha<s>) -> <>::
+* challenge : The challenge token taken from the proof required error.
+* captcha   : The captcha token from the solved captcha on the Signal website..
+Can be used to lift some rate-limits by solving a captcha.
 
+Exception: IOErrorException
+
+== Signalss
 SyncMessageReceived (timestamp<x>, sender<s>, destination<s>, groupId<ay>,message<s>, attachments<as>)::
 The sync message is received when the user sends a message from a linked device.