Implement reactions

deltachat-ffi/deltachat.h

@@ -11,16 +11,17 @@ extern "C" {
 #endif
 
 
-typedef struct _dc_context  dc_context_t;
-typedef struct _dc_accounts dc_accounts_t;
-typedef struct _dc_array    dc_array_t;
-typedef struct _dc_chatlist dc_chatlist_t;
-typedef struct _dc_chat     dc_chat_t;
-typedef struct _dc_msg      dc_msg_t;
-typedef struct _dc_contact  dc_contact_t;
-typedef struct _dc_lot      dc_lot_t;
-typedef struct _dc_provider dc_provider_t;
-typedef struct _dc_event    dc_event_t;
+typedef struct _dc_context   dc_context_t;
+typedef struct _dc_accounts  dc_accounts_t;
+typedef struct _dc_array     dc_array_t;
+typedef struct _dc_chatlist  dc_chatlist_t;
+typedef struct _dc_chat      dc_chat_t;
+typedef struct _dc_msg       dc_msg_t;
+typedef struct _dc_reactions dc_reactions_t;
+typedef struct _dc_contact   dc_contact_t;
+typedef struct _dc_lot       dc_lot_t;
+typedef struct _dc_provider  dc_provider_t;
+typedef struct _dc_event     dc_event_t;
 typedef struct _dc_event_emitter dc_event_emitter_t;
 typedef struct _dc_jsonrpc_instance dc_jsonrpc_instance_t;
 
@@ -991,6 +992,34 @@ uint32_t        dc_send_text_msg             (dc_context_t* context, uint32_t ch
 uint32_t dc_send_videochat_invitation (dc_context_t* context, uint32_t chat_id);
 
 
+/**
+ * Send a reaction to message.
+ *
+ * Reaction is a string of emojis separated by spaces. Reaction to a
+ * single message can be sent multiple times. The last reaction
+ * received overrides all previously received reactions. It is
+ * possible to remove all reactions by sending an empty string.
+ *
+ * @memberof dc_context_t
+ * @param context The context object.
+ * @param msg_id ID of the message you react to.
+ * @param reaction A string consisting of emojis separated by spaces.
+ * @return The ID of the message sent out or 0 for errors.
+ */
+uint32_t dc_send_reaction (dc_context_t* context, uint32_t msg_id, char *reaction);
+
+
+/**
+ * Get a structure with reactions to the message.
+ *
+ * @memberof dc_context_t
+ * @param context The context object.
+ * @param msg_id The message ID to get reactions for.
+ * @return A structure with all reactions to the message.
+ */
+dc_reactions_t* dc_get_msg_reactions (dc_context_t *context, int msg_id);
+
+
 /**
  * A webxdc instance sends a status update to its other members.
  *
@@ -4882,7 +4911,49 @@ uint32_t        dc_lot_get_id            (const dc_lot_t* lot);
  * @param lot The lot object.
  * @return The timestamp as defined by the creator of the object. 0 if there is not timestamp or on errors.
  */
-int64_t          dc_lot_get_timestamp     (const dc_lot_t* lot);
+int64_t         dc_lot_get_timestamp     (const dc_lot_t* lot);
+
+
+/**
+ * @class dc_reactions_t
+ *
+ * An object representing all reactions for a single message.
+ */
+
+/**
+ * Returns array of contacts which reacted to the given message.
+ *
+ * @memberof dc_reactions_t
+ * @param reactions The object containing message reactions.
+ * @return array of contact IDs. Use dc_array_get_cnt() to get array length and
+ *         dc_array_get_id() to get the IDs. Should be freed using `dc_array_unref()` after usage.
+ */
+dc_array_t*     dc_reactions_get_contacts(dc_reactions_t* reactions);
+
+
+/**
+ * Returns a string containing space-separated reactions of a single contact.
+ *
+ * @memberof dc_reactions_t
+ * @param reactions The object containing message reactions.
+ * @param contact_id ID of the contact.
+ * @return Space-separated list of emoji sequences, which could be empty.
+ *         Returned string should not be modified and should be freed
+ *         with dc_str_unref() after usage.
+ */
+char*           dc_reactions_get_by_contact_id(dc_reactions_t* reactions, uint32_t contact_id);
+
+
+/**
+ * Frees an object containing message reactions.
+ *
+ * Reactions objects are created by dc_get_msg_reactions().
+ *
+ * @memberof dc_reactions_t
+ * @param reactions The object to free.
+ *     If NULL is given, nothing is done.
+ */
+void            dc_reactions_unref       (dc_reactions_t* reactions);
 
 
 /**
@@ -5533,6 +5604,15 @@ void dc_event_unref(dc_event_t* event);
 #define DC_EVENT_MSGS_CHANGED             2000
 
 
+/**
+ * Message reactions changed.
+ *
+ * @param data1 (int) chat_id ID of the chat affected by the changes.
+ * @param data2 (int) msg_id ID of the message for which reactions were changed.
+ */
+#define DC_EVENT_REACTIONS_CHANGED        2001
+
+
 /**
  * There is a fresh message. Typically, the user will show an notification
  * when receiving this message.