X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/a95886c4911f8538b53042149312727fb4a3839a..4e69b34efe78e7bad03e549c966d986b47777668:/man/signal-cli-dbus.5.adoc diff --git a/man/signal-cli-dbus.5.adoc b/man/signal-cli-dbus.5.adoc index f38afc93..4c317db3 100755 --- a/man/signal-cli-dbus.5.adoc +++ b/man/signal-cli-dbus.5.adoc @@ -58,7 +58,7 @@ link(newDeviceName) -> deviceLinkUri:: * newDeviceName : Name to give new device (defaults to "cli" if no name is given) * deviceLinkUri : URI of newly linked device -Returns a URI of the form "sgnl://linkdevice/?uuid=...". This can be piped to a QR encoder to create a display that +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: `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` @@ -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 @@ -311,7 +311,7 @@ The following methods listen to the recipient's object path, which is constructe * DBusNumber : recipient's phone number, with underscore (_) replacing plus (+) addDevice(deviceUri) -> <>:: -* deviceUri : URI in the form of "sgnl://linkdevice/?uuid=..." (formerly "tsdevice:/?uuid=...") Normally displayed by a Signal desktop app, smartphone app, or another signal-cli instance using the `link` control method. +* deviceUri : URI in the form of "sgnl://linkdevice?uuid=..." (formerly "tsdevice:/?uuid=...") Normally displayed by a Signal desktop app, smartphone app, or another signal-cli instance using the `link` control method. getDevice(deviceId) -> devicePath:: * deviceId : Long representing a deviceId