yetangitu/deltachat-core
1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-05 02:29:28 +02:00
Code Issues Releases Wiki Activity

Doxygen

Browse source
This commit is contained in:
B. Petersen 2017-11-18 18:16:29 +01:00
parent 51e2c49c33
commit bc31dd48fc
30 changed files with 112 additions and 262 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/html/structmrmailbox__t.html
View file

@ -192,7 +192,7 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:a8e04e43dacbe3128afd71e1d6c1b0911"><td class="mdescLeft">&#160;</td><td class="mdescRight">Archive or unarchive a chat. <a href="#a8e04e43dacbe3128afd71e1d6c1b0911">More...</a><br /></td></tr>
<tr class="separator:a8e04e43dacbe3128afd71e1d6c1b0911"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24813f8aea38bcf5f928ea8a5fd7a3ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a24813f8aea38bcf5f928ea8a5fd7a3ec">mrmailbox_delete_chat</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox, uint32_t chat_id)</td></tr>
<tr class="memdesc:a24813f8aea38bcf5f928ea8a5fd7a3ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a chat: <a href="#a24813f8aea38bcf5f928ea8a5fd7a3ec">More...</a><br /></td></tr>
<tr class="memdesc:a24813f8aea38bcf5f928ea8a5fd7a3ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a chat. <a href="#a24813f8aea38bcf5f928ea8a5fd7a3ec">More...</a><br /></td></tr>
<tr class="separator:a24813f8aea38bcf5f928ea8a5fd7a3ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f9ac5fb9ff2dcbaafdddb5d955ac39b"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b">mrmailbox_send_text_msg</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox, uint32_t chat_id, const char *text_to_send)</td></tr>
<tr class="memdesc:a3f9ac5fb9ff2dcbaafdddb5d955ac39b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a simple text message to the given chat. <a href="#a3f9ac5fb9ff2dcbaafdddb5d955ac39b">More...</a><br /></td></tr>
@ -819,15 +819,13 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>Delete a chat: </p>
<p>Delete a chat. </p>
<p>Messages are deleted from the device and the chat database entry is deleted. After that, the event <a class="el" href="mrevent_8h.html#a17eaeb107cbab46c0d9271d0b5560fc8" title="One or more messages changed for some reasons in the database. ">MR_EVENT_MSGS_CHANGED</a> is posted.</p>
<p>Things that are <em>not</em> done implicitly:</p>
<ul>
<li>messages are deleted from the device and the chat database entry is deleted</li>
<li>messages are <em>not</em> deleted from the server</li>
<li>the chat is not blocked, so new messages from the user/the group may appear and the user may create the chat again</li>
<li>this is also one of the reasons, why groups are <em>not left</em> - this would be unexpected as deleting a normal chat also does not prevent new mails</li>
<li>moreover, there may be valid reasons only to leave a group and only to delete a group</li>
<li>another argument is, that leaving a group requires sending a message to all group members - esp. for groups not used for a longer time, this is really unexpected</li>
<li>to leave a chat, use mrmailbox_remove_contact_from_chat(mailbox, chat_id, MR_CONTACT_ID_SELF)</li>
<li>Messages are <b>not deleted from the server</b>.</li>
<li>The chat or the contact is <b>not blocked</b>, so new messages from the user/the group may appear and the user may create the chat again.</li>
<li><b>Groups are not left</b> - this would be unexpected as deleting a normal chat also does not prevent new mails from arriving (another argument is, that leaving a group requires sending a message to all group members - esp. for groups not used for a longer time, this is really unexpected when deletion results in contacting all members again. To leave a chat explicitly, use <a class="el" href="structmrmailbox__t.html#a40226d401548b002a62648ea054ac635" title="Remove a member from a group. ">mrmailbox_remove_contact_from_chat()</a> with chat_id=MR_CONTACT_ID_SELF)</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
@ -1303,7 +1301,7 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A chatlist as an <a class="el" href="structmrchatlist__t.html" title="An object representing a single chatlist in memory. ">mrchatlist_t</a> object. Must be freed using <a class="el" href="structmrchatlist__t.html#ab036d6e066b5ff78779f36711c9ab2f9" title="Free a mrchatlist_t object as created eg. ">mrchatlist_unref()</a> when no longer used </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>A chatlist as an <a class="el" href="structmrchatlist__t.html" title="An object representing a single chatlist in memory. ">mrchatlist_t</a> object. Must be freed using <a class="el" href="structmrchatlist__t.html#ab036d6e066b5ff78779f36711c9ab2f9" title="Free a chatlist object. ">mrchatlist_unref()</a> when no longer used </dd></dl>
</div>
</div>
@ -1419,7 +1417,7 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The contact object, must be freed using <a class="el" href="structmrcontact__t.html#acdff2696f48b1d5cdbc67a8466322b25" title="Free a contact object. ">mrcontact_unref()</a> when no longer used. NULL on errors. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The contact object, must be freed using <a class="el" href="structmrcontact__t.html#a38e17e55cd66f5e86a1dcb8d1f67797a" title="Free a contact object. ">mrcontact_unref()</a> when no longer used. NULL on errors. </dd></dl>
</div>
</div>