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-30 14:06:44 +01:00
parent 88df6e6521
commit cd9a1ee5b9
29 changed files with 291 additions and 273 deletions
Download patch file Download diff file Expand all files Collapse all files

266
docs/html/structmrchat__t.html
View file

@ -100,36 +100,33 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a3b1befb4542c1bad915f2175c7c2a2b9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9">mrchat_unref</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:a3b1befb4542c1bad915f2175c7c2a2b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free a chat object. <a href="#a3b1befb4542c1bad915f2175c7c2a2b9">More...</a><br /></td></tr>
<tr class="separator:a3b1befb4542c1bad915f2175c7c2a2b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af23f2fd022f9978f7eed5ed46f3d9fbb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#af23f2fd022f9978f7eed5ed46f3d9fbb">mrchat_is_unpromoted</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:af23f2fd022f9978f7eed5ed46f3d9fbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a chat is still unpromoted. <a href="#af23f2fd022f9978f7eed5ed46f3d9fbb">More...</a><br /></td></tr>
<tr class="separator:af23f2fd022f9978f7eed5ed46f3d9fbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12bad02bef1fb6c8003f41c72d94f54b"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b">mrchat_get_profile_image</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:a12bad02bef1fb6c8003f41c72d94f54b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the chat's profile image. <a href="#a12bad02bef1fb6c8003f41c72d94f54b">More...</a><br /></td></tr>
<tr class="separator:a12bad02bef1fb6c8003f41c72d94f54b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a187ab591ec058f4e43c1ba205bbd7503"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a187ab591ec058f4e43c1ba205bbd7503">mrchat_get_type</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:a187ab591ec058f4e43c1ba205bbd7503"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get chat type. <a href="#a187ab591ec058f4e43c1ba205bbd7503">More...</a><br /></td></tr>
<tr class="separator:a187ab591ec058f4e43c1ba205bbd7503"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a809d212fc65c445c0abc98abb4554f40"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a809d212fc65c445c0abc98abb4554f40">mrchat_get_name</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:a809d212fc65c445c0abc98abb4554f40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get name of a chat. <a href="#a809d212fc65c445c0abc98abb4554f40">More...</a><br /></td></tr>
<tr class="separator:a809d212fc65c445c0abc98abb4554f40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1e9920618c9f6cb8ad66d5bb6962a08"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08">mrchat_get_subtitle</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:ae1e9920618c9f6cb8ad66d5bb6962a08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a subtitle for a chat. <a href="#ae1e9920618c9f6cb8ad66d5bb6962a08">More...</a><br /></td></tr>
<tr class="separator:ae1e9920618c9f6cb8ad66d5bb6962a08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12bad02bef1fb6c8003f41c72d94f54b"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b">mrchat_get_profile_image</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:a12bad02bef1fb6c8003f41c72d94f54b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the chat's profile image. <a href="#a12bad02bef1fb6c8003f41c72d94f54b">More...</a><br /></td></tr>
<tr class="separator:a12bad02bef1fb6c8003f41c72d94f54b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a432be926badecf1d50bafa06da988d6e"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a432be926badecf1d50bafa06da988d6e">mrchat_get_draft</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:a432be926badecf1d50bafa06da988d6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get draft for the chat, if any. <a href="#a432be926badecf1d50bafa06da988d6e">More...</a><br /></td></tr>
<tr class="separator:a432be926badecf1d50bafa06da988d6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc61e5404ffdc000b79e333b7cd8480a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#acc61e5404ffdc000b79e333b7cd8480a">mrchat_get_archived</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:acc61e5404ffdc000b79e333b7cd8480a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get archived state. <a href="#acc61e5404ffdc000b79e333b7cd8480a">More...</a><br /></td></tr>
<tr class="separator:acc61e5404ffdc000b79e333b7cd8480a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af23f2fd022f9978f7eed5ed46f3d9fbb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#af23f2fd022f9978f7eed5ed46f3d9fbb">mrchat_is_unpromoted</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:af23f2fd022f9978f7eed5ed46f3d9fbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a chat is still unpromoted. <a href="#af23f2fd022f9978f7eed5ed46f3d9fbb">More...</a><br /></td></tr>
<tr class="separator:af23f2fd022f9978f7eed5ed46f3d9fbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a1591431716413350eaffce0b588e4911"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a1591431716413350eaffce0b588e4911">m_id</a></td></tr>
<tr class="memdesc:a1591431716413350eaffce0b588e4911"><td class="mdescLeft">&#160;</td><td class="mdescRight">Chat ID under which the chat is filed in the database. <a href="#a1591431716413350eaffce0b588e4911">More...</a><br /></td></tr>
<tr class="separator:a1591431716413350eaffce0b588e4911"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a568c4e6fb9633ffe9a76428db16e0201"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a568c4e6fb9633ffe9a76428db16e0201">m_type</a></td></tr>
<tr class="memdesc:a568c4e6fb9633ffe9a76428db16e0201"><td class="mdescLeft">&#160;</td><td class="mdescRight">Chat type. <a href="#a568c4e6fb9633ffe9a76428db16e0201">More...</a><br /></td></tr>
<tr class="separator:a568c4e6fb9633ffe9a76428db16e0201"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbd344d8d361a1a4d14bfc9b5dc57140"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140">m_name</a></td></tr>
<tr class="memdesc:abbd344d8d361a1a4d14bfc9b5dc57140"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the chat. <a href="#abbd344d8d361a1a4d14bfc9b5dc57140">More...</a><br /></td></tr>
<tr class="separator:abbd344d8d361a1a4d14bfc9b5dc57140"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a565101f53278f5ab1ff58317ffc9555c"><td class="memItemLeft" align="right" valign="top">time_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a565101f53278f5ab1ff58317ffc9555c">m_draft_timestamp</a></td></tr>
<tr class="memdesc:a565101f53278f5ab1ff58317ffc9555c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timestamp of the draft. <a href="#a565101f53278f5ab1ff58317ffc9555c">More...</a><br /></td></tr>
<tr class="separator:a565101f53278f5ab1ff58317ffc9555c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe916f48ac83c2ca6476312eae084cfa"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#abe916f48ac83c2ca6476312eae084cfa">m_draft_text</a></td></tr>
<tr class="memdesc:abe916f48ac83c2ca6476312eae084cfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">The draft text. <a href="#abe916f48ac83c2ca6476312eae084cfa">More...</a><br /></td></tr>
<tr class="separator:abe916f48ac83c2ca6476312eae084cfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b28b343ceb290d4a613d0e5a7d528bc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a5b28b343ceb290d4a613d0e5a7d528bc">m_archived</a></td></tr>
<tr class="memdesc:a5b28b343ceb290d4a613d0e5a7d528bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag for the archived state. <a href="#a5b28b343ceb290d4a613d0e5a7d528bc">More...</a><br /></td></tr>
<tr class="separator:a5b28b343ceb290d4a613d0e5a7d528bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An object representing a single chat in memory. </p>
@ -160,12 +157,12 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a class="anchor" id="af23f2fd022f9978f7eed5ed46f3d9fbb"></a>
<a class="anchor" id="a187ab591ec058f4e43c1ba205bbd7503"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrchat_is_unpromoted </td>
<td class="memname">int mrchat_get_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrchat__t.html">mrchat_t</a> *&#160;</td>
<td class="paramname"><em>chat</em></td><td>)</td>
@ -174,16 +171,74 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Check if a chat is still unpromoted. </p>
<p>Chats are unpromoted until the first message is sent. With unpromoted chats, members can be sent, settings can be modified without the need of special status messages being sent.</p>
<p>After the creation with <a class="el" href="structmrmailbox__t.html#a47156db87107ec208d6637f460d897a8" title="Create a new group chat. ">mrmailbox_create_group_chat()</a> the chat is usuall unpromoted until the first call to mrmailbox_send_msg() or <a class="el" href="structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b" title="Send a simple text message a given chat. ">mrmailbox_send_text_msg()</a>.</p>
<p>Get chat type. </p>
<p>Currently, there are two chat types:</p>
<ul>
<li>MR_CHAT_TYPE_NORMAL (100) - a normal chat is a chat with a single contact, chats_contacts contains one record for the user, MR_CONTACT_ID_SELF (see <a class="el" href="structmrcontact__t.html#ab2ee31297c327e04ed14673adbd49716" title="The contact ID. ">mrcontact_t::m_id</a>) is not added.</li>
<li>MR_CHAT_TYPE_GROUP (120) - a group chat, chats_contacts conain all group members, incl. MR_CONTACT_ID_SELF</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chat</td><td>The chat object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1=chat is still unpromoted, no message was ever send to the chat, 0=chat is not unpromoted, messages were send and/or received </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Chat type. </dd></dl>
</div>
</div>
<a class="anchor" id="a809d212fc65c445c0abc98abb4554f40"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrchat_get_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrchat__t.html">mrchat_t</a> *&#160;</td>
<td class="paramname"><em>chat</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get name of a chat. </p>
<p>For one-to-one chats, this is the name of the contact. For group chats, this is the name given eg. to <a class="el" href="structmrmailbox__t.html#a47156db87107ec208d6637f460d897a8" title="Create a new group chat. ">mrmailbox_create_group_chat()</a> or received by a group-creation message.</p>
<p>To change the name, use <a class="el" href="structmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1" title="Set group name. ">mrmailbox_set_chat_name()</a></p>
<p>See also: <a class="el" href="structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08" title="Get a subtitle for a chat. ">mrchat_get_subtitle()</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chat</td><td>The chat object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Chat name as a string. Must be free()'d after usage. Never NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="ae1e9920618c9f6cb8ad66d5bb6962a08"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrchat_get_subtitle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrchat__t.html">mrchat_t</a> *&#160;</td>
<td class="paramname"><em>chat</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a subtitle for a chat. </p>
<p>The subtitle is eg. the email-address or the number of group members.</p>
<p>See also: <a class="el" href="structmrchat__t.html#a809d212fc65c445c0abc98abb4554f40" title="Get name of a chat. ">mrchat_get_name()</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chat</td><td>The chat object to calulate the subtitle for.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Subtitle as a string. Must be free()'d after usage. Never NULL. </dd></dl>
</div>
</div>
@ -213,12 +268,12 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a class="anchor" id="ae1e9920618c9f6cb8ad66d5bb6962a08"></a>
<a class="anchor" id="a432be926badecf1d50bafa06da988d6e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrchat_get_subtitle </td>
<td class="memname">char * mrchat_get_draft </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrchat__t.html">mrchat_t</a> *&#160;</td>
<td class="paramname"><em>chat</em></td><td>)</td>
@ -227,15 +282,74 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Get a subtitle for a chat. </p>
<p>The subtitle is eg. the email-address or the number of group members.</p>
<p>Get draft for the chat, if any. </p>
<p>A draft is a message that the user started to compose but that is not send yet. You can save a draft for a chat using <a class="el" href="structmrmailbox__t.html#af50446c1a5e504d27fe29de9e3b8edc3" title="Save a draft for a chat. ">mrmailbox_set_draft()</a>.</p>
<p>Drafts are considered when sorting messages and are also returned eg. by <a class="el" href="structmrchatlist__t.html#a7bb0e80673ca253c7cb71ae6b9d4fa97" title="Get a summary for a chatlist index. ">mrchatlist_get_summary()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chat</td><td>The chat object to calulate the subtitle for.</td></tr>
<tr><td class="paramname">chat</td><td>The chat object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Subtitle as a string. Must be free()'d after usage. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Draft text, must be free()'d. Returns NULL if there is no draft. </dd></dl>
</div>
</div>
<a class="anchor" id="acc61e5404ffdc000b79e333b7cd8480a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrchat_get_archived </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrchat__t.html">mrchat_t</a> *&#160;</td>
<td class="paramname"><em>chat</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get archived state. </p>
<ul>
<li>0 = normal chat, not archived, not sticky.</li>
<li>1 = chat archived</li>
<li>2 = chat sticky (reserved for future use, if you do not support this value, just treat the chat as a normal one)</li>
</ul>
<p>To archive or unarchive chats, use <a class="el" href="structmrmailbox__t.html#a8e04e43dacbe3128afd71e1d6c1b0911" title="Archive or unarchive a chat. ">mrmailbox_archive_chat()</a>. If chats are archived, this should be shown in the UI by a little icon or text, eg. the search will also return archived chats.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chat</td><td>The chat object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Archived state. </dd></dl>
</div>
</div>
<a class="anchor" id="af23f2fd022f9978f7eed5ed46f3d9fbb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrchat_is_unpromoted </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrchat__t.html">mrchat_t</a> *&#160;</td>
<td class="paramname"><em>chat</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a chat is still unpromoted. </p>
<p>Chats are unpromoted until the first message is sent. With unpromoted chats, members can be sent, settings can be modified without the need of special status messages being sent.</p>
<p>After the creation with <a class="el" href="structmrmailbox__t.html#a47156db87107ec208d6637f460d897a8" title="Create a new group chat. ">mrmailbox_create_group_chat()</a> the chat is usuall unpromoted until the first call to mrmailbox_send_msg() or <a class="el" href="structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b" title="Send a simple text message a given chat. ">mrmailbox_send_text_msg()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chat</td><td>The chat object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1=chat is still unpromoted, no message was ever send to the chat, 0=chat is not unpromoted, messages were send and/or received </dd></dl>
</div>
</div>
@ -258,92 +372,6 @@ Public Attributes</h2></td></tr>
</ul>
<p>"Normal" chat IDs are larger than these special IDs (larger than MR_CHAT_ID_LAST_SPECIAL). </p>
</div>
</div>
<a class="anchor" id="a568c4e6fb9633ffe9a76428db16e0201"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrchat_t::m_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Chat type. </p>
<ul>
<li>MR_CHAT_TYPE_NORMAL (100) - a normal chat is a chat with a single contact, chats_contacts contains one record for the user, MR_CONTACT_ID_SELF (see <a class="el" href="structmrcontact__t.html#ab2ee31297c327e04ed14673adbd49716" title="The contact ID. ">mrcontact_t::m_id</a>) is not added.</li>
<li>MR_CHAT_TYPE_GROUP (120) - a group chat, chats_contacts conain all group members, incl. MR_CONTACT_ID_SELF</li>
</ul>
<p>If the chat type is not set, it is MR_CHAT_TYPE_UNDEFINED (0). </p>
</div>
</div>
<a class="anchor" id="abbd344d8d361a1a4d14bfc9b5dc57140"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrchat_t::m_name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of the chat. </p>
<p>For one-to-one chats, this is the name of the contact. For group chats, this is the name given eg. to <a class="el" href="structmrmailbox__t.html#a47156db87107ec208d6637f460d897a8" title="Create a new group chat. ">mrmailbox_create_group_chat()</a> or received by a group-creation message.</p>
<p>To change the name, use <a class="el" href="structmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1" title="Set group name. ">mrmailbox_set_chat_name()</a></p>
<p>NULL if unset. </p>
</div>
</div>
<a class="anchor" id="a565101f53278f5ab1ff58317ffc9555c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">time_t mrchat_t::m_draft_timestamp</td>
</tr>
</table>
</div><div class="memdoc">
<p>Timestamp of the draft. </p>
<p>The draft itself is placed in <a class="el" href="structmrchat__t.html#abe916f48ac83c2ca6476312eae084cfa" title="The draft text. ">mrchat_t::m_draft_text</a>. To save a draft for a chat, use <a class="el" href="structmrmailbox__t.html#af50446c1a5e504d27fe29de9e3b8edc3" title="Save a draft for a chat. ">mrmailbox_set_draft()</a></p>
<p>0 if there is no draft. </p>
</div>
</div>
<a class="anchor" id="abe916f48ac83c2ca6476312eae084cfa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrchat_t::m_draft_text</td>
</tr>
</table>
</div><div class="memdoc">
<p>The draft text. </p>
<p>The timetamp of the draft is placed in <a class="el" href="structmrchat__t.html#a565101f53278f5ab1ff58317ffc9555c" title="Timestamp of the draft. ">mrchat_t::m_draft_timestamp</a>. To save a draft for a chat, use <a class="el" href="structmrmailbox__t.html#af50446c1a5e504d27fe29de9e3b8edc3" title="Save a draft for a chat. ">mrmailbox_set_draft()</a></p>
<p>NULL if there is no draft. </p>
</div>
</div>
<a class="anchor" id="a5b28b343ceb290d4a613d0e5a7d528bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrchat_t::m_archived</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag for the archived state. </p>
<p>0=normal chat, not archived, not sticky.</p>
<p>1=chat archived</p>
<p>2=chat sticky (reserved for future use, if you do not support this value, just treat the chat as a normal one)</p>
<p>To archive or unarchive chats, use <a class="el" href="structmrmailbox__t.html#a8e04e43dacbe3128afd71e1d6c1b0911" title="Archive or unarchive a chat. ">mrmailbox_archive_chat()</a>. If chats are archived, this should be shown in the UI by a little icon or text, eg. the search will also return archived chats. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>