yetangitu/deltachat-core
1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-06 03:50:08 +02:00
Code Issues Releases Wiki Activity

refine comment for dc_chat_is_unpromoted()

Browse source
This commit is contained in:
B. Petersen 2018-10-23 21:43:44 +02:00
parent f576a7c392
commit 347a7cac7a
1 changed files with 11 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

15
src/dc_chat.c
View file

@ -329,17 +329,24 @@ int dc_chat_get_archived(const dc_chat_t* chat)
/** /**
* Check if a chat is still unpromoted. Chats are unpromoted until the first * Check if a group chat is still unpromoted.
* message is sent. With unpromoted chats, members can be sent, settings can be
* modified without the need of special status messages being sent.
* *
* After the creation with dc_create_group_chat() the chat is usuall unpromoted * After the creation with dc_create_group_chat() the chat is usually unpromoted
* until the first call to dc_send_text_msg() or another sending function. * until the first call to dc_send_text_msg() or another sending function.
* *
* With unpromoted chats, members can be added
* and settings can be modified without the need of special status messages being sent.
*
* While the core takes care of the unpromoted state on its own,
* checking the state from the UI side may be useful to decide whether a hint as
* "Send the first message to allow others to reply within the group"
* should be shown to the user or not.
*
* @memberof dc_chat_t * @memberof dc_chat_t
* @param chat The chat object. * @param chat The chat object.
* @return 1=chat is still unpromoted, no message was ever send to the chat, * @return 1=chat is still unpromoted, no message was ever send to the chat,
* 0=chat is not unpromoted, messages were send and/or received * 0=chat is not unpromoted, messages were send and/or received
* or the chat is not group chat.
*/ */
int dc_chat_is_unpromoted(const dc_chat_t* chat) int dc_chat_is_unpromoted(const dc_chat_t* chat)
{ {