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

Doxygen

Browse source
This commit is contained in:
B. Petersen 2017-11-15 14:03:27 +01:00
parent 3164d2ce06
commit df70de42c1
12 changed files with 277 additions and 190 deletions
Download patch file Download diff file Expand all files Collapse all files

237
docs/html/mrevent_8h.html
View file

@ -130,40 +130,36 @@ Macros</h2></td></tr>
<tr class="memdesc:a3be5f7ee95e6d0a8066e7a839f38c30f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configurartion enden. <a href="#a3be5f7ee95e6d0a8066e7a839f38c30f">More...</a><br /></td></tr>
<tr class="separator:a3be5f7ee95e6d0a8066e7a839f38c30f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb0881d4c7c887b8f371cedc471846b5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#abb0881d4c7c887b8f371cedc471846b5">MR_EVENT_CONFIGURE_PROGRESS</a>&#160;&#160;&#160;2041</td></tr>
<tr class="memdesc:abb0881d4c7c887b8f371cedc471846b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inform about the configuration progress. <a href="#abb0881d4c7c887b8f371cedc471846b5">More...</a><br /></td></tr>
<tr class="memdesc:abb0881d4c7c887b8f371cedc471846b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inform about the configuration progress started by <a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. <a href="#abb0881d4c7c887b8f371cedc471846b5">More...</a><br /></td></tr>
<tr class="separator:abb0881d4c7c887b8f371cedc471846b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10211bf20ad64f8f6d635120ca64f374"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a10211bf20ad64f8f6d635120ca64f374">MR_EVENT_IMEX_ENDED</a>&#160;&#160;&#160;2050</td></tr>
<tr class="memdesc:a10211bf20ad64f8f6d635120ca64f374"><td class="mdescLeft">&#160;</td><td class="mdescRight">Import/export done. <a href="#a10211bf20ad64f8f6d635120ca64f374">More...</a><br /></td></tr>
<tr class="separator:a10211bf20ad64f8f6d635120ca64f374"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af046556dbd33f0bff86448d62df2b5f7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#af046556dbd33f0bff86448d62df2b5f7">MR_EVENT_IMEX_PROGRESS</a>&#160;&#160;&#160;2051</td></tr>
<tr class="memdesc:af046556dbd33f0bff86448d62df2b5f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inform about the import/export progress. <a href="#af046556dbd33f0bff86448d62df2b5f7">More...</a><br /></td></tr>
<tr class="memdesc:af046556dbd33f0bff86448d62df2b5f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inform about the import/export progress started by <a class="el" href="structmrmailbox__t.html#a5de7b87b8c95733619cc4051b3508973" title="Import/export things. ">mrmailbox_imex()</a>. <a href="#af046556dbd33f0bff86448d62df2b5f7">More...</a><br /></td></tr>
<tr class="separator:af046556dbd33f0bff86448d62df2b5f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb3ce82a01722f902b02c8e62cf301ab"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#aeb3ce82a01722f902b02c8e62cf301ab">MR_EVENT_IMEX_FILE_WRITTEN</a>&#160;&#160;&#160;2052</td></tr>
<tr class="memdesc:aeb3ce82a01722f902b02c8e62cf301ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">file written, event may be needed to make the file public to some system services. <a href="#aeb3ce82a01722f902b02c8e62cf301ab">More...</a><br /></td></tr>
<tr class="memdesc:aeb3ce82a01722f902b02c8e62cf301ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">A file has been exported. <a href="#aeb3ce82a01722f902b02c8e62cf301ab">More...</a><br /></td></tr>
<tr class="separator:aeb3ce82a01722f902b02c8e62cf301ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6edb5df61b9fda091f36074e20d2b04"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6edb5df61b9fda091f36074e20d2b04"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#ab6edb5df61b9fda091f36074e20d2b04">MR_EVENT_IS_ONLINE</a>&#160;&#160;&#160;2080</td></tr>
<tr class="memdesc:ab6edb5df61b9fda091f36074e20d2b04"><td class="mdescLeft">&#160;</td><td class="mdescRight">check, if the system is online currently ret=0: not online, ret=1: online <br /></td></tr>
<tr class="separator:ab6edb5df61b9fda091f36074e20d2b04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf5dbdab58ffcf836d65cd91283b701a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf5dbdab58ffcf836d65cd91283b701a"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#aaf5dbdab58ffcf836d65cd91283b701a">MR_EVENT_GET_STRING</a>&#160;&#160;&#160;2091</td></tr>
<tr class="memdesc:aaf5dbdab58ffcf836d65cd91283b701a"><td class="mdescLeft">&#160;</td><td class="mdescRight">get a string from the frontend, data1=MR_STR_*, ret=string which will be free()'d by the backend <br /></td></tr>
<tr class="memitem:a9cc59f2599dc071ebe686b3dd9eb5ae2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a9cc59f2599dc071ebe686b3dd9eb5ae2">MR_EVENT_IS_OFFLINE</a>&#160;&#160;&#160;2081</td></tr>
<tr class="memdesc:a9cc59f2599dc071ebe686b3dd9eb5ae2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ask the frontend about the offline state. <a href="#a9cc59f2599dc071ebe686b3dd9eb5ae2">More...</a><br /></td></tr>
<tr class="separator:a9cc59f2599dc071ebe686b3dd9eb5ae2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf5dbdab58ffcf836d65cd91283b701a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#aaf5dbdab58ffcf836d65cd91283b701a">MR_EVENT_GET_STRING</a>&#160;&#160;&#160;2091</td></tr>
<tr class="memdesc:aaf5dbdab58ffcf836d65cd91283b701a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Requeste a localized string from the frontend. <a href="#aaf5dbdab58ffcf836d65cd91283b701a">More...</a><br /></td></tr>
<tr class="separator:aaf5dbdab58ffcf836d65cd91283b701a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a465a35db3742af9f1a3e39b2ede585da"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a465a35db3742af9f1a3e39b2ede585da"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a465a35db3742af9f1a3e39b2ede585da">MR_EVENT_GET_QUANTITY_STRING</a>&#160;&#160;&#160;2092</td></tr>
<tr class="memdesc:a465a35db3742af9f1a3e39b2ede585da"><td class="mdescLeft">&#160;</td><td class="mdescRight">synchronous http/https(!) call, data1=url, ret=content which will be free()'d by the backend, 0 on errors <br /></td></tr>
<tr class="memitem:a465a35db3742af9f1a3e39b2ede585da"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a465a35db3742af9f1a3e39b2ede585da">MR_EVENT_GET_QUANTITY_STRING</a>&#160;&#160;&#160;2092</td></tr>
<tr class="memdesc:a465a35db3742af9f1a3e39b2ede585da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Requeste a localized quantitiy string from the frontend. <a href="#a465a35db3742af9f1a3e39b2ede585da">More...</a><br /></td></tr>
<tr class="separator:a465a35db3742af9f1a3e39b2ede585da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba8b1a46a18cd05070b301c757a74ddc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba8b1a46a18cd05070b301c757a74ddc"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#aba8b1a46a18cd05070b301c757a74ddc">MR_EVENT_HTTP_GET</a>&#160;&#160;&#160;2100</td></tr>
<tr class="memdesc:aba8b1a46a18cd05070b301c757a74ddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">synchronous http/https(!) call, data1=url, ret=content which will be free()'d by the backend, 0 on errors <br /></td></tr>
<tr class="memitem:aba8b1a46a18cd05070b301c757a74ddc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#aba8b1a46a18cd05070b301c757a74ddc">MR_EVENT_HTTP_GET</a>&#160;&#160;&#160;2100</td></tr>
<tr class="memdesc:aba8b1a46a18cd05070b301c757a74ddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request a HTTP-file from the frontend. <a href="#aba8b1a46a18cd05070b301c757a74ddc">More...</a><br /></td></tr>
<tr class="separator:aba8b1a46a18cd05070b301c757a74ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8312b0e8f1e7422300a5502d86e0db01"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8312b0e8f1e7422300a5502d86e0db01"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a8312b0e8f1e7422300a5502d86e0db01">MR_EVENT_WAKE_LOCK</a>&#160;&#160;&#160;2110</td></tr>
<tr class="memdesc:a8312b0e8f1e7422300a5502d86e0db01"><td class="mdescLeft">&#160;</td><td class="mdescRight">acquire wakeLock (data1=1) or release it (data1=0), the backend does not make nested or unsynchronized calls <br /></td></tr>
<tr class="memitem:a8312b0e8f1e7422300a5502d86e0db01"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a8312b0e8f1e7422300a5502d86e0db01">MR_EVENT_WAKE_LOCK</a>&#160;&#160;&#160;2110</td></tr>
<tr class="memdesc:a8312b0e8f1e7422300a5502d86e0db01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acquire or release a wakelock. <a href="#a8312b0e8f1e7422300a5502d86e0db01">More...</a><br /></td></tr>
<tr class="separator:a8312b0e8f1e7422300a5502d86e0db01"><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>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>
<div class="memitem">
@ -178,8 +174,8 @@ Macros</h2></td></tr>
<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>
<tr><td class="paramname">data1</td><td>chat_id</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
@ -198,10 +194,11 @@ Macros</h2></td></tr>
</div><div class="memdoc">
<p>Configurartion enden. </p>
<p>You'll get this event from a call to <a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a> </p><dl class="params"><dt>Parameters</dt><dd>
<p>You'll get this event from a call to <a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387" 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>0=failed-not-connected, 1=configured-and-connected </td></tr>
<tr><td class="paramname">data2</td><td>0 </td></tr>
<tr><td class="paramname">data1</td><td>0=failed-not-connected, 1=configured-and-connected</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
@ -219,11 +216,12 @@ Macros</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Inform about the configuration progress. </p>
<p>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>
<p>Inform about the configuration progress started by <a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. </p>
<p>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>permille </td></tr>
<tr><td class="paramname">data2</td><td>0 </td></tr>
<tr><td class="paramname">data1</td><td>permille</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
@ -244,8 +242,8 @@ Macros</h2></td></tr>
<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>
<tr><td class="paramname">data1</td><td>0</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
@ -264,15 +262,83 @@ Macros</h2></td></tr>
</div><div class="memdoc">
<p>The user should show an error. </p>
<p>The error must be reported to the user by a non-disturbing bubble or so. </p><dl class="params"><dt>Parameters</dt><dd>
<p>The error must be reported to the user by a non-disturbing bubble or so.</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>Error string </td></tr>
<tr><td class="paramname">data1</td><td>0</td></tr>
<tr><td class="paramname">data2</td><td>Error string</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </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="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>
@ -286,10 +352,11 @@ Macros</h2></td></tr>
</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>
<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>
<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>
@ -307,8 +374,17 @@ Macros</h2></td></tr>
</table>
</div><div class="memdoc">
<p>file written, event may be needed to make the file public to some system services. </p>
<p>data1=file name, data2=mime type </p>
<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>
@ -322,11 +398,11 @@ Macros</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Inform about the import/export progress. </p>
<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>Permille</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
@ -345,10 +421,11 @@ Macros</h2></td></tr>
</div><div class="memdoc">
<p>There is a fresh message. </p>
<p>Typically, the user will show an notification when receiving this message. </p><dl class="params"><dt>Parameters</dt><dd>
<p>Typically, the user will show an notification when receiving this message.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>chat_id </td></tr>
<tr><td class="paramname">data2</td><td>msg_id </td></tr>
<tr><td class="paramname">data1</td><td>chat_id</td></tr>
<tr><td class="paramname">data2</td><td>msg_id</td></tr>
</table>
</dd>
</dl>
@ -367,15 +444,39 @@ Macros</h2></td></tr>
</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>
<p>Passed to the callback given to <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>. This event should not be reported using a popup or something like that.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>0 </td></tr>
<tr><td class="paramname">data2</td><td>Info string </td></tr>
<tr><td class="paramname">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>
@ -391,8 +492,8 @@ Macros</h2></td></tr>
<p>A single message is send successfully (state changed from MR_STATE_OUT_PENDING to MR_STATE_OUT_DELIVERED, see <a class="el" href="structmrmsg__t.html#aca59d28054d3e15b4fe6ca74073d91f4" title="Message state. ">mrmsg_t::m_state</a>). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>chat_id </td></tr>
<tr><td class="paramname">data2</td><td>msg_id </td></tr>
<tr><td class="paramname">data1</td><td>chat_id</td></tr>
<tr><td class="paramname">data2</td><td>msg_id</td></tr>
</table>
</dd>
</dl>
@ -413,8 +514,8 @@ Macros</h2></td></tr>
<p>A single message is read by the receiver (state changed from MR_STATE_OUT_DELIVERED to MR_STATE_OUT_MDN_RCVD, see <a class="el" href="structmrmsg__t.html#aca59d28054d3e15b4fe6ca74073d91f4" title="Message state. ">mrmsg_t::m_state</a>). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>chat_id </td></tr>
<tr><td class="paramname">data2</td><td>msg_id </td></tr>
<tr><td class="paramname">data1</td><td>chat_id</td></tr>
<tr><td class="paramname">data2</td><td>msg_id</td></tr>
</table>
</dd>
</dl>
@ -436,8 +537,31 @@ Macros</h2></td></tr>
<p>Messages may be added or removed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>chat_id for single added messages </td></tr>
<tr><td class="paramname">data2</td><td>msg_id for single added messages </td></tr>
<tr><td class="paramname">data1</td><td>chat_id for single added messages</td></tr>
<tr><td class="paramname">data2</td><td>msg_id for single added messages</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="a8312b0e8f1e7422300a5502d86e0db01"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_WAKE_LOCK&#160;&#160;&#160;2110</td>
</tr>
</table>
</div><div class="memdoc">
<p>Acquire or release a wakelock. </p>
<p>The core surrounds critcal functions that should not be killed by the operating system with wakelocks. Before a critical function <em>MR_EVENT_WAKE_LOCK with data1=1</em> is called, it it finishes, <em>MR_EVENT_WAKE_LOCK with data1=0</em> is called. If you do not need this functionality, just ignore this event.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>1=acquire wakelock, 0=release wakelock, the core does not make nested or unsynchronized calls</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
@ -456,10 +580,11 @@ Macros</h2></td></tr>
</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>
<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>
<tr><td class="paramname">data1</td><td>0</td></tr>
<tr><td class="paramname">data2</td><td>Warning string</td></tr>
</table>
</dd>
</dl>