X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/d9c8711eb0f5391a8f9efaecdef97dc7a7af23e6..49591aedb4ecce3a34ee72e4e8e455c1b72358af:/man/signal-cli-dbus.5.adoc diff --git a/man/signal-cli-dbus.5.adoc b/man/signal-cli-dbus.5.adoc index e07e4666..46b11734 100644 --- a/man/signal-cli-dbus.5.adoc +++ b/man/signal-cli-dbus.5.adoc @@ -5,10 +5,11 @@ vim:set ts=4 sw=4 tw=82 noet: :quotes.~: = signal-cli-dbus (5) +:doctype: manpage == Name -DBus API for signal-cli - A commandline and dbus interface for the Signal messenger +signal-cli-dbus - A commandline and dbus interface for the Signal messenger == Synopsis @@ -64,15 +65,12 @@ link(newDeviceName) -> deviceLinkUri:: 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: -[source] +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 ----- - -Exceptions: Failure +``` listAccounts() -> accountList:: * accountList : Array of all attached accounts in DBus object path form @@ -122,7 +120,7 @@ The following methods listen to the account's object path, which is constructed getContactName(number) -> name:: * number : Phone number -* name : Contact's name in local storage (from the master device for a linked account, or the one set with setContactName); if not set, contact's profile name is used +* name : Contact's name in local storage (from the primary device for a linked account, or the one set with setContactName); if not set, contact's profile name is used Exceptions: None @@ -205,6 +203,15 @@ Depending on the type of the recipient(s) field this sends a reaction to one or Exceptions: Failure, InvalidNumber +sendPaymentNotification(receipt, note, recipient) -> timestamp:: +* receipt : Byte array with the payment receipt blob +* note : String with a note for the payment +* recipient : String with the phone number of a single recipient + +* timestamp : Long, can be used to identify the corresponding Signal reply + +Exceptions: Failure + sendNoteToSelfMessage(message, attachments) -> timestamp:: * message : Text to send (can be UTF8) * attachments : String array of filenames to send as attachments (passed as filename, so need to be readable by the user signal-cli is running under) @@ -456,6 +463,7 @@ addMembers(recipients) -> <>:: * recipients : String array of phone numbers Add recipients to group if they are pending members; otherwise add recipients to list of requesting members. +This command is also used to accept group invitations by adding yourself to a group. Exceptions: Failure