X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/09da3aae62d34de33b73dc53870090c23efe078a..94b3d9e2ed91b002751df0e04adba3cbc79e6bd1:/man/signal-cli-dbus.5.adoc diff --git a/man/signal-cli-dbus.5.adoc b/man/signal-cli-dbus.5.adoc index 1a0fbfaa..e379dcfb 100755 --- a/man/signal-cli-dbus.5.adoc +++ b/man/signal-cli-dbus.5.adoc @@ -364,6 +364,26 @@ removeDevice() -> <>:: Exceptions: Failure +=== Configuration properties +The configuration's object path, which exists only for primary devices, is constructed as follows: +"/org/asamk/Signal/" + DBusNumber + "/Configuration" +* DBusNumber : recipient's phone number, with underscore (_) replacing plus (+) + +Configurations have the following (case-sensitive) properties: +* ConfigurationReadReceipts : should send read receipts (true/false) +* ConfigurationUnidentifiedDeliveryIndicators : should show unidentified delivery indicators (true/false) +* ConfigurationTypingIndicators : should send/show typing indicators (true/false) +* ConfigurationLinkPreviews : should generate link previews (true/false) + +To get a property, use (replacing `--session` with `--system` if needed): +`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Configuration string:$PROPERTY_NAME` + +To set a property, use: +`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Set string:org.asamk.Signal.Configuration string:$PROPERTY_NAME variant:$PROPERTY_TYPE:$PROPERTY_VALUE` + +To get all properties, use: +`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Configuration` + === Other methods getContactName(number) -> name:: @@ -529,27 +549,7 @@ uploadStickerPack(stickerPackPath) -> url:: * stickerPackPath : Path to the manifest.json file or a zip file in the same directory * url : URL of sticker pack after successful upload -Exception: Failure, IOError - -getConfiguration() -> [readReceipts, unidentifiedDeliveryIndicators, typingIndicators, linkPreviews] -> <>:: -* 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, unidentifiedDeliveryIndicators, typingIndicators, linkPreviews) -> <>:: -* 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 +Exceptions: Failure version() -> version:: * version : Version string of signal-cli