webmaster/signal-cli
1
0
Fork 0
mirror of https://github.com/AsamK/signal-cli synced 2025-09-06 14:10:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

DbusMention and DbusAttachment, with signals

Browse source 
Two new data types: `DbusMention` (created by @0b11001111) and `DbusAttachment`.

Two new signals, `MessageReceivedV2` and `SyncMessageReceivedV2`.

This is to address #671 #316 #658 and #491, in particular addressing the issues raised by @AsamK in #658.

The new signals provide the new data structures to the user program, while the existing signals, `MessageReceived` and `SyncMessageReceived`, continue to provide the old data types (with no information about mentions or attachment metadata).

As a result, for each message received, two signals will be emitted: the legacy signal and the V2 signal. Existing (old-style) programs will not see the V2 signal, and so nothing will break. New programs can ignore the legacy signal and process the enhanced data.
This commit is contained in:
John Freed 2021-09-20 20:10:32 +02:00
parent 6c29d90503
commit 205cc8d6c2
8 changed files with 518 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -238,14 +238,9 @@ isRegistred -> result<b>::
== Signals
SyncMessageReceived (timestamp<x>, sender<s>, destination<s>, groupId<ay>,message<s>, attachments<as>)::
The sync message is received when the user sends a message from a linked device.
ReceiptReceived (timestamp<x>, sender<s>)::
* timestamp : Integer value that can be used to associate this e.g. with a sendMessage()
* sender : Phone number of the sender
This signal is sent by each recipient (e.g. each group member) after the message was successfully delivered to the device
MessageReceived(timestamp<x>, sender<s>, groupId<ay>, message<s>, attachments<as>)::
* timestamp : Integer value that is used by the system to send a ReceiptReceived reply
* sender : Phone number of the sender
@ -255,6 +250,59 @@ MessageReceived(timestamp<x>, sender<s>, groupId<ay>, message<s>, attachments<as
This signal is received whenever we get a private message or a message is posted in a group we are an active member
SyncMessageReceivedV2 (timestamp<x>, sender<s>, destination<s>, groupId<ay>, message<s>, mentions<a(sii)>, attachments<a(sssxibiiss)>)::
* timestamp : Integer value that is used by the system to send a ReceiptReceived reply
* sender : Phone number of the sender
* destination : UUID (legacy identifier) of the destination
* groupId : Byte array representing the internal group identifier (empty when private message)
* message : Message text
* mentions : Struct array of mentions: number, position, length
** number : String phone number
** position : Integer starting position of mention within message
** length : Integer length of mention within message
* attachments : Struct array of attachment metadata.
** contentType : String representing the MIME type of the attachment
** fileName : String representing file name if given by the Signal servers
** id : String representing remote identifier of attachment. This the name used by signal-cli to store the attachment, and the current user needs to have read access
** size : Long representing size of attachment in bytes
** keyLength : Integer representing key length
** voiceNote : boolean representing whether this attachment is a voice note
** width : Integer representation of width in pixels (0 if not image)
** height : Integer representation of height in pixels (0 if not image)
** caption : String representing photo caption
** blurHash : String representing blur hash
The sync message is received when the user sends a message from a linked device.
MessageReceivedV2(timestamp<x>, sender<s>, groupId<ay>, message<s>, mentions<a(sii)>, attachments<a(sssxibiiss)>)::
* timestamp : Integer value that is used by the system to send a ReceiptReceived reply
* sender : Phone number of the sender
* groupId : Byte array representing the internal group identifier (empty when private message)
* message : Message text
* mentions : Struct array of mentions: number, position, length
** number : String phone number
** position : Integer starting position of mention within message
** length : Integer length of mention within message
* attachments : Struct array of attachment metadata.
** contentType : String representing the MIME type of the attachment
** fileName : String representing file name if given by the Signal servers
** id : String representing remote identifier of attachment. This the name used by signal-cli to store the attachment, and the current user needs to have read access
** size : Long representing size of attachment in bytes
** keyLength : Integer representing key length
** voiceNote : boolean representing whether this attachment is a voice note
** width : Integer representation of width in pixels (0 if not image)
** height : Integer representation of height in pixels (0 if not image)
** caption : String representing photo caption
** blurHash : String representing blur hash
This signal is received whenever we get a private message or a message is posted in a group we are an active member
ReceiptReceived (timestamp<x>, sender<s>)::
* timestamp : Integer value that can be used to associate this e.g. with a sendMessage()
* sender : Phone number of the sender
This signal is sent by each recipient (e.g. each group member) after the message was successfully delivered to the device
== Examples
Send a text message (without attachment) to a contact::