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

add some more hints and missing crosslinks to dc_get_chat_type() (#2724)

Browse Source
This commit is contained in:
bjoern
2021-10-01 21:07:23 +02:00
committed by GitHub
parent 4f19036408
commit b0902102a2
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
deltachat-ffi/deltachat.h
View File

@@ -3067,19 +3067,25 @@ uint32_t dc_chat_get_id (const dc_chat_t* chat);
* - @ref DC_CHAT_TYPE_SINGLE - a normal chat is a chat with a single contact, * - @ref DC_CHAT_TYPE_SINGLE - a normal chat is a chat with a single contact,
* chats_contacts contains one record for the user. DC_CONTACT_ID_SELF * chats_contacts contains one record for the user. DC_CONTACT_ID_SELF
* (see dc_contact_t::id) is added _only_ for a self talk. * (see dc_contact_t::id) is added _only_ for a self talk.
* These chats are created by dc_create_chat_by_contact_id().
* *
* - @ref DC_CHAT_TYPE_GROUP - a group chat, chats_contacts contain all group * - @ref DC_CHAT_TYPE_GROUP - a group chat, chats_contacts contain all group
* members, incl. DC_CONTACT_ID_SELF * members, incl. DC_CONTACT_ID_SELF.
* Groups are created by dc_create_group_chat().
* *
* - @ref DC_CHAT_TYPE_MAILINGLIST - a mailing list, this is similar to groups, * - @ref DC_CHAT_TYPE_MAILINGLIST - a mailing list, this is similar to groups,
* however, the member list cannot be retrieved completely * however, the member list cannot be retrieved completely
* and cannot be changed using this api. * and cannot be changed using this api.
* moreover, for now, mailist lists are read-only. * Mailing lists are created as needed by incoming messages
* and usually require some special server;
* they cannot be created by a function call as the other chat types.
* Moreover, for now, mailing lists are read-only.
* *
* - @ref DC_CHAT_TYPE_BROADCAST - a broadcast list, * - @ref DC_CHAT_TYPE_BROADCAST - a broadcast list,
* the recipients will get messages in a one-to-one chats and * the recipients will get messages in a one-to-one chats and
* the sender will get answers in a one-to-one as well. * the sender will get answers in a one-to-one as well.
* chats_contacts contain all recipients but DC_CONTACT_ID_SELF * chats_contacts contain all recipients but DC_CONTACT_ID_SELF.
* Broadcasts are created by dc_create_broadcast_list().
* *
* @memberof dc_chat_t * @memberof dc_chat_t
* @param chat The chat object. * @param chat The chat object.