Mirrors/chatmail-core
1
0
Fork 0
mirror of https://github.com/chatmail/core.git synced 2026-05-20 15:26:30 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: Clarify DC_EVENT_INCOMING_WEBXDC_NOTIFY documentation (#6249)

Browse Source 
I found the old documentation rather hard to understand. The new doc
string:
- uses whole sentences, leaving less space for misinterpretation
- explicitly mentions that it can happen that there is no
webxdc-info-message
- is clearly structured using bullet points.
This commit is contained in:
Hocuri
2024-11-23 15:52:08 +01:00
committed by GitHub
parent 29de7c3603
commit daeeca3710
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
deltachat-ffi/deltachat.h
View File

@@ -6091,11 +6091,15 @@ void dc_event_unref(dc_event_t* event);
* A webxdc wants an info message or a changed summary to be notified. * A webxdc wants an info message or a changed summary to be notified.
* *
* @param data1 contact_id ID of the contact sending. * @param data1 contact_id ID of the contact sending.
* @param data2 (int) msg_id + (char*) text_to_notify. * @param data2 (int) msg_id _and_ (char*) text_to_notify.
* msg_id in dc_event_get_data2_int(), referring to webxdc-info-message * - dc_event_get_data2_int() returns the msg_id,
* or webxdc-instance in case of summary change. * referring to the webxdc-info-message, if there is any.
* text_to_notify in dc_event_get_data2_str(). * Sometimes no webxdc-info-message is added to the chat
* string must be passed to dc_str_unref() afterwards. * and yet a notification is sent; in this case the msg_id
* of the webxdc instance is returned.
* - dc_event_get_data2_str() returns text_to_notify,
* the text that shall be shown in the notification.
* string must be passed to dc_str_unref() afterwards.
*/ */
#define DC_EVENT_INCOMING_WEBXDC_NOTIFY 2003 #define DC_EVENT_INCOMING_WEBXDC_NOTIFY 2003