X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/a95886c4911f8538b53042149312727fb4a3839a..169bb518bf6a43bd0bf14e1291f055017a5d5937:/man/signal-cli-dbus.5.adoc?ds=inline diff --git a/man/signal-cli-dbus.5.adoc b/man/signal-cli-dbus.5.adoc index f38afc93..e379dcfb 100755 --- a/man/signal-cli-dbus.5.adoc +++ b/man/signal-cli-dbus.5.adoc @@ -129,7 +129,7 @@ Exceptions: None, if the group name is not found an empty array is returned joinGroup(inviteURI) -> <>:: * inviteURI : String starting with https://signal.group/# -If the link requires admin approval, this adds you to the requesting members list. Otherwise, this adds you to the pending members list. +Behavior of this method depends on the `requirePermission` parameter of the `enableLink` method. If permission is required, `joinGroup` adds you to the requesting members list. Permission may be granted based on the group's `PermissionAddMember` property (`ONLY_ADMINS` or `EVERY_MEMBER`). If permission is not required, `joinGroup` admits you immediately to the group. Exceptions: Failure @@ -203,7 +203,7 @@ To get all properties, use: addAdmins(recipients) -> <>:: * recipients : String array of phone numbers -Grant admit privileges to recipients. +Grant admin privileges to recipients. Exceptions: Failure @@ -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::