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

Doxygen

Browse source
This commit is contained in:
B. Petersen 2017-11-21 23:06:56 +01:00
parent ad483990c7
commit 25f5a0ba1f
23 changed files with 2742 additions and 2446 deletions
Download patch file Download diff file Expand all files Collapse all files

30
docs/html/functions.html
View file

@ -145,8 +145,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
, <a class="el" href="structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b">mrcontact_t</a>
</li>
<li>m_param
: <a class="el" href="structmrchat__t.html#ad2792ee7df778521de61087bc79795a7">mrchat_t</a>
, <a class="el" href="structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453">mrmsg_t</a>
: <a class="el" href="structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453">mrmsg_t</a>
</li>
<li>m_starred
: <a class="el" href="structmrmsg__t.html#a0570bbfc3add48dafb0ae70390b47adb">mrmsg_t</a>
@ -190,9 +189,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrarray_unref()
: <a class="el" href="structmrarray__t.html#a1400b5e42c682326e809723f02739a8e">mrarray_t</a>
</li>
<li>mrchat_get_profile_image()
: <a class="el" href="structmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b">mrchat_t</a>
</li>
<li>mrchat_get_subtitle()
: <a class="el" href="structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08">mrchat_t</a>
</li>
<li>mrchat_get_unpromoted()
: <a class="el" href="structmrchat__t.html#abfe861b7cc247ebea854f4a15bcd1bef">mrchat_t</a>
</li>
<li>mrchat_unref()
: <a class="el" href="structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9">mrchat_t</a>
</li>
@ -211,9 +216,21 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrchatlist_unref()
: <a class="el" href="structmrchatlist__t.html#ab036d6e066b5ff78779f36711c9ab2f9">mrchatlist_t</a>
</li>
<li>mrcontact_get_addr()
: <a class="el" href="structmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971">mrcontact_t</a>
</li>
<li>mrcontact_get_display_name()
: <a class="el" href="structmrcontact__t.html#a29a93300d97183f795fc711c93fac689">mrcontact_t</a>
</li>
<li>mrcontact_get_first_name()
: <a class="el" href="structmrcontact__t.html#a804337f9c9e735a5429559b0fcb06121">mrcontact_t</a>
</li>
<li>mrcontact_get_name()
: <a class="el" href="structmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2">mrcontact_t</a>
</li>
<li>mrcontact_get_name_n_addr()
: <a class="el" href="structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2">mrcontact_t</a>
</li>
<li>mrcontact_normalize_name()
: <a class="el" href="structmrcontact__t.html#ad906207191f0cfd62e408dbc82a156cf">mrcontact_t</a>
</li>
@ -382,12 +399,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrmailbox_send_text_msg()
: <a class="el" href="structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b">mrmailbox_t</a>
</li>
<li>mrmailbox_set_chat_image()
: <a class="el" href="structmrmailbox__t.html#a2a9b27b6a2e991cbf3b553c5dbbec803">mrmailbox_t</a>
</li>
<li>mrmailbox_set_chat_name()
: <a class="el" href="structmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1">mrmailbox_t</a>
</li>
<li>mrmailbox_set_chat_profile_image()
: <a class="el" href="structmrmailbox__t.html#a08c527170681c949ddd6931a004fdd5f">mrmailbox_t</a>
</li>
<li>mrmailbox_set_config()
: <a class="el" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad">mrmailbox_t</a>
</li>
@ -412,6 +429,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrmsg_get_file()
: <a class="el" href="structmrmsg__t.html#a2544769c77af5447546fcf5fc95c64f7">mrmsg_t</a>
</li>
<li>mrmsg_get_filename()
: <a class="el" href="structmrmsg__t.html#ad0dcfc0a1e33d9a88b7381e368d7895a">mrmsg_t</a>
</li>
<li>mrmsg_get_mediainfo()
: <a class="el" href="structmrmsg__t.html#ad87b7df007489b3a47c3fde79978a58a">mrmsg_t</a>
</li>

27
docs/html/functions_func.html
View file

@ -106,9 +106,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrarray_unref()
: <a class="el" href="structmrarray__t.html#a1400b5e42c682326e809723f02739a8e">mrarray_t</a>
</li>
<li>mrchat_get_profile_image()
: <a class="el" href="structmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b">mrchat_t</a>
</li>
<li>mrchat_get_subtitle()
: <a class="el" href="structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08">mrchat_t</a>
</li>
<li>mrchat_get_unpromoted()
: <a class="el" href="structmrchat__t.html#abfe861b7cc247ebea854f4a15bcd1bef">mrchat_t</a>
</li>
<li>mrchat_unref()
: <a class="el" href="structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9">mrchat_t</a>
</li>
@ -127,9 +133,21 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrchatlist_unref()
: <a class="el" href="structmrchatlist__t.html#ab036d6e066b5ff78779f36711c9ab2f9">mrchatlist_t</a>
</li>
<li>mrcontact_get_addr()
: <a class="el" href="structmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971">mrcontact_t</a>
</li>
<li>mrcontact_get_display_name()
: <a class="el" href="structmrcontact__t.html#a29a93300d97183f795fc711c93fac689">mrcontact_t</a>
</li>
<li>mrcontact_get_first_name()
: <a class="el" href="structmrcontact__t.html#a804337f9c9e735a5429559b0fcb06121">mrcontact_t</a>
</li>
<li>mrcontact_get_name()
: <a class="el" href="structmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2">mrcontact_t</a>
</li>
<li>mrcontact_get_name_n_addr()
: <a class="el" href="structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2">mrcontact_t</a>
</li>
<li>mrcontact_normalize_name()
: <a class="el" href="structmrcontact__t.html#ad906207191f0cfd62e408dbc82a156cf">mrcontact_t</a>
</li>
@ -298,12 +316,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrmailbox_send_text_msg()
: <a class="el" href="structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b">mrmailbox_t</a>
</li>
<li>mrmailbox_set_chat_image()
: <a class="el" href="structmrmailbox__t.html#a2a9b27b6a2e991cbf3b553c5dbbec803">mrmailbox_t</a>
</li>
<li>mrmailbox_set_chat_name()
: <a class="el" href="structmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1">mrmailbox_t</a>
</li>
<li>mrmailbox_set_chat_profile_image()
: <a class="el" href="structmrmailbox__t.html#a08c527170681c949ddd6931a004fdd5f">mrmailbox_t</a>
</li>
<li>mrmailbox_set_config()
: <a class="el" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad">mrmailbox_t</a>
</li>
@ -325,6 +343,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrmsg_get_file()
: <a class="el" href="structmrmsg__t.html#a2544769c77af5447546fcf5fc95c64f7">mrmsg_t</a>
</li>
<li>mrmsg_get_filename()
: <a class="el" href="structmrmsg__t.html#ad0dcfc0a1e33d9a88b7381e368d7895a">mrmsg_t</a>
</li>
<li>mrmsg_get_mediainfo()
: <a class="el" href="structmrmsg__t.html#ad87b7df007489b3a47c3fde79978a58a">mrmsg_t</a>
</li>

3
docs/html/functions_vars.html
View file

@ -145,8 +145,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
, <a class="el" href="structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b">mrcontact_t</a>
</li>
<li>m_param
: <a class="el" href="structmrchat__t.html#ad2792ee7df778521de61087bc79795a7">mrchat_t</a>
, <a class="el" href="structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453">mrmsg_t</a>
: <a class="el" href="structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453">mrmsg_t</a>
</li>
<li>m_starred
: <a class="el" href="structmrmsg__t.html#a0570bbfc3add48dafb0ae70390b47adb">mrmsg_t</a>

7
docs/html/mrchat_8h_source.html
View file

File diff suppressed because one or more lines are too long

16
docs/html/mrcontact_8h_source.html
View file

File diff suppressed because one or more lines are too long

495
docs/html/mrevent_8h.html
View file

@ -109,7 +109,7 @@ 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. <a href="#a17eaeb107cbab46c0d9271d0b5560fc8">More...</a><br /></td></tr>
<tr class="memdesc:a17eaeb107cbab46c0d9271d0b5560fc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Messages or chats changed. <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">#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>
@ -121,7 +121,7 @@ Macros</h2></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">#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>
<tr class="memdesc:a5ac741b81ec97628f44795600c0e4d4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Group name/image changed or members added/removed. <a href="#a5ac741b81ec97628f44795600c0e4d4c">More...</a><br /></td></tr>
<tr class="memdesc:a5ac741b81ec97628f44795600c0e4d4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Group changed. <a href="#a5ac741b81ec97628f44795600c0e4d4c">More...</a><br /></td></tr>
<tr class="separator:a5ac741b81ec97628f44795600c0e4d4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad50b3a76349834631dc26b6c9557be8f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#ad50b3a76349834631dc26b6c9557be8f">MR_EVENT_CONTACTS_CHANGED</a>&#160;&#160;&#160;2030</td></tr>
<tr class="memdesc:ad50b3a76349834631dc26b6c9557be8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contact(s) created, renamed, blocked or deleted. <a href="#ad50b3a76349834631dc26b6c9557be8f">More...</a><br /></td></tr>
@ -158,65 +158,45 @@ Macros</h2></td></tr>
<div class="textblock"><p>The following constants are used as events reported to the callback given to <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>. </p>
<p>If you do not want to handle an event, it is always safe to return 0, so there is no need to add a "case" for every event. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a5ac741b81ec97628f44795600c0e4d4c"></a>
<a class="anchor" id="abc46d188d1a1a25c92433aa05568e23b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_CHAT_MODIFIED&#160;&#160;&#160;2020</td>
<td class="memname">#define MR_EVENT_INFO&#160;&#160;&#160;100</td>
</tr>
</table>
</div><div class="memdoc">
<p>Group name/image changed or members added/removed. </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>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="abb0881d4c7c887b8f371cedc471846b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_CONFIGURE_PROGRESS&#160;&#160;&#160;2041</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inform about the configuration progress started by <a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>Permille</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="ad50b3a76349834631dc26b6c9557be8f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_CONTACTS_CHANGED&#160;&#160;&#160;2030</td>
</tr>
</table>
</div><div class="memdoc">
<p>Contact(s) created, renamed, blocked or deleted. </p>
<p>The user may write an informational string to the log. </p>
<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>0</td></tr>
<tr><td class="paramname">data2</td><td>Info string</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="aa124fce3009b0cf018f49b69b76bce55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_WARNING&#160;&#160;&#160;300</td>
</tr>
</table>
</div><div class="memdoc">
<p>The user should write an warning string to the log. </p>
<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>Warning string</td></tr>
</table>
</dd>
</dl>
@ -247,135 +227,27 @@ Macros</h2></td></tr>
</div>
</div>
<a class="anchor" id="a465a35db3742af9f1a3e39b2ede585da"></a>
<a class="anchor" id="a17eaeb107cbab46c0d9271d0b5560fc8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_GET_QUANTITY_STRING&#160;&#160;&#160;2092</td>
<td class="memname">#define MR_EVENT_MSGS_CHANGED&#160;&#160;&#160;2000</td>
</tr>
</table>
</div><div class="memdoc">
<p>Requeste a localized quantitiy string from the frontend. </p>
<p>Quantitiy strings may have eg. different plural forms and usually also include the count itself to the string. Typical strings in this form are "1 Message" vs. "2 Messages".</p>
<p>Messages or chats changed. </p>
<p>One or more messages or chats changed for various reasons in the database:</p><ul>
<li>Messages send, received or removed</li>
<li>A message could not be sent (see <a class="el" href="structmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5" title="Get the state of a message. ">mrmsg_get_state()</a>/MR_STATE_OUT_ERROR)</li>
<li>Chats created, deleted or archived</li>
<li>A draft has been set</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>ID of the string to request, one of the MR_STR_* constants as defined in <a class="el" href="mrstock_8h_source.html">mrstock.h</a></td></tr>
<tr><td class="paramname">data2</td><td>The count. The frontend may retrurn different strings on this value and normally also includes the value itself to the string.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Null-terminated UTF-8 string. CAVE: The string will be free()'d by the core, so make sure it is allocated using malloc() or a compatible function. If you cannot provide the requested string, just return 0; the core will use a default string then. </dd></dl>
</div>
</div>
<a class="anchor" id="aaf5dbdab58ffcf836d65cd91283b701a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_GET_STRING&#160;&#160;&#160;2091</td>
</tr>
</table>
</div><div class="memdoc">
<p>Requeste a localized string from the frontend. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>ID of the string to request, one of the MR_STR_* constants as defined in <a class="el" href="mrstock_8h_source.html">mrstock.h</a></td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Null-terminated UTF-8 string. CAVE: The string will be free()'d by the core, so make sure it is allocated using malloc() or a compatible function. If you cannot provide the requested string, just return 0; the core will use a default string then. </dd></dl>
</div>
</div>
<a class="anchor" id="aba8b1a46a18cd05070b301c757a74ddc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_HTTP_GET&#160;&#160;&#160;2100</td>
</tr>
</table>
</div><div class="memdoc">
<p>Request a HTTP-file from the frontend. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>URL</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The content of the requested file as a null-terminated UTF-8 string. CAVE: The string will be free()'d by the core, so make sure it is allocated using malloc() or a compatible function. If you cannot provide the content, just return 0. </dd></dl>
</div>
</div>
<a class="anchor" id="a10211bf20ad64f8f6d635120ca64f374"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_IMEX_ENDED&#160;&#160;&#160;2050</td>
</tr>
</table>
</div><div class="memdoc">
<p>Import/export done. </p>
<p>You'll get this event from a call to <a class="el" href="structmrmailbox__t.html#a5de7b87b8c95733619cc4051b3508973" title="Import/export things. ">mrmailbox_imex()</a>. As we want to get rid of the threads in the core, this event may be deleted.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>0:failed, 1=success</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="aeb3ce82a01722f902b02c8e62cf301ab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_IMEX_FILE_WRITTEN&#160;&#160;&#160;2052</td>
</tr>
</table>
</div><div class="memdoc">
<p>A file has been exported. </p>
<p>A file has been written by <a class="el" href="structmrmailbox__t.html#a5de7b87b8c95733619cc4051b3508973" title="Import/export things. ">mrmailbox_imex()</a>. This event may be send multiple times by a single call to <a class="el" href="structmrmailbox__t.html#a5de7b87b8c95733619cc4051b3508973" title="Import/export things. ">mrmailbox_imex()</a>; if the export is done, <a class="el" href="mrevent_8h.html#a10211bf20ad64f8f6d635120ca64f374" title="Import/export done. ">MR_EVENT_IMEX_ENDED</a> is sent.</p>
<p>A typical purpose for a handler of this event may be to make the file public to some system services.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>File name</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="af046556dbd33f0bff86448d62df2b5f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_IMEX_PROGRESS&#160;&#160;&#160;2051</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inform about the import/export progress started by <a class="el" href="structmrmailbox__t.html#a5de7b87b8c95733619cc4051b3508973" title="Import/export things. ">mrmailbox_imex()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>Permille</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
<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>
@ -395,6 +267,7 @@ Macros</h2></td></tr>
<p>There is a fresh message. </p>
<p>Typically, the user will show an notification when receiving this message.</p>
<p>There is no extra <a class="el" href="mrevent_8h.html#a17eaeb107cbab46c0d9271d0b5560fc8" title="Messages or chats changed. ">MR_EVENT_MSGS_CHANGED</a> event send together with this event.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>chat_id</td></tr>
@ -404,52 +277,6 @@ Macros</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="abc46d188d1a1a25c92433aa05568e23b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_INFO&#160;&#160;&#160;100</td>
</tr>
</table>
</div><div class="memdoc">
<p>The user may write an informational string to the log. </p>
<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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="a9cc59f2599dc071ebe686b3dd9eb5ae2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_IS_OFFLINE&#160;&#160;&#160;2081</td>
</tr>
</table>
</div><div class="memdoc">
<p>Ask the frontend about the offline state. </p>
<p>This function may be provided by the frontend. If we already know, that we're offline, eg. there is no need to try to connect and things will speed up.</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>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0=online, 1=offline </dd></dl>
</div>
</div>
<a class="anchor" id="a10c4a8b6fa9014e5725e3a1daadf301b"></a>
@ -496,27 +323,230 @@ Macros</h2></td></tr>
</div>
</div>
<a class="anchor" id="a17eaeb107cbab46c0d9271d0b5560fc8"></a>
<a class="anchor" id="a5ac741b81ec97628f44795600c0e4d4c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_MSGS_CHANGED&#160;&#160;&#160;2000</td>
<td class="memname">#define MR_EVENT_CHAT_MODIFIED&#160;&#160;&#160;2020</td>
</tr>
</table>
</div><div class="memdoc">
<p>One or more messages changed for some reasons in the database. </p>
<p>Messages may be added or removed.</p>
<p>Group changed. </p>
<p>The name or the image of a chat group was changed or members were added or removed. See <a class="el" href="structmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1" title="Set group name. ">mrmailbox_set_chat_name()</a>, <a class="el" href="structmrmailbox__t.html#a08c527170681c949ddd6931a004fdd5f" title="Set group profile image. ">mrmailbox_set_chat_profile_image()</a>, <a class="el" href="structmrmailbox__t.html#a96368620971935c7ac4a0bb324ece2c9" title="Add a member to a group. ">mrmailbox_add_contact_to_chat()</a> and <a class="el" href="structmrmailbox__t.html#a40226d401548b002a62648ea054ac635" title="Remove a member from a group. ">mrmailbox_remove_contact_from_chat()</a>.</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>
<tr><td class="paramname">data1</td><td>chat_id</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="ad50b3a76349834631dc26b6c9557be8f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_CONTACTS_CHANGED&#160;&#160;&#160;2030</td>
</tr>
</table>
</div><div class="memdoc">
<p>Contact(s) created, renamed, blocked or deleted. </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>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="abb0881d4c7c887b8f371cedc471846b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_CONFIGURE_PROGRESS&#160;&#160;&#160;2041</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inform about the configuration progress started by <a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>Permille</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="a10211bf20ad64f8f6d635120ca64f374"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_IMEX_ENDED&#160;&#160;&#160;2050</td>
</tr>
</table>
</div><div class="memdoc">
<p>Import/export done. </p>
<p>You'll get this event from a call to <a class="el" href="structmrmailbox__t.html#a5de7b87b8c95733619cc4051b3508973" title="Import/export things. ">mrmailbox_imex()</a>. As we want to get rid of the threads in the core, this event may be deleted.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>0:failed, 1=success</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="af046556dbd33f0bff86448d62df2b5f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_IMEX_PROGRESS&#160;&#160;&#160;2051</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inform about the import/export progress started by <a class="el" href="structmrmailbox__t.html#a5de7b87b8c95733619cc4051b3508973" title="Import/export things. ">mrmailbox_imex()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>Permille</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="aeb3ce82a01722f902b02c8e62cf301ab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_IMEX_FILE_WRITTEN&#160;&#160;&#160;2052</td>
</tr>
</table>
</div><div class="memdoc">
<p>A file has been exported. </p>
<p>A file has been written by <a class="el" href="structmrmailbox__t.html#a5de7b87b8c95733619cc4051b3508973" title="Import/export things. ">mrmailbox_imex()</a>. This event may be send multiple times by a single call to <a class="el" href="structmrmailbox__t.html#a5de7b87b8c95733619cc4051b3508973" title="Import/export things. ">mrmailbox_imex()</a>; if the export is done, <a class="el" href="mrevent_8h.html#a10211bf20ad64f8f6d635120ca64f374" title="Import/export done. ">MR_EVENT_IMEX_ENDED</a> is sent.</p>
<p>A typical purpose for a handler of this event may be to make the file public to some system services.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>File name</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="a9cc59f2599dc071ebe686b3dd9eb5ae2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_IS_OFFLINE&#160;&#160;&#160;2081</td>
</tr>
</table>
</div><div class="memdoc">
<p>Ask the frontend about the offline state. </p>
<p>This function may be provided by the frontend. If we already know, that we're offline, eg. there is no need to try to connect and things will speed up.</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>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0=online, 1=offline </dd></dl>
</div>
</div>
<a class="anchor" id="aaf5dbdab58ffcf836d65cd91283b701a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_GET_STRING&#160;&#160;&#160;2091</td>
</tr>
</table>
</div><div class="memdoc">
<p>Requeste a localized string from the frontend. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>ID of the string to request, one of the MR_STR_* constants as defined in <a class="el" href="mrstock_8h_source.html">mrstock.h</a></td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Null-terminated UTF-8 string. CAVE: The string will be free()'d by the core, so make sure it is allocated using malloc() or a compatible function. If you cannot provide the requested string, just return 0; the core will use a default string then. </dd></dl>
</div>
</div>
<a class="anchor" id="a465a35db3742af9f1a3e39b2ede585da"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_GET_QUANTITY_STRING&#160;&#160;&#160;2092</td>
</tr>
</table>
</div><div class="memdoc">
<p>Requeste a localized quantitiy string from the frontend. </p>
<p>Quantitiy strings may have eg. different plural forms and usually also include the count itself to the string. Typical strings in this form are "1 Message" vs. "2 Messages".</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>ID of the string to request, one of the MR_STR_* constants as defined in <a class="el" href="mrstock_8h_source.html">mrstock.h</a></td></tr>
<tr><td class="paramname">data2</td><td>The count. The frontend may retrurn different strings on this value and normally also includes the value itself to the string.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Null-terminated UTF-8 string. CAVE: The string will be free()'d by the core, so make sure it is allocated using malloc() or a compatible function. If you cannot provide the requested string, just return 0; the core will use a default string then. </dd></dl>
</div>
</div>
<a class="anchor" id="aba8b1a46a18cd05070b301c757a74ddc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_HTTP_GET&#160;&#160;&#160;2100</td>
</tr>
</table>
</div><div class="memdoc">
<p>Request a HTTP-file from the frontend. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>URL</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The content of the requested file as a null-terminated UTF-8 string. CAVE: The string will be free()'d by the core, so make sure it is allocated using malloc() or a compatible function. If you cannot provide the content, just return 0. </dd></dl>
</div>
</div>
<a class="anchor" id="a8312b0e8f1e7422300a5502d86e0db01"></a>
@ -540,29 +570,6 @@ Macros</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="aa124fce3009b0cf018f49b69b76bce55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_WARNING&#160;&#160;&#160;300</td>
</tr>
</table>
</div><div class="memdoc">
<p>The user should write an warning string to the log. </p>
<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>Warning string</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
</div><!-- contents -->

2
docs/html/mrevent_8h_source.html
View file

File diff suppressed because one or more lines are too long

52
docs/html/mrmailbox_8h_source.html
View file

File diff suppressed because one or more lines are too long

15
docs/html/mrmsg_8h_source.html
View file

File diff suppressed because one or more lines are too long

11
docs/html/search/all_1.js
View file

@ -14,7 +14,7 @@ var searchData=
['m_5fis_5fmsgrmsg',['m_is_msgrmsg',['../structmrmsg__t.html#aa4fbc319d61c755ce929e658ad75b21e',1,'mrmsg_t']]],
['m_5fmailbox',['m_mailbox',['../structmrarray__t.html#abd4dde487b63dc1bd2ff00c76854af4f',1,'mrarray_t::m_mailbox()'],['../structmrchat__t.html#abf3e1a34f567e168bc0597f9a544a50d',1,'mrchat_t::m_mailbox()'],['../structmrchatlist__t.html#a025d213cde2fa547b2f3cae4e1facbf7',1,'mrchatlist_t::m_mailbox()']]],
['m_5fname',['m_name',['../structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140',1,'mrchat_t::m_name()'],['../structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b',1,'mrcontact_t::m_name()']]],
['m_5fparam',['m_param',['../structmrchat__t.html#ad2792ee7df778521de61087bc79795a7',1,'mrchat_t::m_param()'],['../structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453',1,'mrmsg_t::m_param()']]],
['m_5fparam',['m_param',['../structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453',1,'mrmsg_t']]],
['m_5fstarred',['m_starred',['../structmrmsg__t.html#a0570bbfc3add48dafb0ae70390b47adb',1,'mrmsg_t']]],
['m_5fstate',['m_state',['../structmrmsg__t.html#aca59d28054d3e15b4fe6ca74073d91f4',1,'mrmsg_t::m_state()'],['../structmrpoortext__t.html#afbf2ae7473784db66127e63657e04f60',1,'mrpoortext_t::m_state()']]],
['m_5ftext',['m_text',['../structmrmsg__t.html#ae54dcd4036371597d7f8bbd75303527a',1,'mrmsg_t']]],
@ -47,7 +47,9 @@ var searchData=
['mrarray_5fget_5fid',['mrarray_get_id',['../structmrarray__t.html#a40b1e875ba256b6ccbbe65f58bbc01ec',1,'mrarray_t']]],
['mrarray_5ft',['mrarray_t',['../structmrarray__t.html',1,'']]],
['mrarray_5funref',['mrarray_unref',['../structmrarray__t.html#a1400b5e42c682326e809723f02739a8e',1,'mrarray_t']]],
['mrchat_5fget_5fprofile_5fimage',['mrchat_get_profile_image',['../structmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b',1,'mrchat_t']]],
['mrchat_5fget_5fsubtitle',['mrchat_get_subtitle',['../structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08',1,'mrchat_t']]],
['mrchat_5fget_5funpromoted',['mrchat_get_unpromoted',['../structmrchat__t.html#abfe861b7cc247ebea854f4a15bcd1bef',1,'mrchat_t']]],
['mrchat_5ft',['mrchat_t',['../structmrchat__t.html',1,'']]],
['mrchat_5funref',['mrchat_unref',['../structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9',1,'mrchat_t']]],
['mrchatlist_5fget_5fchat_5fid',['mrchatlist_get_chat_id',['../structmrchatlist__t.html#a8c8360c76b31057322199e8c51cadfa5',1,'mrchatlist_t']]],
@ -56,7 +58,11 @@ var searchData=
['mrchatlist_5fget_5fsummary',['mrchatlist_get_summary',['../structmrchatlist__t.html#ae7670d62ab7fc83aff18f299f26853d8',1,'mrchatlist_t']]],
['mrchatlist_5ft',['mrchatlist_t',['../structmrchatlist__t.html',1,'']]],
['mrchatlist_5funref',['mrchatlist_unref',['../structmrchatlist__t.html#ab036d6e066b5ff78779f36711c9ab2f9',1,'mrchatlist_t']]],
['mrcontact_5fget_5faddr',['mrcontact_get_addr',['../structmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971',1,'mrcontact_t']]],
['mrcontact_5fget_5fdisplay_5fname',['mrcontact_get_display_name',['../structmrcontact__t.html#a29a93300d97183f795fc711c93fac689',1,'mrcontact_t']]],
['mrcontact_5fget_5ffirst_5fname',['mrcontact_get_first_name',['../structmrcontact__t.html#a804337f9c9e735a5429559b0fcb06121',1,'mrcontact_t']]],
['mrcontact_5fget_5fname',['mrcontact_get_name',['../structmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2',1,'mrcontact_t']]],
['mrcontact_5fget_5fname_5fn_5faddr',['mrcontact_get_name_n_addr',['../structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2',1,'mrcontact_t']]],
['mrcontact_5fnormalize_5fname',['mrcontact_normalize_name',['../structmrcontact__t.html#ad906207191f0cfd62e408dbc82a156cf',1,'mrcontact_t']]],
['mrcontact_5ft',['mrcontact_t',['../structmrcontact__t.html',1,'']]],
['mrcontact_5funref',['mrcontact_unref',['../structmrcontact__t.html#a38e17e55cd66f5e86a1dcb8d1f67797a',1,'mrcontact_t']]],
@ -115,8 +121,8 @@ var searchData=
['mrmailbox_5fsearch_5fmsgs',['mrmailbox_search_msgs',['../structmrmailbox__t.html#abbb08c91369ff2fedc8575f2e1f01e56',1,'mrmailbox_t']]],
['mrmailbox_5fsend_5fmsg',['mrmailbox_send_msg',['../structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c',1,'mrmailbox_t']]],
['mrmailbox_5fsend_5ftext_5fmsg',['mrmailbox_send_text_msg',['../structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b',1,'mrmailbox_t']]],
['mrmailbox_5fset_5fchat_5fimage',['mrmailbox_set_chat_image',['../structmrmailbox__t.html#a2a9b27b6a2e991cbf3b553c5dbbec803',1,'mrmailbox_t']]],
['mrmailbox_5fset_5fchat_5fname',['mrmailbox_set_chat_name',['../structmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1',1,'mrmailbox_t']]],
['mrmailbox_5fset_5fchat_5fprofile_5fimage',['mrmailbox_set_chat_profile_image',['../structmrmailbox__t.html#a08c527170681c949ddd6931a004fdd5f',1,'mrmailbox_t']]],
['mrmailbox_5fset_5fconfig',['mrmailbox_set_config',['../structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad',1,'mrmailbox_t']]],
['mrmailbox_5fset_5fconfig_5fint',['mrmailbox_set_config_int',['../structmrmailbox__t.html#a889aea3b38561016ffa2343d5106c38d',1,'mrmailbox_t']]],
['mrmailbox_5fset_5fdraft',['mrmailbox_set_draft',['../structmrmailbox__t.html#af50446c1a5e504d27fe29de9e3b8edc3',1,'mrmailbox_t']]],
@ -126,6 +132,7 @@ var searchData=
['mrmailboxcb_5ft',['mrmailboxcb_t',['../structmrmailbox__t.html#a957f0bbae60f389bac40acf42b68b134',1,'mrmailbox_t']]],
['mrmsg_5fempty',['mrmsg_empty',['../structmrmsg__t.html#a57d94b55fc918b27874b9194d6c35388',1,'mrmsg_t']]],
['mrmsg_5fget_5ffile',['mrmsg_get_file',['../structmrmsg__t.html#a2544769c77af5447546fcf5fc95c64f7',1,'mrmsg_t']]],
['mrmsg_5fget_5ffilename',['mrmsg_get_filename',['../structmrmsg__t.html#ad0dcfc0a1e33d9a88b7381e368d7895a',1,'mrmsg_t']]],
['mrmsg_5fget_5fmediainfo',['mrmsg_get_mediainfo',['../structmrmsg__t.html#ad87b7df007489b3a47c3fde79978a58a',1,'mrmsg_t']]],
['mrmsg_5fget_5fshowpadlock',['mrmsg_get_showpadlock',['../structmrmsg__t.html#a7f1bd3d845bbc5face7636aed8f8afd4',1,'mrmsg_t']]],
['mrmsg_5fget_5fstate',['mrmsg_get_state',['../structmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5',1,'mrmsg_t']]],

9
docs/html/search/functions_0.js
View file

@ -3,14 +3,20 @@ var searchData=
['mrarray_5fget_5fcnt',['mrarray_get_cnt',['../structmrarray__t.html#a73f6d954ed1b97bbceb3cf7d8e1aeec8',1,'mrarray_t']]],
['mrarray_5fget_5fid',['mrarray_get_id',['../structmrarray__t.html#a40b1e875ba256b6ccbbe65f58bbc01ec',1,'mrarray_t']]],
['mrarray_5funref',['mrarray_unref',['../structmrarray__t.html#a1400b5e42c682326e809723f02739a8e',1,'mrarray_t']]],
['mrchat_5fget_5fprofile_5fimage',['mrchat_get_profile_image',['../structmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b',1,'mrchat_t']]],
['mrchat_5fget_5fsubtitle',['mrchat_get_subtitle',['../structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08',1,'mrchat_t']]],
['mrchat_5fget_5funpromoted',['mrchat_get_unpromoted',['../structmrchat__t.html#abfe861b7cc247ebea854f4a15bcd1bef',1,'mrchat_t']]],
['mrchat_5funref',['mrchat_unref',['../structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9',1,'mrchat_t']]],
['mrchatlist_5fget_5fchat_5fid',['mrchatlist_get_chat_id',['../structmrchatlist__t.html#a8c8360c76b31057322199e8c51cadfa5',1,'mrchatlist_t']]],
['mrchatlist_5fget_5fcnt',['mrchatlist_get_cnt',['../structmrchatlist__t.html#aa132119f18e40e3151ac5fe0299daab7',1,'mrchatlist_t']]],
['mrchatlist_5fget_5fmsg_5fid',['mrchatlist_get_msg_id',['../structmrchatlist__t.html#a69b67135eeadbdbe9b4a60e645ef22b0',1,'mrchatlist_t']]],
['mrchatlist_5fget_5fsummary',['mrchatlist_get_summary',['../structmrchatlist__t.html#ae7670d62ab7fc83aff18f299f26853d8',1,'mrchatlist_t']]],
['mrchatlist_5funref',['mrchatlist_unref',['../structmrchatlist__t.html#ab036d6e066b5ff78779f36711c9ab2f9',1,'mrchatlist_t']]],
['mrcontact_5fget_5faddr',['mrcontact_get_addr',['../structmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971',1,'mrcontact_t']]],
['mrcontact_5fget_5fdisplay_5fname',['mrcontact_get_display_name',['../structmrcontact__t.html#a29a93300d97183f795fc711c93fac689',1,'mrcontact_t']]],
['mrcontact_5fget_5ffirst_5fname',['mrcontact_get_first_name',['../structmrcontact__t.html#a804337f9c9e735a5429559b0fcb06121',1,'mrcontact_t']]],
['mrcontact_5fget_5fname',['mrcontact_get_name',['../structmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2',1,'mrcontact_t']]],
['mrcontact_5fget_5fname_5fn_5faddr',['mrcontact_get_name_n_addr',['../structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2',1,'mrcontact_t']]],
['mrcontact_5fnormalize_5fname',['mrcontact_normalize_name',['../structmrcontact__t.html#ad906207191f0cfd62e408dbc82a156cf',1,'mrcontact_t']]],
['mrcontact_5funref',['mrcontact_unref',['../structmrcontact__t.html#a38e17e55cd66f5e86a1dcb8d1f67797a',1,'mrcontact_t']]],
['mrmailbox_5fadd_5faddress_5fbook',['mrmailbox_add_address_book',['../structmrmailbox__t.html#a25720ea41355cc32cc93aa45709937d6',1,'mrmailbox_t']]],
@ -67,8 +73,8 @@ var searchData=
['mrmailbox_5fsearch_5fmsgs',['mrmailbox_search_msgs',['../structmrmailbox__t.html#abbb08c91369ff2fedc8575f2e1f01e56',1,'mrmailbox_t']]],
['mrmailbox_5fsend_5fmsg',['mrmailbox_send_msg',['../structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c',1,'mrmailbox_t']]],
['mrmailbox_5fsend_5ftext_5fmsg',['mrmailbox_send_text_msg',['../structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b',1,'mrmailbox_t']]],
['mrmailbox_5fset_5fchat_5fimage',['mrmailbox_set_chat_image',['../structmrmailbox__t.html#a2a9b27b6a2e991cbf3b553c5dbbec803',1,'mrmailbox_t']]],
['mrmailbox_5fset_5fchat_5fname',['mrmailbox_set_chat_name',['../structmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1',1,'mrmailbox_t']]],
['mrmailbox_5fset_5fchat_5fprofile_5fimage',['mrmailbox_set_chat_profile_image',['../structmrmailbox__t.html#a08c527170681c949ddd6931a004fdd5f',1,'mrmailbox_t']]],
['mrmailbox_5fset_5fconfig',['mrmailbox_set_config',['../structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad',1,'mrmailbox_t']]],
['mrmailbox_5fset_5fconfig_5fint',['mrmailbox_set_config_int',['../structmrmailbox__t.html#a889aea3b38561016ffa2343d5106c38d',1,'mrmailbox_t']]],
['mrmailbox_5fset_5fdraft',['mrmailbox_set_draft',['../structmrmailbox__t.html#af50446c1a5e504d27fe29de9e3b8edc3',1,'mrmailbox_t']]],
@ -76,6 +82,7 @@ var searchData=
['mrmailbox_5funref',['mrmailbox_unref',['../structmrmailbox__t.html#a825cec4a85da05335674eae221d51374',1,'mrmailbox_t']]],
['mrmsg_5fempty',['mrmsg_empty',['../structmrmsg__t.html#a57d94b55fc918b27874b9194d6c35388',1,'mrmsg_t']]],
['mrmsg_5fget_5ffile',['mrmsg_get_file',['../structmrmsg__t.html#a2544769c77af5447546fcf5fc95c64f7',1,'mrmsg_t']]],
['mrmsg_5fget_5ffilename',['mrmsg_get_filename',['../structmrmsg__t.html#ad0dcfc0a1e33d9a88b7381e368d7895a',1,'mrmsg_t']]],
['mrmsg_5fget_5fmediainfo',['mrmsg_get_mediainfo',['../structmrmsg__t.html#ad87b7df007489b3a47c3fde79978a58a',1,'mrmsg_t']]],
['mrmsg_5fget_5fshowpadlock',['mrmsg_get_showpadlock',['../structmrmsg__t.html#a7f1bd3d845bbc5face7636aed8f8afd4',1,'mrmsg_t']]],
['mrmsg_5fget_5fstate',['mrmsg_get_state',['../structmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5',1,'mrmsg_t']]],

2
docs/html/search/variables_0.js
View file

@ -14,7 +14,7 @@ var searchData=
['m_5fis_5fmsgrmsg',['m_is_msgrmsg',['../structmrmsg__t.html#aa4fbc319d61c755ce929e658ad75b21e',1,'mrmsg_t']]],
['m_5fmailbox',['m_mailbox',['../structmrarray__t.html#abd4dde487b63dc1bd2ff00c76854af4f',1,'mrarray_t::m_mailbox()'],['../structmrchat__t.html#abf3e1a34f567e168bc0597f9a544a50d',1,'mrchat_t::m_mailbox()'],['../structmrchatlist__t.html#a025d213cde2fa547b2f3cae4e1facbf7',1,'mrchatlist_t::m_mailbox()']]],
['m_5fname',['m_name',['../structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140',1,'mrchat_t::m_name()'],['../structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b',1,'mrcontact_t::m_name()']]],
['m_5fparam',['m_param',['../structmrchat__t.html#ad2792ee7df778521de61087bc79795a7',1,'mrchat_t::m_param()'],['../structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453',1,'mrmsg_t::m_param()']]],
['m_5fparam',['m_param',['../structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453',1,'mrmsg_t']]],
['m_5fstarred',['m_starred',['../structmrmsg__t.html#a0570bbfc3add48dafb0ae70390b47adb',1,'mrmsg_t']]],
['m_5fstate',['m_state',['../structmrmsg__t.html#aca59d28054d3e15b4fe6ca74073d91f4',1,'mrmsg_t::m_state()'],['../structmrpoortext__t.html#afbf2ae7473784db66127e63657e04f60',1,'mrpoortext_t::m_state()']]],
['m_5ftext',['m_text',['../structmrmsg__t.html#ae54dcd4036371597d7f8bbd75303527a',1,'mrmsg_t']]],

50
docs/html/structmrarray__t.html
View file

@ -117,6 +117,31 @@ Public Attributes</h2></td></tr>
<div class="textblock"><p>An object representing a simple array. </p>
<p>This object is used in several placed where functions need to return an array. The items of the array are typically IDs. To free an array object, use <a class="el" href="structmrarray__t.html#a1400b5e42c682326e809723f02739a8e" title="Free an array object. ">mrarray_unref()</a>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1400b5e42c682326e809723f02739a8e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrarray_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrarray__t.html">mrarray_t</a> *&#160;</td>
<td class="paramname"><em>array</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free an array object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">array</td><td>The array object to free, created eg. by <a class="el" href="structmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>, <a class="el" href="structmrmailbox__t.html#ae4ccc69ba8e8851a04f9b17b37e5f86a" title="Returns known and unblocked contacts. ">mrmailbox_get_known_contacts()</a> and so on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a73f6d954ed1b97bbceb3cf7d8e1aeec8"></a>
<div class="memitem">
<div class="memproto">
@ -176,31 +201,6 @@ Public Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the item at the given index. Returns 0 on errors or if the array is empty. </dd></dl>
</div>
</div>
<a class="anchor" id="a1400b5e42c682326e809723f02739a8e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrarray_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrarray__t.html">mrarray_t</a> *&#160;</td>
<td class="paramname"><em>array</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free an array object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">array</td><td>The array object to free, created eg. by <a class="el" href="structmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>, <a class="el" href="structmrmailbox__t.html#ae4ccc69ba8e8851a04f9b17b37e5f86a" title="Returns known and unblocked contacts. ">mrmailbox_get_known_contacts()</a> and so on.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>

7
docs/html/structmrchat__t-members.html
View file

@ -94,10 +94,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<tr><td class="entry"><a class="el" href="structmrchat__t.html#a1591431716413350eaffce0b588e4911">m_id</a></td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrchat__t.html#abf3e1a34f567e168bc0597f9a544a50d">m_mailbox</a></td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140">m_name</a></td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrchat__t.html#ad2792ee7df778521de61087bc79795a7">m_param</a></td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrchat__t.html#a568c4e6fb9633ffe9a76428db16e0201">m_type</a></td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrchat__t.html#a568c4e6fb9633ffe9a76428db16e0201">m_type</a></td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b">mrchat_get_profile_image</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08">mrchat_get_subtitle</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9">mrchat_unref</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrchat__t.html#abfe861b7cc247ebea854f4a15bcd1bef">mrchat_get_unpromoted</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9">mrchat_unref</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>

293
docs/html/structmrchat__t.html
View file

@ -100,6 +100,12 @@ 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:abfe861b7cc247ebea854f4a15bcd1bef"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#abfe861b7cc247ebea854f4a15bcd1bef">mrchat_get_unpromoted</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:abfe861b7cc247ebea854f4a15bcd1bef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a chat is still unpromoted. <a href="#abfe861b7cc247ebea854f4a15bcd1bef">More...</a><br /></td></tr>
<tr class="separator:abfe861b7cc247ebea854f4a15bcd1bef"><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: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>
@ -127,40 +133,11 @@ Public Attributes</h2></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>
<tr class="memitem:ad2792ee7df778521de61087bc79795a7"><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="structmrchat__t.html#ad2792ee7df778521de61087bc79795a7">m_param</a></td></tr>
<tr class="memdesc:ad2792ee7df778521de61087bc79795a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Additional parameters for the chat. <a href="#ad2792ee7df778521de61087bc79795a7">More...</a><br /></td></tr>
<tr class="separator:ad2792ee7df778521de61087bc79795a7"><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>
<p>Chat objects are created using eg. <a class="el" href="structmrmailbox__t.html#ad106b9c23b3a559b524a37bb5504e096" title="Get chat object by a chat ID. ">mrmailbox_get_chat()</a> and are not updated on database changes; if you want an update, you have to recreate the object. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<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 sibtitle is eg. the email-address or the number of group members.</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. </dd></dl>
</div>
</div>
<a class="anchor" id="a3b1befb4542c1bad915f2175c7c2a2b9"></a>
<div class="memitem">
<div class="memproto">
@ -184,59 +161,88 @@ Public Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="abfe861b7cc247ebea854f4a15bcd1bef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrchat_get_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 <a class="el" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c" title="Send a message of any type to a chat. ">mrmailbox_send_msg()</a> or <a class="el" href="structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b" title="Send a simple text message to the 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>
<a class="anchor" id="a12bad02bef1fb6c8003f41c72d94f54b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrchat_get_profile_image </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 the chat's profile image. </p>
<p>The profile image is set using <a class="el" href="structmrmailbox__t.html#a08c527170681c949ddd6931a004fdd5f" title="Set group profile image. ">mrmailbox_set_chat_profile_image()</a> for groups. For normal chats, the profile image is set using mrmailbox_set_contact_profile_image() (not yet implemented).</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>Path and file if the profile image, if any. NULL otherwise. Must be free()'d after usage. </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>
<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. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<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>
<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="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="a1591431716413350eaffce0b588e4911"></a>
<div class="memitem">
<div class="memproto">
@ -255,53 +261,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="abf3e1a34f567e168bc0597f9a544a50d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a>* mrchat_t::m_mailbox</td>
</tr>
</table>
</div><div class="memdoc">
<p>The mailbox object the chat belongs to. </p>
<p>Never NULL. </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="ad2792ee7df778521de61087bc79795a7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmrparam__t.html">mrparam_t</a>* mrchat_t::m_param</td>
</tr>
</table>
</div><div class="memdoc">
<p>Additional parameters for the chat. </p>
<p>To access the parameters, use <a class="el" href="structmrparam__t.html#a0a9d3768d128dce0088b089f66fafb68" title="Check if a parameter exists. ">mrparam_exists()</a>, <a class="el" href="structmrparam__t.html#a23e24e8700e17ede6dd385fc90330f76" title="Get value of a parameter. ">mrparam_get()</a> for <a class="el" href="structmrparam__t.html#aba7d11db241c2ebbadab67895b84dae8" title="Get value of a parameter. ">mrparam_get_int()</a> </p>
</div>
</div>
<a class="anchor" id="a568c4e6fb9633ffe9a76428db16e0201"></a>
@ -321,6 +280,88 @@ Public Attributes</h2></td></tr>
</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="abf3e1a34f567e168bc0597f9a544a50d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a>* mrchat_t::m_mailbox</td>
</tr>
</table>
</div><div class="memdoc">
<p>The mailbox object the chat belongs to. </p>
<p>Never NULL. </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>

100
docs/html/structmrchatlist__t.html
View file

@ -124,6 +124,56 @@ Public Attributes</h2></td></tr>
<div class="textblock"><p>An object representing a single chatlist in memory. </p>
<p>Chatlist objects contain chat IDs and, if possible, message IDs belonging to them. Chatlist objects are created eg. using <a class="el" href="structmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>. The chatlist object is not updated. If you want an update, you have to recreate the object. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab036d6e066b5ff78779f36711c9ab2f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrchatlist_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrchatlist__t.html">mrchatlist_t</a> *&#160;</td>
<td class="paramname"><em>chatlist</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a chatlist object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chatlist</td><td>The chatlist object to free, created eg. by <a class="el" href="structmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>, <a class="el" href="structmrmailbox__t.html#abbb08c91369ff2fedc8575f2e1f01e56" title="Search messages containing the given query string. ">mrmailbox_search_msgs()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="aa132119f18e40e3151ac5fe0299daab7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mrchatlist_get_cnt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrchatlist__t.html">mrchatlist_t</a> *&#160;</td>
<td class="paramname"><em>chatlist</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find out the number of chats in a chatlist. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chatlist</td><td>The chatlist object as created eg. by <a class="el" href="structmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the number of items in a <a class="el" href="structmrchatlist__t.html" title="An object representing a single chatlist in memory. ">mrchatlist_t</a> object. 0 on errors or if the list is empty. </dd></dl>
</div>
</div>
<a class="anchor" id="a8c8360c76b31057322199e8c51cadfa5"></a>
<div class="memitem">
<div class="memproto">
@ -159,31 +209,6 @@ Public Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the chat_id of the item at the given index. Index must be between 0 and <a class="el" href="structmrchatlist__t.html#aa132119f18e40e3151ac5fe0299daab7" title="Find out the number of chats in a chatlist. ">mrchatlist_get_cnt()</a>-1. </dd></dl>
</div>
</div>
<a class="anchor" id="aa132119f18e40e3151ac5fe0299daab7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mrchatlist_get_cnt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrchatlist__t.html">mrchatlist_t</a> *&#160;</td>
<td class="paramname"><em>chatlist</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find out the number of chats in a chatlist. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chatlist</td><td>The chatlist object as created eg. by <a class="el" href="structmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the number of items in a <a class="el" href="structmrchatlist__t.html" title="An object representing a single chatlist in memory. ">mrchatlist_t</a> object. 0 on errors or if the list is empty. </dd></dl>
</div>
</div>
<a class="anchor" id="a69b67135eeadbdbe9b4a60e645ef22b0"></a>
@ -272,31 +297,6 @@ Public Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The result must be freed using <a class="el" href="structmrpoortext__t.html#a89c28735bfd718051ffc6b742f9c10ed" title="Frees a poortext object. ">mrpoortext_unref()</a>. The function never returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="ab036d6e066b5ff78779f36711c9ab2f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrchatlist_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrchatlist__t.html">mrchatlist_t</a> *&#160;</td>
<td class="paramname"><em>chatlist</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a chatlist object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chatlist</td><td>The chatlist object to free, created eg. by <a class="el" href="structmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>, <a class="el" href="structmrmailbox__t.html#abbb08c91369ff2fedc8575f2e1f01e56" title="Search messages containing the given query string. ">mrmailbox_search_msgs()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>

4
docs/html/structmrcontact__t-members.html
View file

@ -93,7 +93,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<tr class="even"><td class="entry"><a class="el" href="structmrcontact__t.html#ac22d500e5c439b07c943ed2c7afb2a23">m_blocked</a></td><td class="entry"><a class="el" href="structmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrcontact__t.html#ab2ee31297c327e04ed14673adbd49716">m_id</a></td><td class="entry"><a class="el" href="structmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b">m_name</a></td><td class="entry"><a class="el" href="structmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971">mrcontact_get_addr</a>(mrcontact_t *contact)</td><td class="entry"><a class="el" href="structmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrcontact__t.html#a29a93300d97183f795fc711c93fac689">mrcontact_get_display_name</a>(mrcontact_t *contact)</td><td class="entry"><a class="el" href="structmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrcontact__t.html#a804337f9c9e735a5429559b0fcb06121">mrcontact_get_first_name</a>(const char *full_name)</td><td class="entry"><a class="el" href="structmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2">mrcontact_get_name</a>(mrcontact_t *contact)</td><td class="entry"><a class="el" href="structmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2">mrcontact_get_name_n_addr</a>(mrcontact_t *contact)</td><td class="entry"><a class="el" href="structmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrcontact__t.html#ad906207191f0cfd62e408dbc82a156cf">mrcontact_normalize_name</a>(char *full_name)</td><td class="entry"><a class="el" href="structmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrcontact__t.html#a38e17e55cd66f5e86a1dcb8d1f67797a">mrcontact_unref</a>(mrcontact_t *contact)</td><td class="entry"><a class="el" href="structmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->

270
docs/html/structmrcontact__t.html
View file

@ -100,6 +100,18 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a38e17e55cd66f5e86a1dcb8d1f67797a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a38e17e55cd66f5e86a1dcb8d1f67797a">mrcontact_unref</a> (<a class="el" href="structmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
<tr class="memdesc:a38e17e55cd66f5e86a1dcb8d1f67797a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free a contact object. <a href="#a38e17e55cd66f5e86a1dcb8d1f67797a">More...</a><br /></td></tr>
<tr class="separator:a38e17e55cd66f5e86a1dcb8d1f67797a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe19c7f41061c1946d00556f3e4a971"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971">mrcontact_get_addr</a> (<a class="el" href="structmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
<tr class="memdesc:abfe19c7f41061c1946d00556f3e4a971"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get email address. <a href="#abfe19c7f41061c1946d00556f3e4a971">More...</a><br /></td></tr>
<tr class="separator:abfe19c7f41061c1946d00556f3e4a971"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b559ef46c96f38bf2d1f2c39de3ccb2"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2">mrcontact_get_name</a> (<a class="el" href="structmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
<tr class="memdesc:a5b559ef46c96f38bf2d1f2c39de3ccb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get name. <a href="#a5b559ef46c96f38bf2d1f2c39de3ccb2">More...</a><br /></td></tr>
<tr class="separator:a5b559ef46c96f38bf2d1f2c39de3ccb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29a93300d97183f795fc711c93fac689"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a29a93300d97183f795fc711c93fac689">mrcontact_get_display_name</a> (<a class="el" href="structmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
<tr class="memdesc:a29a93300d97183f795fc711c93fac689"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get display name. <a href="#a29a93300d97183f795fc711c93fac689">More...</a><br /></td></tr>
<tr class="separator:a29a93300d97183f795fc711c93fac689"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2658329d9e3c74f93943dfd8c25554b2"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2">mrcontact_get_name_n_addr</a> (<a class="el" href="structmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
<tr class="memdesc:a2658329d9e3c74f93943dfd8c25554b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a summary of name and address. <a href="#a2658329d9e3c74f93943dfd8c25554b2">More...</a><br /></td></tr>
<tr class="separator:a2658329d9e3c74f93943dfd8c25554b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a804337f9c9e735a5429559b0fcb06121"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a804337f9c9e735a5429559b0fcb06121">mrcontact_get_first_name</a> (const char *full_name)</td></tr>
<tr class="memdesc:a804337f9c9e735a5429559b0fcb06121"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the first name. <a href="#a804337f9c9e735a5429559b0fcb06121">More...</a><br /></td></tr>
<tr class="separator:a804337f9c9e735a5429559b0fcb06121"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -113,13 +125,13 @@ Public Attributes</h2></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">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b">m_name</a></td></tr>
<tr class="memdesc:a48fba862b41f7da3b8c6193c0554654b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name given by the user to the contact. <a href="#a48fba862b41f7da3b8c6193c0554654b">More...</a><br /></td></tr>
<tr class="memdesc:a48fba862b41f7da3b8c6193c0554654b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contact name. <a href="#a48fba862b41f7da3b8c6193c0554654b">More...</a><br /></td></tr>
<tr class="separator:a48fba862b41f7da3b8c6193c0554654b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a559c848feee29d334098f9a581448e56"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a559c848feee29d334098f9a581448e56">m_authname</a></td></tr>
<tr class="memdesc:a559c848feee29d334098f9a581448e56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name authorized by the contact himself. <a href="#a559c848feee29d334098f9a581448e56">More...</a><br /></td></tr>
<tr class="separator:a559c848feee29d334098f9a581448e56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaedd60ba4cad97bb87ba5a55958341e5"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#aaedd60ba4cad97bb87ba5a55958341e5">m_addr</a></td></tr>
<tr class="memdesc:aaedd60ba4cad97bb87ba5a55958341e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The E-Mail-Address of the contact. <a href="#aaedd60ba4cad97bb87ba5a55958341e5">More...</a><br /></td></tr>
<tr class="memdesc:aaedd60ba4cad97bb87ba5a55958341e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">E-Mail-Address of the contact. <a href="#aaedd60ba4cad97bb87ba5a55958341e5">More...</a><br /></td></tr>
<tr class="separator:aaedd60ba4cad97bb87ba5a55958341e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac22d500e5c439b07c943ed2c7afb2a23"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#ac22d500e5c439b07c943ed2c7afb2a23">m_blocked</a></td></tr>
<tr class="memdesc:ac22d500e5c439b07c943ed2c7afb2a23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocked state. <a href="#ac22d500e5c439b07c943ed2c7afb2a23">More...</a><br /></td></tr>
@ -129,6 +141,139 @@ Public Attributes</h2></td></tr>
<div class="textblock"><p>An object representing a single contact in memory. </p>
<p>The contact object is not updated. If you want an update, you have to recreate the object. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a38e17e55cd66f5e86a1dcb8d1f67797a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrcontact_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrcontact__t.html">mrcontact_t</a> *&#160;</td>
<td class="paramname"><em>contact</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a contact object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">contact</td><td>The contact object as created eg. by <a class="el" href="structmrmailbox__t.html#a057660d94350ff98eca72785c6e88962" title="Get a single contact object. ">mrmailbox_get_contact()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="abfe19c7f41061c1946d00556f3e4a971"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrcontact_get_addr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrcontact__t.html">mrcontact_t</a> *&#160;</td>
<td class="paramname"><em>contact</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get email address. </p>
<p>May be an empty string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">contact</td><td>The contact object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String with the email address, must be free()'d. Never returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="a5b559ef46c96f38bf2d1f2c39de3ccb2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrcontact_get_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrcontact__t.html">mrcontact_t</a> *&#160;</td>
<td class="paramname"><em>contact</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get name. </p>
<p>This is the name as defined the the contact himself or modified by the user. May be an empty string.</p>
<p>This name is typically used in a form where the user can edit the name of a contact. This name must not be spreaded via mail (To:, CC: ...) as it as it may be sth. like "Daddy". To get a fine name to display in lists etc., use <a class="el" href="structmrcontact__t.html#a29a93300d97183f795fc711c93fac689" title="Get display name. ">mrcontact_get_display_name()</a> or <a class="el" href="structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2" title="Get a summary of name and address. ">mrcontact_get_name_n_addr()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">contact</td><td>The contact object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String with the name to display, must be free()'d. Empty string if unset, never returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="a29a93300d97183f795fc711c93fac689"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrcontact_get_display_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrcontact__t.html">mrcontact_t</a> *&#160;</td>
<td class="paramname"><em>contact</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get display name. </p>
<p>This is the name as defined the the contact himself, modified by the user or, if both are unset, the email address.</p>
<p>This name is typically used in lists and must not be speaded via mail (To:, CC: ...). To get the name editable in a formular, use mrcontact_get_edit_name().</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">contact</td><td>The contact object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String with the name to display, must be free()'d. Never returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="a2658329d9e3c74f93943dfd8c25554b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrcontact_get_name_n_addr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrcontact__t.html">mrcontact_t</a> *&#160;</td>
<td class="paramname"><em>contact</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a summary of name and address. </p>
<p>The returned string is either "Name (email@domain.com)" or just "email@domain.com" if the name is unset.</p>
<p>The summary is typically used when asking the user something about the contact. The attached email address makes the question unique, eg. "Chat with Alan Miller (am@uniquedomain.com)?"</p>
<p>The summary must not be spreaded via mail (To:, CC: ...) as it as it may contain sth. like "Daddy".</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">contact</td><td>The contact object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Summary string, must be free()'d. Never returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="a804337f9c9e735a5429559b0fcb06121"></a>
<div class="memitem">
<div class="memproto">
@ -175,6 +320,7 @@ Public Attributes</h2></td></tr>
<li>Convert names as "Petersen, Björn" to "Björn Petersen"</li>
<li>Trims the resulting string</li>
</ul>
<p>Typically, this function is not needed as it is called implicitly by <a class="el" href="structmrmailbox__t.html#a25720ea41355cc32cc93aa45709937d6" title="Add a number of contacts. ">mrmailbox_add_address_book()</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">full_name</td><td>Buffer with the name, is modified during processing; the resulting string may be shorter but never longer.</td></tr>
@ -183,79 +329,9 @@ Public Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. But the given buffer may be modified. </dd></dl>
</div>
</div>
<a class="anchor" id="a38e17e55cd66f5e86a1dcb8d1f67797a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrcontact_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrcontact__t.html">mrcontact_t</a> *&#160;</td>
<td class="paramname"><em>contact</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a contact object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">contact</td><td>The contact object as created eg. by <a class="el" href="structmrmailbox__t.html#a057660d94350ff98eca72785c6e88962" title="Get a single contact object. ">mrmailbox_get_contact()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aaedd60ba4cad97bb87ba5a55958341e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrcontact_t::m_addr</td>
</tr>
</table>
</div><div class="memdoc">
<p>The E-Mail-Address of the contact. </p>
<p>May be NULL or empty. </p>
</div>
</div>
<a class="anchor" id="a559c848feee29d334098f9a581448e56"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrcontact_t::m_authname</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name authorized by the contact himself. </p>
<p>May be NULL or empty, this is the name authorized by the sender, only this name may be speaded to others, eg. in To:-lists; for displaying in the app, use <a class="el" href="structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b" title="Name given by the user to the contact. ">m_name</a> </p>
</div>
</div>
<a class="anchor" id="ac22d500e5c439b07c943ed2c7afb2a23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrcontact_t::m_blocked</td>
</tr>
</table>
</div><div class="memdoc">
<p>Blocked state. </p>
<p>1=contact is blocked, 0=contact is not blocked. To block or unblock a contact, use <a class="el" href="structmrmailbox__t.html#abb069358386b767a60444651195e0895" title="Block or unblock a contact. ">mrmailbox_block_contact()</a>. </p>
</div>
</div>
<a class="anchor" id="ab2ee31297c327e04ed14673adbd49716"></a>
<div class="memitem">
<div class="memproto">
@ -284,9 +360,53 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Name given by the user to the contact. </p>
<p>Should be used for displaying everywhere and is editable by the user but must not be spreaded via mail (To:, CC: ...) as it as it may be sth. like "Daddy".</p>
<p>May be NULL or empty, initially set to <a class="el" href="structmrcontact__t.html#a559c848feee29d334098f9a581448e56" title="Name authorized by the contact himself. ">m_authname</a> </p>
<p>Contact name. </p>
<p>It is recommended to use <a class="el" href="structmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2" title="Get name. ">mrcontact_get_name()</a>, <a class="el" href="structmrcontact__t.html#a29a93300d97183f795fc711c93fac689" title="Get display name. ">mrcontact_get_display_name()</a> or <a class="el" href="structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2" title="Get a summary of name and address. ">mrcontact_get_name_n_addr()</a> to access this field. May be NULL or empty, initially set to <a class="el" href="structmrcontact__t.html#a559c848feee29d334098f9a581448e56" title="Name authorized by the contact himself. ">m_authname</a>. </p>
</div>
</div>
<a class="anchor" id="a559c848feee29d334098f9a581448e56"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrcontact_t::m_authname</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name authorized by the contact himself. </p>
<p>It is recommended to use <a class="el" href="structmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2" title="Get name. ">mrcontact_get_name()</a>, <a class="el" href="structmrcontact__t.html#a29a93300d97183f795fc711c93fac689" title="Get display name. ">mrcontact_get_display_name()</a> or <a class="el" href="structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2" title="Get a summary of name and address. ">mrcontact_get_name_n_addr()</a> to access this field. This is the name authorized by the sender, only this name may be speaded to others, eg. in To:-lists. May be NULL or empty. </p>
</div>
</div>
<a class="anchor" id="aaedd60ba4cad97bb87ba5a55958341e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrcontact_t::m_addr</td>
</tr>
</table>
</div><div class="memdoc">
<p>E-Mail-Address of the contact. </p>
<p>It is recommended to use <a class="el" href="structmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971" title="Get email address. ">mrcontact_get_addr()</a> to access this field. May be NULL. </p>
</div>
</div>
<a class="anchor" id="ac22d500e5c439b07c943ed2c7afb2a23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrcontact_t::m_blocked</td>
</tr>
</table>
</div><div class="memdoc">
<p>Blocked state. </p>
<p>1=contact is blocked, 0=contact is not blocked. To block or unblock a contact, use <a class="el" href="structmrmailbox__t.html#abb069358386b767a60444651195e0895" title="Block or unblock a contact. ">mrmailbox_block_contact()</a>. </p>
</div>
</div>

4
docs/html/structmrmailbox__t-members.html
View file

@ -145,8 +145,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<tr class="even"><td class="entry"><a class="el" href="structmrmailbox__t.html#abbb08c91369ff2fedc8575f2e1f01e56">mrmailbox_search_msgs</a>(mrmailbox_t *mailbox, uint32_t chat_id, const char *query)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c">mrmailbox_send_msg</a>(mrmailbox_t *mailbox, uint32_t chat_id, mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b">mrmailbox_send_text_msg</a>(mrmailbox_t *mailbox, uint32_t chat_id, const char *text_to_send)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmailbox__t.html#a2a9b27b6a2e991cbf3b553c5dbbec803">mrmailbox_set_chat_image</a>(mrmailbox_t *mailbox, uint32_t chat_id, const char *new_image)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1">mrmailbox_set_chat_name</a>(mrmailbox_t *mailbox, uint32_t chat_id, const char *new_name)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1">mrmailbox_set_chat_name</a>(mrmailbox_t *mailbox, uint32_t chat_id, const char *new_name)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmailbox__t.html#a08c527170681c949ddd6931a004fdd5f">mrmailbox_set_chat_profile_image</a>(mrmailbox_t *mailbox, uint32_t chat_id, const char *new_image)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad">mrmailbox_set_config</a>(mrmailbox_t *ths, const char *key, const char *value)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmailbox__t.html#a889aea3b38561016ffa2343d5106c38d">mrmailbox_set_config_int</a>(mrmailbox_t *ths, const char *key, int32_t value)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmailbox__t.html#af50446c1a5e504d27fe29de9e3b8edc3">mrmailbox_set_draft</a>(mrmailbox_t *mailbox, uint32_t chat_id, const char *msg)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>

3087
docs/html/structmrmailbox__t.html
View file

File diff suppressed because it is too large Load diff

29
docs/html/structmrmsg__t-members.html
View file

@ -101,20 +101,21 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a3896e269c90cbf0f563ab0848fb44c65">m_type</a></td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a57d94b55fc918b27874b9194d6c35388">mrmsg_empty</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a2544769c77af5447546fcf5fc95c64f7">mrmsg_get_file</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#ad87b7df007489b3a47c3fde79978a58a">mrmsg_get_mediainfo</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a7f1bd3d845bbc5face7636aed8f8afd4">mrmsg_get_showpadlock</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5">mrmsg_get_state</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#afc3d94448ada0ad7142cf168cab1462e">mrmsg_get_summary</a>(mrmsg_t *msg, mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a8c8c1f342f01439ae40c5cf37532387e">mrmsg_get_summarytext</a>(mrmsg_t *msg, int approx_characters)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#ae549e58d9ae2f73ad76bd27636b43982">mrmsg_get_text</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a705454903b36ded8c3cd43a2044de60a">mrmsg_get_type</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a32d23bac4bf35ed5f8c2cfbb93d636f5">mrmsg_is_increation</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48">mrmsg_new</a>()</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef">mrmsg_save_param_to_disk</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5">mrmsg_set_file</a>(mrmsg_t *msg, const char *file)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23">mrmsg_set_text</a>(mrmsg_t *msg, const char *text)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867">mrmsg_set_type</a>(mrmsg_t *msg, int type)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02">mrmsg_unref</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#ad0dcfc0a1e33d9a88b7381e368d7895a">mrmsg_get_filename</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#ad87b7df007489b3a47c3fde79978a58a">mrmsg_get_mediainfo</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a7f1bd3d845bbc5face7636aed8f8afd4">mrmsg_get_showpadlock</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5">mrmsg_get_state</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#afc3d94448ada0ad7142cf168cab1462e">mrmsg_get_summary</a>(mrmsg_t *msg, mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a8c8c1f342f01439ae40c5cf37532387e">mrmsg_get_summarytext</a>(mrmsg_t *msg, int approx_characters)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#ae549e58d9ae2f73ad76bd27636b43982">mrmsg_get_text</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a705454903b36ded8c3cd43a2044de60a">mrmsg_get_type</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a32d23bac4bf35ed5f8c2cfbb93d636f5">mrmsg_is_increation</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48">mrmsg_new</a>()</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef">mrmsg_save_param_to_disk</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5">mrmsg_set_file</a>(mrmsg_t *msg, const char *file)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23">mrmsg_set_text</a>(mrmsg_t *msg, const char *text)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867">mrmsg_set_type</a>(mrmsg_t *msg, int type)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02">mrmsg_unref</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>

615
docs/html/structmrmsg__t.html
View file

@ -127,6 +127,9 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a2544769c77af5447546fcf5fc95c64f7"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a2544769c77af5447546fcf5fc95c64f7">mrmsg_get_file</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:a2544769c77af5447546fcf5fc95c64f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find out full path, file name and extension of the file associated with a message. <a href="#a2544769c77af5447546fcf5fc95c64f7">More...</a><br /></td></tr>
<tr class="separator:a2544769c77af5447546fcf5fc95c64f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0dcfc0a1e33d9a88b7381e368d7895a"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#ad0dcfc0a1e33d9a88b7381e368d7895a">mrmsg_get_filename</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:ad0dcfc0a1e33d9a88b7381e368d7895a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get base file name without path. <a href="#ad0dcfc0a1e33d9a88b7381e368d7895a">More...</a><br /></td></tr>
<tr class="separator:ad0dcfc0a1e33d9a88b7381e368d7895a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad87b7df007489b3a47c3fde79978a58a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrpoortext__t.html">mrpoortext_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#ad87b7df007489b3a47c3fde79978a58a">mrmsg_get_mediainfo</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:ad87b7df007489b3a47c3fde79978a58a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get real author and title. <a href="#ad87b7df007489b3a47c3fde79978a58a">More...</a><br /></td></tr>
<tr class="separator:ad87b7df007489b3a47c3fde79978a58a"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -142,9 +145,8 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a32d23bac4bf35ed5f8c2cfbb93d636f5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a32d23bac4bf35ed5f8c2cfbb93d636f5">mrmsg_is_increation</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:a32d23bac4bf35ed5f8c2cfbb93d636f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a message is still in creation. <a href="#a32d23bac4bf35ed5f8c2cfbb93d636f5">More...</a><br /></td></tr>
<tr class="separator:a32d23bac4bf35ed5f8c2cfbb93d636f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bc3ce5f2ef0065547e4aee0143d22ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0bc3ce5f2ef0065547e4aee0143d22ef"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef">mrmsg_save_param_to_disk</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:a0bc3ce5f2ef0065547e4aee0143d22ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">can be used to add some additional, persistent information to a messages record. <br /></td></tr>
<tr class="memitem:a0bc3ce5f2ef0065547e4aee0143d22ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef">mrmsg_save_param_to_disk</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:a0bc3ce5f2ef0065547e4aee0143d22ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add additional, persistent information to a message record. <a href="#a0bc3ce5f2ef0065547e4aee0143d22ef">More...</a><br /></td></tr>
<tr class="separator:a0bc3ce5f2ef0065547e4aee0143d22ef"><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>
@ -187,6 +189,51 @@ Public Attributes</h2></td></tr>
<div class="textblock"><p>An object representing a single message in memory. </p>
<p>The message object is not updated. If you want an update, you have to recreate the object. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a80f470eb34af414ff28e7d3b3c715b48"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> * mrmsg_new </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create new message object. </p>
<p>Message objects are needed eg. for sending messages using <a class="el" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c" title="Send a message of any type to a chat. ">mrmailbox_send_msg()</a>. Moreover, they are returned eg. from <a class="el" href="structmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13" title="Get a single message object of the type mrmsg_t. ">mrmailbox_get_msg()</a>, set up with the current state of a message. The message object is not updated; to achieve this, you have to recreate it.</p>
<dl class="section return"><dt>Returns</dt><dd>The created message object. </dd></dl>
</div>
</div>
<a class="anchor" id="aa33212e41efff643aa7290753f3d9b02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrmsg_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free an <a class="el" href="structmrmsg__t.html" title="An object representing a single message in memory. ">mrmsg_t</a> object created eg. </p>
<p>by <a class="el" href="structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48" title="Create new message object. ">mrmsg_new()</a> or <a class="el" href="structmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13" title="Get a single message object of the type mrmsg_t. ">mrmailbox_get_msg()</a>. This also free()s all strings; so if you set up the object yourself, make sure to use strdup()!</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object to free.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a57d94b55fc918b27874b9194d6c35388"></a>
<div class="memitem">
<div class="memproto">
@ -210,6 +257,204 @@ Public Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a3581e331fe9f3f38d4c5bb1b1c8c7867"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrmsg_set_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the type of a message. </p>
<p>See <a class="el" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c" title="Send a message of any type to a chat. ">mrmailbox_send_msg()</a> for some examples.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object to modify.</td></tr>
<tr><td class="paramname">type</td><td>Type to set for the message. Possible types are MR_MSG_TEXT (10), MR_MSG_IMAGE (20), MR_MSG_GIF (21), MR_MSG_AUDIO (40), MR_MSG_VOICE (41), MR_MSG_VIDEO (50) or MR_MSG_FILE (60).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="ae940aa79a261e1a427b12baefbee2d23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrmsg_set_text </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>text</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the text of a message object. </p>
<p>The text is <em>not</em> modified in the database, this function is only a helper to set up a message object to be sent afterwards. The type of the message object is not changed implicitly to MR_MSG_TEXT when using this function. Previously set texts are free()'d.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>Message to set the text for.</td></tr>
<tr><td class="paramname">text</td><td>Text to set. The function creates a copy of the given text so that it can be free()'d just after this function is called.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a98455bee60d64b3d59d89fbbb520ddd5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrmsg_set_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the file belonging to a message. </p>
<p>The file may be an image, a video, an audio file, an PDF and so on. This function is a shortcut for mrparam_set(msg-&gt;m_param, MRP_FILE, file)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object to modify.</td></tr>
<tr><td class="paramname">file</td><td>Path, filename and extension to set for the given message.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a705454903b36ded8c3cd43a2044de60a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrmsg_get_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the type of the message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of MR_MSG_TEXT (10), MR_MSG_IMAGE (20), MR_MSG_GIF (21), MR_MSG_AUDIO (40), MR_MSG_VOICE (41), MR_MSG_VIDEO (50), MR_MSG_FILE (60) or MR_MSG_UNDEFINED (0) if the type is undefined. </dd></dl>
</div>
</div>
<a class="anchor" id="a1f411e4be17fb5fe408a1aa74cba90a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrmsg_get_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the state of a message. </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#a65215149290bec16b173106269b08e5e" 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). The state is always set by the core-library, users of the library cannot set the state directly, but it is changed implicitly eg. when calling <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#a67281e50b568dc18df710275e0e13f5b" title="Mark a message as seen, updates the IMAP state and sends MDNs. ">mrmailbox_markseen_msgs()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The state of the message. </dd></dl>
</div>
</div>
<a class="anchor" id="ae549e58d9ae2f73ad76bd27636b43982"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrmsg_get_text </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the text of the message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Message text. The result must be free()'d. </dd></dl>
</div>
</div>
<a class="anchor" id="a2544769c77af5447546fcf5fc95c64f7"></a>
@ -235,6 +480,32 @@ Public Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Full path, file name and extension of the file associated with the message. If there is no file associated with the message, an emtpy string is returned. NULL is never returned and the returned value must be free()'d. </dd></dl>
</div>
</div>
<a class="anchor" id="ad0dcfc0a1e33d9a88b7381e368d7895a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrmsg_get_filename </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get base file name without path. </p>
<p>The base file name includes the extension; the path is not returned. To get the full path, use <a class="el" href="structmrmsg__t.html#a2544769c77af5447546fcf5fc95c64f7" title="Find out full path, file name and extension of the file associated with a message. ">mrmsg_get_file()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>the message object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>base file name plus extension without part. If there is no file associated with the message, an empty string is returned. The returned value must be free()'d. </dd></dl>
</div>
</div>
<a class="anchor" id="ad87b7df007489b3a47c3fde79978a58a"></a>
@ -289,43 +560,6 @@ Public Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1=padlock should be shown beside message, 0=do not show a padlock beside the message. </dd></dl>
</div>
</div>
<a class="anchor" id="a1f411e4be17fb5fe408a1aa74cba90a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrmsg_get_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the state of a message. </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#a65215149290bec16b173106269b08e5e" 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). The state is always set by the core-library, users of the library cannot set the state directly, but it is changed implicitly eg. when calling <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#a67281e50b568dc18df710275e0e13f5b" title="Mark a message as seen, updates the IMAP state and sends MDNs. ">mrmailbox_markseen_msgs()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The state of the message. </dd></dl>
</div>
</div>
<a class="anchor" id="afc3d94448ada0ad7142cf168cab1462e"></a>
@ -400,56 +634,6 @@ Public Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A summary for the given messages. The returned string must be free()'d. </dd></dl>
</div>
</div>
<a class="anchor" id="ae549e58d9ae2f73ad76bd27636b43982"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrmsg_get_text </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the text of the message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Message text. The result must be free()'d. </dd></dl>
</div>
</div>
<a class="anchor" id="a705454903b36ded8c3cd43a2044de60a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrmsg_get_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the type of the message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of MR_MSG_TEXT (10), MR_MSG_IMAGE (20), MR_MSG_GIF (21), MR_MSG_AUDIO (40), MR_MSG_VOICE (41), MR_MSG_VIDEO (50), MR_MSG_FILE (60) or MR_MSG_UNDEFINED (0) if the type is undefined. </dd></dl>
</div>
</div>
<a class="anchor" id="a32d23bac4bf35ed5f8c2cfbb93d636f5"></a>
@ -467,7 +651,8 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<p>Check if a message is still in creation. </p>
<p>The user can mark files as being in creation by simply creating a file <code>&lt;filename&gt;.increation</code>. If <code>&lt;filename&gt;</code> is created then, the user should just delete <code>&lt;filename&gt;.increation</code></p>
<p>The user can mark files as being in creation by simply creating a file <code>&lt;filename&gt;.increation</code>. If <code>&lt;filename&gt;</code> is created then, the user should just delete <code>&lt;filename&gt;.increation</code>.</p>
<p>Typically, this is used for videos that should be recoded by the user before they can be sent.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>the message object</td></tr>
@ -478,142 +663,12 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a class="anchor" id="a80f470eb34af414ff28e7d3b3c715b48"></a>
<a class="anchor" id="a0bc3ce5f2ef0065547e4aee0143d22ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> * mrmsg_new </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create new message object. </p>
<p>Message objects are needed eg. for sending messages using <a class="el" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c" title="Send a message of any type to a chat. ">mrmailbox_send_msg()</a>. Moreover, they are returned eg. from <a class="el" href="structmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13" title="Get a single message object of the type mrmsg_t. ">mrmailbox_get_msg()</a>, set up with the current state of a message. The message object is not updated; to achieve this, you have to recreate it.</p>
<dl class="section return"><dt>Returns</dt><dd>The created message object. </dd></dl>
</div>
</div>
<a class="anchor" id="a98455bee60d64b3d59d89fbbb520ddd5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrmsg_set_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the file belonging to a message. </p>
<p>The file may be an image, a video, an audio file, an PDF and so on. This function is a shortcut for mrparam_set(msg-&gt;m_param, MRP_FILE, file)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object to modify.</td></tr>
<tr><td class="paramname">file</td><td>Path, filename and extension to set for the given message.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="ae940aa79a261e1a427b12baefbee2d23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrmsg_set_text </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>text</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the text of a message object. </p>
<p>The text is <em>not</em> modified in the database, this function is only a helper to set up a message object to be sent afterwards. The type of the message object is not changed implicitly to MR_MSG_TEXT when using this function. Previously set texts are free()'d.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>Message to set the text for.</td></tr>
<tr><td class="paramname">text</td><td>Text to set. The function creates a copy of the given text so that it can be free()'d just after this function is called.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a3581e331fe9f3f38d4c5bb1b1c8c7867"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrmsg_set_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the type of a message. </p>
<p>See <a class="el" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c" title="Send a message of any type to a chat. ">mrmailbox_send_msg()</a> for some examples.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object to modify.</td></tr>
<tr><td class="paramname">type</td><td>Type to set for the message. Possible types are MR_MSG_TEXT (10), MR_MSG_IMAGE (20), MR_MSG_GIF (21), MR_MSG_AUDIO (40), MR_MSG_VOICE (41), MR_MSG_VIDEO (50) or MR_MSG_FILE (60).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="aa33212e41efff643aa7290753f3d9b02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrmsg_unref </td>
<td class="memname">void mrmsg_save_param_to_disk </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
@ -622,11 +677,11 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Free an <a class="el" href="structmrmsg__t.html" title="An object representing a single message in memory. ">mrmsg_t</a> object created eg. </p>
<p>by <a class="el" href="structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48" title="Create new message object. ">mrmsg_new()</a> or <a class="el" href="structmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13" title="Get a single message object of the type mrmsg_t. ">mrmailbox_get_msg()</a>. This also free()s all strings; so if you set up the object yourself, make sure to use strdup()!</p>
<p>Add additional, persistent information to a message record. </p>
<p>Normally, this function is not needed; message records are created by <a class="el" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c" title="Send a message of any type to a chat. ">mrmailbox_send_msg()</a> or <a class="el" href="structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b" title="Send a simple text message to the given chat. ">mrmailbox_send_text_msg()</a> and modified by actions of the user. However, for rare cases, it might be necessary to save an paramter later to disk. For this purpose, use this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object to free.</td></tr>
<tr><td class="paramname">msg</td><td>The message object.</td></tr>
</table>
</dd>
</dl>
@ -635,36 +690,6 @@ Public Attributes</h2></td></tr>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ac19bdc40e452c8997dd58474a7be6880"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t mrmsg_t::m_chat_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Chat ID the message belongs to. </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 chat object by a chat ID. ">mrmailbox_get_chat()</a> to load details about the chat. </p>
</div>
</div>
<a class="anchor" id="a299981cb89b25ebaaedf7a8486a86ee6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t mrmsg_t::m_from_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Contact ID of the sender. </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>
<a class="anchor" id="a793898c8da24c717dc2bb1d91faac801"></a>
<div class="memitem">
<div class="memproto">
@ -685,48 +710,78 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a class="anchor" id="aa4fbc319d61c755ce929e658ad75b21e"></a>
<a class="anchor" id="a299981cb89b25ebaaedf7a8486a86ee6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrmsg_t::m_is_msgrmsg</td>
<td class="memname">uint32_t mrmsg_t::m_from_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set to 1 if the message was sent by another messenger. </p>
<p>0 otherwise. </p>
<p>Contact ID of the sender. </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>
<a class="anchor" id="a2c31ec5b23e35fbe3ae3896eece09453"></a>
<a class="anchor" id="ad549fc02587ba284fda2bbecd162b16a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmrparam__t.html">mrparam_t</a>* mrmsg_t::m_param</td>
<td class="memname">uint32_t mrmsg_t::m_to_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Additional paramter for the message. </p>
<p>MRP_FILE, MRP_WIDTH, MRP_HEIGHT etc. depends on the type. Never a NULL-pointer. </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>
<a class="anchor" id="a0570bbfc3add48dafb0ae70390b47adb"></a>
<a class="anchor" id="ac19bdc40e452c8997dd58474a7be6880"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrmsg_t::m_starred</td>
<td class="memname">uint32_t mrmsg_t::m_chat_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Starred-state of the message. </p>
<p>0=no, 1=yes. </p>
<p>Chat ID the message belongs to. </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 chat object by a chat ID. ">mrmailbox_get_chat()</a> to load details about the chat. </p>
</div>
</div>
<a class="anchor" id="aba09cb77cdabd1e2b2e6262d25388801"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">time_t mrmsg_t::m_timestamp</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unix time the message was sended or received. </p>
<p>0 if unset. </p>
</div>
</div>
<a class="anchor" id="a3896e269c90cbf0f563ab0848fb44c65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrmsg_t::m_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Message type. </p>
<p>It is recommended to use <a class="el" href="structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867" title="Set the type of a message. ">mrmsg_set_type()</a> and <a class="el" href="structmrmsg__t.html#a705454903b36ded8c3cd43a2044de60a" title="Get the type of the message. ">mrmsg_get_type()</a> to access this field. </p>
</div>
</div>
@ -760,48 +815,48 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a class="anchor" id="aba09cb77cdabd1e2b2e6262d25388801"></a>
<a class="anchor" id="a2c31ec5b23e35fbe3ae3896eece09453"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">time_t mrmsg_t::m_timestamp</td>
<td class="memname"><a class="el" href="structmrparam__t.html">mrparam_t</a>* mrmsg_t::m_param</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unix time the message was sended or received. </p>
<p>0 if unset. </p>
<p>Additional paramter for the message. </p>
<p>MRP_FILE, MRP_WIDTH, MRP_HEIGHT etc. depends on the type. Never a NULL-pointer. </p>
</div>
</div>
<a class="anchor" id="ad549fc02587ba284fda2bbecd162b16a"></a>
<a class="anchor" id="a0570bbfc3add48dafb0ae70390b47adb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t mrmsg_t::m_to_id</td>
<td class="memname">int mrmsg_t::m_starred</td>
</tr>
</table>
</div><div class="memdoc">
<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>
<p>Starred-state of the message. </p>
<p>0=no, 1=yes. </p>
</div>
</div>
<a class="anchor" id="a3896e269c90cbf0f563ab0848fb44c65"></a>
<a class="anchor" id="aa4fbc319d61c755ce929e658ad75b21e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrmsg_t::m_type</td>
<td class="memname">int mrmsg_t::m_is_msgrmsg</td>
</tr>
</table>
</div><div class="memdoc">
<p>Message type. </p>
<p>It is recommended to use <a class="el" href="structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867" title="Set the type of a message. ">mrmsg_set_type()</a> and <a class="el" href="structmrmsg__t.html#a705454903b36ded8c3cd43a2044de60a" title="Get the type of the message. ">mrmsg_get_type()</a> to access this field. </p>
<p>Set to 1 if the message was sent by another messenger. </p>
<p>0 otherwise. </p>
</div>
</div>

60
docs/html/structmrpoortext__t.html
View file

@ -150,36 +150,6 @@ Public Attributes</h2></td></tr>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="afbf2ae7473784db66127e63657e04f60"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrpoortext_t::m_state</td>
</tr>
</table>
</div><div class="memdoc">
<p>Typically a MR_MSG_STATE_* constant. </p>
<p>May be 0. </p>
</div>
</div>
<a class="anchor" id="af3b56661ccf1c783f397c15c310cf36f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrpoortext_t::m_text1</td>
</tr>
</table>
</div><div class="memdoc">
<p>The meaning is defined by m_text1_meaning and by the creator of the object. </p>
<p>May be NULL. </p>
</div>
</div>
<a class="anchor" id="a39469bd76b12fc8da2c3341433cab893"></a>
<div class="memitem">
<div class="memproto">
@ -198,6 +168,21 @@ Public Attributes</h2></td></tr>
<li>MR_TEXT1_SELF = m_text1 is the string "Me", typically, this is shown in another color. </li>
</ul>
</div>
</div>
<a class="anchor" id="af3b56661ccf1c783f397c15c310cf36f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrpoortext_t::m_text1</td>
</tr>
</table>
</div><div class="memdoc">
<p>The meaning is defined by m_text1_meaning and by the creator of the object. </p>
<p>May be NULL. </p>
</div>
</div>
<a class="anchor" id="a54e10365f38dddd070a2ab68f4177331"></a>
@ -228,6 +213,21 @@ Public Attributes</h2></td></tr>
<p>Typically a message timestamp. </p>
<p>The concrete meaning is defined by the creator of the object. May be 0. </p>
</div>
</div>
<a class="anchor" id="afbf2ae7473784db66127e63657e04f60"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrpoortext_t::m_state</td>
</tr>
</table>
</div><div class="memdoc">
<p>Typically a MR_MSG_STATE_* constant. </p>
<p>May be 0. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>