webmaster/signal-cli
1
0
Fork 0
mirror of https://github.com/AsamK/signal-cli synced 2025-08-29 10:30:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Dbus sendreaction doc (#591)

Browse source 
* Documentation of dbus methods sendGroupMessageReaction, sendMessageReaction

* Documentation of dbus methods sendGroupMessageReaction, sendMessageReaction. Fix 1.
This commit is contained in:
Adaptive Garage 2021-04-05 17:00:20 +02:00 • committed by GitHub
parent 7832afd819
commit 2ad18342a8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

30
man/signal-cli-dbus.5.adoc
View file

@ -98,7 +98,7 @@ sendEndSessionMessage(recipients<as>) -> <>::
Exceptions: Failure, InvalidNumber, UntrustedIdentity
sendGroupMessage(message<s>, attachments<as>, groupId<a>) -> timestamp<x>::
sendGroupMessage(message<s>, attachments<as>, groupId<ay>) -> timestamp<x>::
* 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)
* groupId : Byte array representing the internal group identifier
@ -113,7 +113,7 @@ sendNoteToSelfMessage(message<s>, attachments<as>) -> timestamp<x>::
Exceptions: Failure, AttachmentInvalid
sendMessage(message<s>, attachments<as>, recipient<s) -> timestamp<x>::
sendMessage(message<s>, attachments<as>, recipient<s>) -> timestamp<x>::
sendMessage(message<s>, attachments<as>, recipients<as>) -> timestamp<x>::
* 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)
@ -123,7 +123,31 @@ sendMessage(message<s>, attachments<as>, recipients<as>) -> timestamp<x>::
Depending on the type of the recipient field this sends a message to one or multiple recipients.
Expections: AttachmentInvalid, Failure, InvalidNumber, UntrustedIdentity
Exceptions: AttachmentInvalid, Failure, InvalidNumber, UntrustedIdentity
sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
* emoji : Unicode grapheme cluster of the emoji
* remove : Boolean, whether a previously sent reaction (emoji) should be removed
* targetAuthor : String with the phone number of the author of the message to which to react
* targetSentTimestamp : Long representing timestamp of the message to which to react
* groupId : Byte array with base64 encoded group identifier
* timestamp : Long, can be used to identify the corresponding signal reply
Exceptions: Failure, InvalidNumber, GroupNotFound
sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
* emoji : Unicode grapheme cluster of the emoji
* remove : Boolean, whether a previously sent reaction (emoji) should be removed
* targetAuthor : String with the phone number of the author of the message to which to react
* targetSentTimestamp : Long representing timestamp of the message to which to react
* recipient : String with the phone number of a single recipient
* recipients : Array of strings with phone numbers, should there be more recipients
* timestamp : Long, can be used to identify the corresponding signal reply
Depending on the type of the recipient(s) field this sends a reaction to one or multiple recipients.
Exceptions: Failure, InvalidNumber
getContactName(number<s>) -> name<s>::
* number : Phone number