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

Update doxygen.

Browse source
This commit is contained in:
B. Petersen 2017-11-14 21:51:11 +01:00
parent 939bd71cee
commit c3129c89ce
10 changed files with 194 additions and 60 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/html/mrchat_8h_source.html
View file

File diff suppressed because one or more lines are too long

12
docs/html/mrcontact_8h_source.html
View file

File diff suppressed because one or more lines are too long

97
docs/html/mrevent_8h.html
View file

@ -109,19 +109,16 @@ Macros</h2></td></tr>
<tr class="memdesc:a7088b24d6d49fee42d6b83360bf1fcca"><td class="mdescLeft">&#160;</td><td class="mdescRight">The user should show an error. <a href="#a7088b24d6d49fee42d6b83360bf1fcca">More...</a><br /></td></tr>
<tr class="separator:a7088b24d6d49fee42d6b83360bf1fcca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17eaeb107cbab46c0d9271d0b5560fc8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a17eaeb107cbab46c0d9271d0b5560fc8">MR_EVENT_MSGS_CHANGED</a>&#160;&#160;&#160;2000</td></tr>
<tr class="memdesc:a17eaeb107cbab46c0d9271d0b5560fc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">one or more messages changed for some reasons in the database - added or removed. <a href="#a17eaeb107cbab46c0d9271d0b5560fc8">More...</a><br /></td></tr>
<tr class="memdesc:a17eaeb107cbab46c0d9271d0b5560fc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">One or more messages changed for some reasons in the database. <a href="#a17eaeb107cbab46c0d9271d0b5560fc8">More...</a><br /></td></tr>
<tr class="separator:a17eaeb107cbab46c0d9271d0b5560fc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a548525a9d4cc03cd240ca6dda4246ae8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a548525a9d4cc03cd240ca6dda4246ae8"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a548525a9d4cc03cd240ca6dda4246ae8">MR_EVENT_INCOMING_MSG</a>&#160;&#160;&#160;2005</td></tr>
<tr class="memdesc:a548525a9d4cc03cd240ca6dda4246ae8"><td class="mdescLeft">&#160;</td><td class="mdescRight">For fresh messages from the INBOX, MR_EVENT_INCOMING_MSG is send; data1=chat_id, data2=msg_id. <br /></td></tr>
<tr class="memitem:a548525a9d4cc03cd240ca6dda4246ae8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a548525a9d4cc03cd240ca6dda4246ae8">MR_EVENT_INCOMING_MSG</a>&#160;&#160;&#160;2005</td></tr>
<tr class="memdesc:a548525a9d4cc03cd240ca6dda4246ae8"><td class="mdescLeft">&#160;</td><td class="mdescRight">There is a fresh message. <a href="#a548525a9d4cc03cd240ca6dda4246ae8">More...</a><br /></td></tr>
<tr class="separator:a548525a9d4cc03cd240ca6dda4246ae8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10c4a8b6fa9014e5725e3a1daadf301b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10c4a8b6fa9014e5725e3a1daadf301b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a10c4a8b6fa9014e5725e3a1daadf301b">MR_EVENT_MSG_DELIVERED</a>&#160;&#160;&#160;2010</td></tr>
<tr class="memdesc:a10c4a8b6fa9014e5725e3a1daadf301b"><td class="mdescLeft">&#160;</td><td class="mdescRight">a single message is send successfully (state changed from PENDING/SENDING to DELIVERED); data1=chat_id, data2=msg_id <br /></td></tr>
<tr class="memitem:a10c4a8b6fa9014e5725e3a1daadf301b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a10c4a8b6fa9014e5725e3a1daadf301b">MR_EVENT_MSG_DELIVERED</a>&#160;&#160;&#160;2010</td></tr>
<tr class="memdesc:a10c4a8b6fa9014e5725e3a1daadf301b"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single message is send successfully (state changed from MR_STATE_OUT_PENDING to MR_STATE_OUT_DELIVERED, see <a class="el" href="structmrmsg__t.html#aca59d28054d3e15b4fe6ca74073d91f4" title="Message state. ">mrmsg_t::m_state</a>). <a href="#a10c4a8b6fa9014e5725e3a1daadf301b">More...</a><br /></td></tr>
<tr class="separator:a10c4a8b6fa9014e5725e3a1daadf301b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a080965cf1f3dd138999c56ec30580b58"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a080965cf1f3dd138999c56ec30580b58"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a080965cf1f3dd138999c56ec30580b58">MR_EVENT_MSG_READ</a>&#160;&#160;&#160;2015</td></tr>
<tr class="memdesc:a080965cf1f3dd138999c56ec30580b58"><td class="mdescLeft">&#160;</td><td class="mdescRight">a single message is read by the receiver (state changed from DELIVERED to READ); data1=chat_id, data2=msg_id <br /></td></tr>
<tr class="memitem:a080965cf1f3dd138999c56ec30580b58"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a080965cf1f3dd138999c56ec30580b58">MR_EVENT_MSG_READ</a>&#160;&#160;&#160;2015</td></tr>
<tr class="memdesc:a080965cf1f3dd138999c56ec30580b58"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single message is read by the receiver (state changed from MR_STATE_OUT_DELIVERED to MR_STATE_OUT_MDN_RCVD, see <a class="el" href="structmrmsg__t.html#aca59d28054d3e15b4fe6ca74073d91f4" title="Message state. ">mrmsg_t::m_state</a>). <a href="#a080965cf1f3dd138999c56ec30580b58">More...</a><br /></td></tr>
<tr class="separator:a080965cf1f3dd138999c56ec30580b58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ac741b81ec97628f44795600c0e4d4c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ac741b81ec97628f44795600c0e4d4c"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a5ac741b81ec97628f44795600c0e4d4c">MR_EVENT_CHAT_MODIFIED</a>&#160;&#160;&#160;2020</td></tr>
@ -209,6 +206,28 @@ Macros</h2></td></tr>
<p>file written, event may be needed to make the file public to some system services. </p>
<p>data1=file name, data2=mime type </p>
</div>
</div>
<a class="anchor" id="a548525a9d4cc03cd240ca6dda4246ae8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_INCOMING_MSG&#160;&#160;&#160;2005</td>
</tr>
</table>
</div><div class="memdoc">
<p>There is a fresh message. </p>
<p>Typically, the user will show an notification when receiving this message. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>chat_id </td></tr>
<tr><td class="paramname">data2</td><td>msg_id </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="abc46d188d1a1a25c92433aa05568e23b"></a>
@ -231,6 +250,50 @@ Macros</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="a10c4a8b6fa9014e5725e3a1daadf301b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_MSG_DELIVERED&#160;&#160;&#160;2010</td>
</tr>
</table>
</div><div class="memdoc">
<p>A single message is send successfully (state changed from MR_STATE_OUT_PENDING to MR_STATE_OUT_DELIVERED, see <a class="el" href="structmrmsg__t.html#aca59d28054d3e15b4fe6ca74073d91f4" title="Message state. ">mrmsg_t::m_state</a>). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>chat_id </td></tr>
<tr><td class="paramname">data2</td><td>msg_id </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="a080965cf1f3dd138999c56ec30580b58"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_MSG_READ&#160;&#160;&#160;2015</td>
</tr>
</table>
</div><div class="memdoc">
<p>A single message is read by the receiver (state changed from MR_STATE_OUT_DELIVERED to MR_STATE_OUT_MDN_RCVD, see <a class="el" href="structmrmsg__t.html#aca59d28054d3e15b4fe6ca74073d91f4" title="Message state. ">mrmsg_t::m_state</a>). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>chat_id </td></tr>
<tr><td class="paramname">data2</td><td>msg_id </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="a17eaeb107cbab46c0d9271d0b5560fc8"></a>
@ -243,8 +306,16 @@ Macros</h2></td></tr>
</table>
</div><div class="memdoc">
<p>one or more messages changed for some reasons in the database - added or removed. </p>
<p>For added messages: data1=chat_id, data2=msg_id </p>
<p>One or more messages changed for some reasons in the database. </p>
<p>Messages may be added or removed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>chat_id for single added messages </td></tr>
<tr><td class="paramname">data2</td><td>msg_id for single added messages </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
@ -262,7 +333,7 @@ Macros</h2></td></tr>
<p>Passed to the callback given to <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>. This event should not be reported using a popup or something like that. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>0 </td></tr>
<tr><td class="paramname">data2</td><td>Info string </td></tr>
<tr><td class="paramname">data2</td><td>Warning string </td></tr>
</table>
</dd>
</dl>

2
docs/html/mrevent_8h_source.html
View file

File diff suppressed because one or more lines are too long

10
docs/html/mrmailbox_8h_source.html
View file

File diff suppressed because one or more lines are too long

18
docs/html/mrmsg_8h_source.html
View file

File diff suppressed because one or more lines are too long

19
docs/html/structmrchat__t.html
View file

@ -110,10 +110,10 @@ Public Member Functions</h2></td></tr>
<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 this object is available in the database. <a href="#a1591431716413350eaffce0b588e4911">More...</a><br /></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, one of the MR_CHAT_TYPE_* constants. <a href="#a568c4e6fb9633ffe9a76428db16e0201">More...</a><br /></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"><a class="anchor" id="abbd344d8d361a1a4d14bfc9b5dc57140"></a>
char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140">m_name</a></td></tr>
@ -245,7 +245,13 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>Chat ID under which this object is available in the database. </p>
<p>Chat ID under which the chat is filed in the database. </p>
<p>Special IDs:</p><ul>
<li>MR_CHAT_ID_DEADDROP (1) - Messages send from unknown/unwanted users to us, chats_contacts is not set up. This group may be shown normally.</li>
<li>MR_CHAT_ID_STARRED (5) - Virtual chat containing all starred messages-</li>
<li>MR_CHAT_ID_ARCHIVED_LINK (6) - A link at the end of the chatlist, if present the UI should show the button "Archived chats"-</li>
</ul>
<p>"Normal" chat IDs are larger than these special IDs (larger than MR_CHAT_ID_LAST_SPECIAL). </p>
</div>
</div>
@ -259,7 +265,12 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>Chat type, one of the MR_CHAT_TYPE_* constants. </p>
<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>

23
docs/html/structmrcontact__t.html
View file

@ -118,9 +118,8 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stru
</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:ab2ee31297c327e04ed14673adbd49716"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2ee31297c327e04ed14673adbd49716"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#ab2ee31297c327e04ed14673adbd49716">m_id</a></td></tr>
<tr class="memdesc:ab2ee31297c327e04ed14673adbd49716"><td class="mdescLeft">&#160;</td><td class="mdescRight">The contact ID. <br /></td></tr>
<tr class="memitem:ab2ee31297c327e04ed14673adbd49716"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#ab2ee31297c327e04ed14673adbd49716">m_id</a></td></tr>
<tr class="memdesc:ab2ee31297c327e04ed14673adbd49716"><td class="mdescLeft">&#160;</td><td class="mdescRight">The contact ID. <a href="#ab2ee31297c327e04ed14673adbd49716">More...</a><br /></td></tr>
<tr class="separator:ab2ee31297c327e04ed14673adbd49716"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48fba862b41f7da3b8c6193c0554654b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48fba862b41f7da3b8c6193c0554654b"></a>
char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b">m_name</a></td></tr>
@ -226,6 +225,24 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
<p>Blocked state. </p>
<p>1=contact is blocked, 0=contact is not blocked. </p>
</div>
</div>
<a class="anchor" id="ab2ee31297c327e04ed14673adbd49716"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t mrcontact_t::m_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>The contact ID. </p>
<p>Special message IDs:</p><ul>
<li>MR_CONTACT_ID_SELF (1) - this is the owner of the mailbox with the email-address set by <a class="el" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad" title="Configure the mailbox. ">mrmailbox_set_config()</a> using "addr".</li>
</ul>
<p>Normal contact IDs are larger than these special ones (larger than MR_CONTACT_ID_LAST_SPECIAL). </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>

4
docs/html/structmrmailbox__t.html
View file

@ -2315,7 +2315,7 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</div><div class="memdoc">
<p>save message in database and send it, the given message object is not unref'd by the function but some fields are set up! </p>
<p>Sends the event <a class="el" href="mrevent_8h.html#a17eaeb107cbab46c0d9271d0b5560fc8" title="one or more messages changed for some reasons in the database - added or removed. ...">MR_EVENT_MSGS_CHANGED</a> on succcess. However, this does not imply, the message really reached the recipient - sending may be delayed eg. due to network problems. However, from your view, you're done with the message. Sooner or later it will find its way.</p>
<p>Sends 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> on succcess. However, this does not imply, the message really reached the recipient - sending may be delayed eg. due to network problems. However, from your view, you're done with the message. Sooner or later it will find its way.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailbox</td><td>The mailbox object as returned from <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>.</td></tr>
@ -2359,7 +2359,7 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</div><div class="memdoc">
<p>Send a simple text message to the given chat. </p>
<p>Sends the event <a class="el" href="mrevent_8h.html#a17eaeb107cbab46c0d9271d0b5560fc8" title="one or more messages changed for some reasons in the database - added or removed. ...">MR_EVENT_MSGS_CHANGED</a> on succcess. However, this does not imply, the message really reached the recipient - sending may be delayed eg. due to network problems. However, from your view, you're done with the message. Sooner or later it will find its way.</p>
<p>Sends 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> on succcess. However, this does not imply, the message really reached the recipient - sending may be delayed eg. due to network problems. However, from your view, you're done with the message. Sooner or later it will find its way.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailbox</td><td>The mailbox object as returned from <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>.</td></tr>

53
docs/html/structmrmsg__t.html
View file

@ -135,7 +135,7 @@ Public Attributes</h2></td></tr>
<tr class="memdesc:a299981cb89b25ebaaedf7a8486a86ee6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contact ID of the sender. <a href="#a299981cb89b25ebaaedf7a8486a86ee6">More...</a><br /></td></tr>
<tr class="separator:a299981cb89b25ebaaedf7a8486a86ee6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad549fc02587ba284fda2bbecd162b16a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#ad549fc02587ba284fda2bbecd162b16a">m_to_id</a></td></tr>
<tr class="memdesc:ad549fc02587ba284fda2bbecd162b16a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contact ID of the receiver, if appropriate. <a href="#ad549fc02587ba284fda2bbecd162b16a">More...</a><br /></td></tr>
<tr class="memdesc:ad549fc02587ba284fda2bbecd162b16a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contact ID of the recipient. <a href="#ad549fc02587ba284fda2bbecd162b16a">More...</a><br /></td></tr>
<tr class="separator:ad549fc02587ba284fda2bbecd162b16a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac19bdc40e452c8997dd58474a7be6880"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#ac19bdc40e452c8997dd58474a7be6880">m_chat_id</a></td></tr>
<tr class="memdesc:ac19bdc40e452c8997dd58474a7be6880"><td class="mdescLeft">&#160;</td><td class="mdescRight">Chat ID the message belongs to. <a href="#ac19bdc40e452c8997dd58474a7be6880">More...</a><br /></td></tr>
@ -144,17 +144,17 @@ Public Attributes</h2></td></tr>
<tr class="memdesc:aba09cb77cdabd1e2b2e6262d25388801"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unix time the message was sended or received. <a href="#aba09cb77cdabd1e2b2e6262d25388801">More...</a><br /></td></tr>
<tr class="separator:aba09cb77cdabd1e2b2e6262d25388801"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3896e269c90cbf0f563ab0848fb44c65"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a3896e269c90cbf0f563ab0848fb44c65">m_type</a></td></tr>
<tr class="memdesc:a3896e269c90cbf0f563ab0848fb44c65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Message type as one of the MR_MSG_* contstants. <a href="#a3896e269c90cbf0f563ab0848fb44c65">More...</a><br /></td></tr>
<tr class="memdesc:a3896e269c90cbf0f563ab0848fb44c65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of the message. <a href="#a3896e269c90cbf0f563ab0848fb44c65">More...</a><br /></td></tr>
<tr class="separator:a3896e269c90cbf0f563ab0848fb44c65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca59d28054d3e15b4fe6ca74073d91f4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#aca59d28054d3e15b4fe6ca74073d91f4">m_state</a></td></tr>
<tr class="memdesc:aca59d28054d3e15b4fe6ca74073d91f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Message state as one of the MR_MSG_STATE_* contstants. <a href="#aca59d28054d3e15b4fe6ca74073d91f4">More...</a><br /></td></tr>
<tr class="memdesc:aca59d28054d3e15b4fe6ca74073d91f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Message state. <a href="#aca59d28054d3e15b4fe6ca74073d91f4">More...</a><br /></td></tr>
<tr class="separator:aca59d28054d3e15b4fe6ca74073d91f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae54dcd4036371597d7f8bbd75303527a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae54dcd4036371597d7f8bbd75303527a"></a>
char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#ae54dcd4036371597d7f8bbd75303527a">m_text</a></td></tr>
<tr class="memdesc:ae54dcd4036371597d7f8bbd75303527a"><td class="mdescLeft">&#160;</td><td class="mdescRight">message text or NULL if unset <br /></td></tr>
<tr class="separator:ae54dcd4036371597d7f8bbd75303527a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c31ec5b23e35fbe3ae3896eece09453"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrparam__t.html">mrparam_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453">m_param</a></td></tr>
<tr class="memdesc:a2c31ec5b23e35fbe3ae3896eece09453"><td class="mdescLeft">&#160;</td><td class="mdescRight">MRP_FILE, MRP_WIDTH, MRP_HEIGHT etc. <a href="#a2c31ec5b23e35fbe3ae3896eece09453">More...</a><br /></td></tr>
<tr class="memdesc:a2c31ec5b23e35fbe3ae3896eece09453"><td class="mdescLeft">&#160;</td><td class="mdescRight">Additional paramter for the message. <a href="#a2c31ec5b23e35fbe3ae3896eece09453">More...</a><br /></td></tr>
<tr class="separator:a2c31ec5b23e35fbe3ae3896eece09453"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0570bbfc3add48dafb0ae70390b47adb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a0570bbfc3add48dafb0ae70390b47adb">m_starred</a></td></tr>
<tr class="memdesc:a0570bbfc3add48dafb0ae70390b47adb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starred-state of the message. <a href="#a0570bbfc3add48dafb0ae70390b47adb">More...</a><br /></td></tr>
@ -396,7 +396,7 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</div><div class="memdoc">
<p>Chat ID the message belongs to. </p>
<p>0=unset, 1=unknwon sender .. &gt;9=real chats </p>
<p>0 if unset. See <a class="el" href="structmrchat__t.html#a1591431716413350eaffce0b588e4911" title="Chat ID under which the chat is filed in the database. ">mrchat_t::m_id</a> for special IDs. Use <a class="el" href="structmrmailbox__t.html#ad106b9c23b3a559b524a37bb5504e096" title="Get a chat object of type mrchat_t by a chat_id. ">mrmailbox_get_chat()</a> to load details about the chat. </p>
</div>
</div>
@ -411,7 +411,7 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</div><div class="memdoc">
<p>Contact ID of the sender. </p>
<p>0=unset, 1=self .. &gt;9=real contacts </p>
<p>0 if unset. See <a class="el" href="structmrcontact__t.html#ab2ee31297c327e04ed14673adbd49716" title="The contact ID. ">mrcontact_t::m_id</a> for special IDs. Use <a class="el" href="structmrmailbox__t.html#a057660d94350ff98eca72785c6e88962" title="Get a single contact object. ">mrmailbox_get_contact()</a> to load details about this contact. </p>
</div>
</div>
@ -426,6 +426,12 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</div><div class="memdoc">
<p>Message ID. </p>
<p>Special message IDs:</p>
<ul>
<li>MR_MSG_ID_MARKER1 (1) - any user-defined marker, see <a class="el" href="structmrmailbox__t.html#a5d3be6ed21d43cc93f250a1e7faf979b" title="Get all message IDs belonging to a chat. ">mrmailbox_get_chat_msgs()</a></li>
<li>MR_MSG_ID_DAYMARKER (9) - in a list, the next message is on a new day, useful to show headlines, see <a class="el" href="structmrmailbox__t.html#a5d3be6ed21d43cc93f250a1e7faf979b" title="Get all message IDs belonging to a chat. ">mrmailbox_get_chat_msgs()</a></li>
</ul>
<p>Normal message IDs are larger than these special ones. </p>
</div>
</div>
@ -454,8 +460,8 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>MRP_FILE, MRP_WIDTH, MRP_HEIGHT etc. </p>
<p>depends on the type, != NULL </p>
<p>Additional paramter for the message. </p>
<p>MRP_FILE, MRP_WIDTH, MRP_HEIGHT etc. depends on <a class="el" href="structmrmsg__t.html#a3896e269c90cbf0f563ab0848fb44c65" title="Type of the message. ">m_type</a>. Never a NULL-pointer. </p>
</div>
</div>
@ -484,7 +490,19 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>Message state as one of the MR_MSG_STATE_* contstants. </p>
<p>Message state. </p>
<p>Incoming message states:</p><ul>
<li>MR_STATE_IN_FRESH (10) - Incoming <em>fresh</em> message. Fresh messages are not noticed nor seen and are typically shown in notifications. Use <a class="el" href="structmrmailbox__t.html#adbdcde6475db0cfafd8aa127b5bd1bc1" title="Returns the message IDs of all fresh messages of any chat. ">mrmailbox_get_fresh_msgs()</a> to get all fresh messages.</li>
<li>MR_STATE_IN_NOTICED (13) - Incoming <em>noticed</em> message. Eg. chat opened but message not yet read - noticed messages are not counted as unread but did not marked as read nor resulted in MDNs. Use <a class="el" href="structmrmailbox__t.html#a07cc8fe0cfd900a9449bffc4ca5a7a95" title="Mark all message in a chat as noticed. ">mrmailbox_marknoticed_chat()</a> or <a class="el" href="structmrmailbox__t.html#a7150c575193d43e048689aa264c74c79" title="Mark all messages send by the given contact as noticed. ">mrmailbox_marknoticed_contact()</a> to mark messages as being noticed.</li>
<li>MR_STATE_IN_SEEN (16) - Incoming message, really <em>seen</em> by the user. Marked as read on IMAP and MDN may be send. Use <a class="el" href="structmrmailbox__t.html#a67281e50b568dc18df710275e0e13f5b" title="Mark a message as seen, updates the IMAP state and sends MDNs. ">mrmailbox_markseen_msgs()</a> to mark messages as being seen.</li>
</ul>
<p>Outgoing message states:</p><ul>
<li>MR_STATE_OUT_PENDING (20) - The user has send the "send" button but the message is not yet sent and is pending in some way. Maybe we're offline (no checkmark).</li>
<li>MR_STATE_OUT_ERROR (24) - <em>Unrecoverable</em> error (<em>recoverable</em> errors result in pending messages)</li>
<li>MR_STATE_OUT_DELIVERED (26) - Outgoing message successfully delivered to server (one checkmark). Note, that already delivered messages may get into the state MR_STATE_OUT_ERROR if we get such a hint from the server. If a sent message changes to this state, you'll receive the event <a class="el" href="mrevent_8h.html#a10c4a8b6fa9014e5725e3a1daadf301b" title="A single message is send successfully (state changed from MR_STATE_OUT_PENDING to MR_STATE_OUT_DELIVE...">MR_EVENT_MSG_DELIVERED</a>.</li>
<li>MR_STATE_OUT_MDN_RCVD (28) - Outgoing message read by the recipient (two checkmarks; this requires goodwill on the receiver's side) If a sent message changes to this state, you'll receive the event <a class="el" href="mrevent_8h.html#a080965cf1f3dd138999c56ec30580b58" title="A single message is read by the receiver (state changed from MR_STATE_OUT_DELIVERED to MR_STATE_OUT_M...">MR_EVENT_MSG_READ</a>.</li>
</ul>
<p>The state of just created message objects is MR_STATE_UNDEFINED (0). </p>
</div>
</div>
@ -499,6 +517,7 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</div><div class="memdoc">
<p>Unix time the message was sended or received. </p>
<p>0 if unset. </p>
</div>
</div>
@ -512,8 +531,8 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>Contact ID of the receiver, if appropriate. </p>
<p>0=unset, 1=self .. &gt;9=real contacts </p>
<p>Contact ID of the recipient. </p>
<p>0 if unset. See <a class="el" href="structmrcontact__t.html#ab2ee31297c327e04ed14673adbd49716" title="The contact ID. ">mrcontact_t::m_id</a> for special IDs. Use <a class="el" href="structmrmailbox__t.html#a057660d94350ff98eca72785c6e88962" title="Get a single contact object. ">mrmailbox_get_contact()</a> to load details about this contact. </p>
</div>
</div>
@ -527,7 +546,17 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>Message type as one of the MR_MSG_* contstants. </p>
<p>Type of the message. </p>
<ul>
<li>MR_MSG_TEXT (10)</li>
<li>MR_MSG_IMAGE (20) - <a class="el" href="structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453" title="Additional paramter for the message. ">m_param</a> may contain MRP_FILE, MRP_WIDTH, MRP_HEIGHT</li>
<li>MR_MSG_GIF (21) - <a class="el" href="structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453" title="Additional paramter for the message. ">m_param</a> may contain MRP_FILE, MRP_WIDTH, MRP_HEIGHT</li>
<li>MR_MSG_AUDIO (40) - <a class="el" href="structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453" title="Additional paramter for the message. ">m_param</a> may contain MRP_FILE, MRP_DURATION</li>
<li>MR_MSG_VOICE (41) - <a class="el" href="structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453" title="Additional paramter for the message. ">m_param</a> may contain MRP_FILE, MRP_DURATION</li>
<li>MR_MSG_VIDEO (50) - <a class="el" href="structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453" title="Additional paramter for the message. ">m_param</a> may contain MRP_FILE, MRP_WIDTH, MRP_HEIGHT, MRP_DURATION</li>
<li>MR_MSG_FILE (60) - <a class="el" href="structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453" title="Additional paramter for the message. ">m_param</a> may contain MRP_FILE</li>
</ul>
<p>Undefined types are filed under MR_MSG_UNDEFINED (0). </p>
</div>
</div>