From: John Freed <okgithub@johnfreed.com>
Date: Thu, 14 Oct 2021 13:24:07 +0000 (+0200)
Subject: Merge branch master into dbus_updateConfiguration
X-Git-Url: https://git.nmode.ca/signal-cli/commitdiff_plain/09da3aae62d34de33b73dc53870090c23efe078a?ds=sidebyside

Merge branch master into dbus_updateConfiguration
---

09da3aae62d34de33b73dc53870090c23efe078a
diff --cc man/signal-cli-dbus.5.adoc
index 508a7881,55058580..1a0fbfaa
--- a/man/signal-cli-dbus.5.adoc
+++ b/man/signal-cli-dbus.5.adoc
@@@ -367,37 -529,22 +529,42 @@@ uploadStickerPack(stickerPackPath<s>) -
  * stickerPackPath : Path to the manifest.json file or a zip file in the same directory
  * url             : URL of sticker pack after successful upload
  
 -Exceptions: Failure
 +Exception: Failure, IOError
 +
 +getConfiguration() -> [readReceipts<b>, unidentifiedDeliveryIndicators<b>, typingIndicators<b>, linkPreviews<b>] -> <>::
 +* readReceipts                   : Should Signal send read receipts (true/false).
 +* unidentifiedDeliveryIndicators : Should Signal show unidentified delivery indicators (true/false).
 +* typingIndicators               : Should Signal send/show typing indicators (true/false).
 +* linkPreviews                   : Should Signal generate link previews (true/false).
 +
 +Gets an array of four booleans as indicated. Only works from primary device.
 +
 +Exceptions: IOError, UserError
 +
 +setConfiguration(readReceipts<b>, unidentifiedDeliveryIndicators<b>, typingIndicators<b>, linkPreviews<b>) -> <>::
 +* readReceipts                   : Should Signal send read receipts (true/false).
 +* unidentifiedDeliveryIndicators : Should Signal show unidentified delivery indicators (true/false).
 +* typingIndicators               : Should Signal send/show typing indicators (true/false).
 +* linkPreviews                   : Should Signal generate link previews (true/false).
 +
 +Update Signal configurations and sync them to linked devices. Only works from primary device.
 +
 +Exceptions: IOError, UserError
  
- 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.
+ version() -> version<s>::
+ * version : Version string of signal-cli
  
- Exception: IOErrorException
+ Exceptions: None
  
  == Signals
- SyncMessageReceived (timestamp<x>, sender<s>, destination<s>, groupId<ay>,message<s>, attachments<as>)::
+ SyncMessageReceived (timestamp<x>, sender<s>, destination<s>, groupId<ay>, message<s>, attachments<as>)::
+ * timestamp   : Integer value that can be used to associate this e.g. with a sendMessage()
+ * sender      : Phone number of the sender
+ * destination : DBus code for destination
+ * groupId     : Byte array representing the internal group identifier (empty when private message)
+ * message     : Message text
+ * attachments : String array of filenames in the signal-cli storage (~/.local/share/signal-cli/attachments/)
+ 
  The sync message is received when the user sends a message from a linked device.
  
  ReceiptReceived (timestamp<x>, sender<s>)::