Mirrors/chatmail-core
1
0
Fork 0
mirror of https://github.com/chatmail/core.git synced 2026-05-02 04:46:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: update documentation for TransportsModified event

Browse Source 
It is a follow-up to https://github.com/chatmail/core/pull/7643
Event is not emitted when the transports are modified on this device
and we should consistently say that this event is not only for testing.
This commit is contained in:
link2xt
2025-12-25 10:55:06 +00:00
committed by l
parent 9ac64ea6b9
commit a89ce8ce7a
3 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
deltachat-ffi/deltachat.h
View File

@@ -6706,8 +6706,8 @@ void dc_event_unref(dc_event_t* event);
* Transport relay added/deleted or default has changed. * Transport relay added/deleted or default has changed.
* UI should update the list. * UI should update the list.
* *
* The event is emitted when the transports are modified on this or on another device * The event is emitted when the transports are modified on another device
* using the jsonrpc calls `add_or_update_transport`, `add_transport_from_qr`, `delete_transport` * using the JSON-RPC calls `add_or_update_transport`, `add_transport_from_qr`, `delete_transport`
* or `set_config(configured_addr)`. * or `set_config(configured_addr)`.
*/ */
#define DC_EVENT_TRANSPORTS_MODIFIED 2600 #define DC_EVENT_TRANSPORTS_MODIFIED 2600

10
deltachat-jsonrpc/src/api/types/events.rs
View File

@@ -463,11 +463,11 @@ pub enum EventType {
/// One or more transports has changed. /// One or more transports has changed.
/// ///
/// This event is used for tests to detect when transport /// UI should update the list.
/// synchronization messages arrives. ///
/// UIs don't need to use it, it is unlikely /// This event is emitted when transport
/// that user modifies transports on multiple /// synchronization messages arrives,
/// devices simultaneously. /// but not when the UI modifies the transport list by itself.
TransportsModified, TransportsModified,
} }

10
src/events/payload.rs
View File

@@ -419,11 +419,11 @@ pub enum EventType {
/// One or more transports has changed. /// One or more transports has changed.
/// ///
/// This event is used for tests to detect when transport /// UI should update the list.
/// synchronization messages arrives. ///
/// UIs don't need to use it, it is unlikely /// This event is emitted when transport
/// that user modifies transports on multiple /// synchronization messages arrives,
/// devices simultaneously. /// but not when the UI modifies the transport list by itself.
TransportsModified, TransportsModified,
/// Event for using in tests, e.g. as a fence between normally generated events. /// Event for using in tests, e.g. as a fence between normally generated events.