mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-05 10:39:27 +02:00
doxygen
This commit is contained in:
parent
2dd616d1e7
commit
e0234562f3
21 changed files with 7340 additions and 0 deletions
104
docs/html/classmrarray__t-members.html
Normal file
104
docs/html/classmrarray__t-members.html
Normal file
|
@ -0,0 +1,104 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||||||
|
<title>Delta Chat Core C-API: Member List</title>
|
||||||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||||||
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||||
|
<script type="text/javascript" src="search/search.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(document).ready(function() { init_search(); });
|
||||||
|
</script>
|
||||||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">Delta Chat Core C-API
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!-- end header part -->
|
||||||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||||
|
</script>
|
||||||
|
<div id="navrow1" class="tabs">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||||
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||||||
|
<li>
|
||||||
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||||
|
<span class="left">
|
||||||
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
alt=""/>
|
||||||
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||||
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||||
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||||
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||||
|
</span><span class="right">
|
||||||
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div id="navrow2" class="tabs2">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!-- window showing the filter options -->
|
||||||
|
<div id="MSearchSelectWindow"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- iframe showing the search results (closed by default) -->
|
||||||
|
<div id="MSearchResultsWindow">
|
||||||
|
<iframe src="javascript:void(0)" frameborder="0"
|
||||||
|
name="MSearchResults" id="MSearchResults">
|
||||||
|
</iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div><!-- top -->
|
||||||
|
<div class="header">
|
||||||
|
<div class="headertitle">
|
||||||
|
<div class="title">mrarray_t Member List</div> </div>
|
||||||
|
</div><!--header-->
|
||||||
|
<div class="contents">
|
||||||
|
|
||||||
|
<p>This is the complete list of members for <a class="el" href="classmrarray__t.html">mrarray_t</a>, including all inherited members.</p>
|
||||||
|
<table class="directory">
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrarray__t.html#a73f6d954ed1b97bbceb3cf7d8e1aeec8">mrarray_get_cnt</a>(mrarray_t *array)</td><td class="entry"><a class="el" href="classmrarray__t.html">mrarray_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrarray__t.html#a40b1e875ba256b6ccbbe65f58bbc01ec">mrarray_get_id</a>(mrarray_t *array, size_t index)</td><td class="entry"><a class="el" href="classmrarray__t.html">mrarray_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrarray__t.html#a24637c94b99b8aaa0b7608dca9e4996b">mrarray_get_ptr</a>(mrarray_t *array, size_t index)</td><td class="entry"><a class="el" href="classmrarray__t.html">mrarray_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrarray__t.html#a32e441acbb4de2f4afba7bc2712293e0">mrarray_get_uint</a>(mrarray_t *array, size_t index)</td><td class="entry"><a class="el" href="classmrarray__t.html">mrarray_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrarray__t.html#a1400b5e42c682326e809723f02739a8e">mrarray_unref</a>(mrarray_t *array)</td><td class="entry"><a class="el" href="classmrarray__t.html">mrarray_t</a></td><td class="entry"></td></tr>
|
||||||
|
</table></div><!-- contents -->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||||
|
</a> 1.8.11
|
||||||
|
</small></address>
|
||||||
|
</body>
|
||||||
|
</html>
|
290
docs/html/classmrarray__t.html
Normal file
290
docs/html/classmrarray__t.html
Normal file
|
@ -0,0 +1,290 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||||||
|
<title>Delta Chat Core C-API: mrarray_t Class Reference</title>
|
||||||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||||||
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||||
|
<script type="text/javascript" src="search/search.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(document).ready(function() { init_search(); });
|
||||||
|
</script>
|
||||||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">Delta Chat Core C-API
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!-- end header part -->
|
||||||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||||
|
</script>
|
||||||
|
<div id="navrow1" class="tabs">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||||
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||||||
|
<li>
|
||||||
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||||
|
<span class="left">
|
||||||
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
alt=""/>
|
||||||
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||||
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||||
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||||
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||||
|
</span><span class="right">
|
||||||
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div id="navrow2" class="tabs2">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!-- window showing the filter options -->
|
||||||
|
<div id="MSearchSelectWindow"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- iframe showing the search results (closed by default) -->
|
||||||
|
<div id="MSearchResultsWindow">
|
||||||
|
<iframe src="javascript:void(0)" frameborder="0"
|
||||||
|
name="MSearchResults" id="MSearchResults">
|
||||||
|
</iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div><!-- top -->
|
||||||
|
<div class="header">
|
||||||
|
<div class="summary">
|
||||||
|
<a href="#pub-methods">Public Member Functions</a> |
|
||||||
|
<a href="classmrarray__t-members.html">List of all members</a> </div>
|
||||||
|
<div class="headertitle">
|
||||||
|
<div class="title">mrarray_t Class Reference</div> </div>
|
||||||
|
</div><!--header-->
|
||||||
|
<div class="contents">
|
||||||
|
|
||||||
|
<p>An object containing a simple array.
|
||||||
|
<a href="classmrarray__t.html#details">More...</a></p>
|
||||||
|
|
||||||
|
<p><code>#include <<a class="el" href="mrarray_8h_source.html">mrarray.h</a>></code></p>
|
||||||
|
<table class="memberdecls">
|
||||||
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||||
|
Public Member Functions</h2></td></tr>
|
||||||
|
<tr class="memitem:a1400b5e42c682326e809723f02739a8e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrarray__t.html#a1400b5e42c682326e809723f02739a8e">mrarray_unref</a> (<a class="el" href="classmrarray__t.html">mrarray_t</a> *array)</td></tr>
|
||||||
|
<tr class="memdesc:a1400b5e42c682326e809723f02739a8e"><td class="mdescLeft"> </td><td class="mdescRight">Free an array object. <a href="#a1400b5e42c682326e809723f02739a8e">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a1400b5e42c682326e809723f02739a8e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a73f6d954ed1b97bbceb3cf7d8e1aeec8"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrarray__t.html#a73f6d954ed1b97bbceb3cf7d8e1aeec8">mrarray_get_cnt</a> (<a class="el" href="classmrarray__t.html">mrarray_t</a> *array)</td></tr>
|
||||||
|
<tr class="memdesc:a73f6d954ed1b97bbceb3cf7d8e1aeec8"><td class="mdescLeft"> </td><td class="mdescRight">Find out the number of items in an array. <a href="#a73f6d954ed1b97bbceb3cf7d8e1aeec8">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a73f6d954ed1b97bbceb3cf7d8e1aeec8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a32e441acbb4de2f4afba7bc2712293e0"><td class="memItemLeft" align="right" valign="top">uintptr_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrarray__t.html#a32e441acbb4de2f4afba7bc2712293e0">mrarray_get_uint</a> (<a class="el" href="classmrarray__t.html">mrarray_t</a> *array, size_t index)</td></tr>
|
||||||
|
<tr class="memdesc:a32e441acbb4de2f4afba7bc2712293e0"><td class="mdescLeft"> </td><td class="mdescRight">Get the item at the given index as an unsigned integer. <a href="#a32e441acbb4de2f4afba7bc2712293e0">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a32e441acbb4de2f4afba7bc2712293e0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a40b1e875ba256b6ccbbe65f58bbc01ec"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrarray__t.html#a40b1e875ba256b6ccbbe65f58bbc01ec">mrarray_get_id</a> (<a class="el" href="classmrarray__t.html">mrarray_t</a> *array, size_t index)</td></tr>
|
||||||
|
<tr class="memdesc:a40b1e875ba256b6ccbbe65f58bbc01ec"><td class="mdescLeft"> </td><td class="mdescRight">Get the item at the given index as an ID. <a href="#a40b1e875ba256b6ccbbe65f58bbc01ec">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a40b1e875ba256b6ccbbe65f58bbc01ec"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a24637c94b99b8aaa0b7608dca9e4996b"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrarray__t.html#a24637c94b99b8aaa0b7608dca9e4996b">mrarray_get_ptr</a> (<a class="el" href="classmrarray__t.html">mrarray_t</a> *array, size_t index)</td></tr>
|
||||||
|
<tr class="memdesc:a24637c94b99b8aaa0b7608dca9e4996b"><td class="mdescLeft"> </td><td class="mdescRight">Get the item at the given index as an ID. <a href="#a24637c94b99b8aaa0b7608dca9e4996b">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a24637c94b99b8aaa0b7608dca9e4996b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
</table>
|
||||||
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||||
|
<div class="textblock"><p>An object containing 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="classmrarray__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="classmrarray__t.html">mrarray_t</a> * </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="classmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>, <a class="el" href="classmrmailbox__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">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">size_t mrarray_get_cnt </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrarray__t.html">mrarray_t</a> * </td>
|
||||||
|
<td class="paramname"><em>array</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Find out the number of items in an array. </p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">array</td><td>The array object.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>Returns the number of items in a <a class="el" href="classmrarray__t.html" title="An object containing a simple array. ">mrarray_t</a> object. 0 on errors or if the array is empty. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a32e441acbb4de2f4afba7bc2712293e0"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">uintptr_t mrarray_get_uint </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrarray__t.html">mrarray_t</a> * </td>
|
||||||
|
<td class="paramname"><em>array</em>, </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="paramkey"></td>
|
||||||
|
<td></td>
|
||||||
|
<td class="paramtype">size_t </td>
|
||||||
|
<td class="paramname"><em>index</em> </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td></td>
|
||||||
|
<td>)</td>
|
||||||
|
<td></td><td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get the item at the given index as an unsigned integer. </p>
|
||||||
|
<p>The size of the integer is always larget enough to hold a pointer.</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">array</td><td>The array object. </td></tr>
|
||||||
|
<tr><td class="paramname">index</td><td>Index of the item to get. Must be between 0 and <a class="el" href="classmrarray__t.html#a73f6d954ed1b97bbceb3cf7d8e1aeec8" title="Find out the number of items in an array. ">mrarray_get_cnt()</a>-1.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</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="a40b1e875ba256b6ccbbe65f58bbc01ec"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">uint32_t mrarray_get_id </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrarray__t.html">mrarray_t</a> * </td>
|
||||||
|
<td class="paramname"><em>array</em>, </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="paramkey"></td>
|
||||||
|
<td></td>
|
||||||
|
<td class="paramtype">size_t </td>
|
||||||
|
<td class="paramname"><em>index</em> </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td></td>
|
||||||
|
<td>)</td>
|
||||||
|
<td></td><td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get the item at the given index as an ID. </p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">array</td><td>The array object. </td></tr>
|
||||||
|
<tr><td class="paramname">index</td><td>Index of the item to get. Must be between 0 and <a class="el" href="classmrarray__t.html#a73f6d954ed1b97bbceb3cf7d8e1aeec8" title="Find out the number of items in an array. ">mrarray_get_cnt()</a>-1.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</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="a24637c94b99b8aaa0b7608dca9e4996b"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">void * mrarray_get_ptr </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrarray__t.html">mrarray_t</a> * </td>
|
||||||
|
<td class="paramname"><em>array</em>, </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="paramkey"></td>
|
||||||
|
<td></td>
|
||||||
|
<td class="paramtype">size_t </td>
|
||||||
|
<td class="paramname"><em>index</em> </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td></td>
|
||||||
|
<td>)</td>
|
||||||
|
<td></td><td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get the item at the given index as an ID. </p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">array</td><td>The array object. </td></tr>
|
||||||
|
<tr><td class="paramname">index</td><td>Index of the item to get. Must be between 0 and <a class="el" href="classmrarray__t.html#a73f6d954ed1b97bbceb3cf7d8e1aeec8" title="Find out the number of items in an array. ">mrarray_get_cnt()</a>-1.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</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>
|
||||||
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||||
|
<li>/home/bpetersen/projects/deltachat-core/src/<a class="el" href="mrarray_8h_source.html">mrarray.h</a></li>
|
||||||
|
<li>/home/bpetersen/projects/deltachat-core/src/mrarray.c</li>
|
||||||
|
</ul>
|
||||||
|
</div><!-- contents -->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||||
|
</a> 1.8.11
|
||||||
|
</small></address>
|
||||||
|
</body>
|
||||||
|
</html>
|
110
docs/html/classmrchat__t-members.html
Normal file
110
docs/html/classmrchat__t-members.html
Normal file
|
@ -0,0 +1,110 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||||||
|
<title>Delta Chat Core C-API: Member List</title>
|
||||||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||||||
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||||
|
<script type="text/javascript" src="search/search.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(document).ready(function() { init_search(); });
|
||||||
|
</script>
|
||||||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">Delta Chat Core C-API
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!-- end header part -->
|
||||||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||||
|
</script>
|
||||||
|
<div id="navrow1" class="tabs">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||||
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||||||
|
<li>
|
||||||
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||||
|
<span class="left">
|
||||||
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
alt=""/>
|
||||||
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||||
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||||
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||||
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||||
|
</span><span class="right">
|
||||||
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div id="navrow2" class="tabs2">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!-- window showing the filter options -->
|
||||||
|
<div id="MSearchSelectWindow"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- iframe showing the search results (closed by default) -->
|
||||||
|
<div id="MSearchResultsWindow">
|
||||||
|
<iframe src="javascript:void(0)" frameborder="0"
|
||||||
|
name="MSearchResults" id="MSearchResults">
|
||||||
|
</iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div><!-- top -->
|
||||||
|
<div class="header">
|
||||||
|
<div class="headertitle">
|
||||||
|
<div class="title">mrchat_t Member List</div> </div>
|
||||||
|
</div><!--header-->
|
||||||
|
<div class="contents">
|
||||||
|
|
||||||
|
<p>This is the complete list of members for <a class="el" href="classmrchat__t.html">mrchat_t</a>, including all inherited members.</p>
|
||||||
|
<table class="directory">
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrchat__t.html#acc61e5404ffdc000b79e333b7cd8480a">mrchat_get_archived</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="classmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrchat__t.html#a432be926badecf1d50bafa06da988d6e">mrchat_get_draft</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="classmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrchat__t.html#a03f7ce80c02b1a75043f6b9a4ed2c4d5">mrchat_get_draft_timestamp</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="classmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrchat__t.html#a7bdbf583d0d565c8ca79d3d3f1a07c60">mrchat_get_id</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="classmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrchat__t.html#a809d212fc65c445c0abc98abb4554f40">mrchat_get_name</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="classmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b">mrchat_get_profile_image</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="classmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08">mrchat_get_subtitle</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="classmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrchat__t.html#a187ab591ec058f4e43c1ba205bbd7503">mrchat_get_type</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="classmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrchat__t.html#a293685c189ab86d230dfe27a5a28c1ca">mrchat_is_self_talk</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="classmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrchat__t.html#af23f2fd022f9978f7eed5ed46f3d9fbb">mrchat_is_unpromoted</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="classmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9">mrchat_unref</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="classmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
|
||||||
|
</table></div><!-- contents -->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||||
|
</a> 1.8.11
|
||||||
|
</small></address>
|
||||||
|
</body>
|
||||||
|
</html>
|
454
docs/html/classmrchat__t.html
Normal file
454
docs/html/classmrchat__t.html
Normal file
|
@ -0,0 +1,454 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||||||
|
<title>Delta Chat Core C-API: mrchat_t Class Reference</title>
|
||||||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||||||
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||||
|
<script type="text/javascript" src="search/search.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(document).ready(function() { init_search(); });
|
||||||
|
</script>
|
||||||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">Delta Chat Core C-API
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!-- end header part -->
|
||||||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||||
|
</script>
|
||||||
|
<div id="navrow1" class="tabs">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||||
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||||||
|
<li>
|
||||||
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||||
|
<span class="left">
|
||||||
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
alt=""/>
|
||||||
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||||
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||||
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||||
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||||
|
</span><span class="right">
|
||||||
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div id="navrow2" class="tabs2">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!-- window showing the filter options -->
|
||||||
|
<div id="MSearchSelectWindow"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- iframe showing the search results (closed by default) -->
|
||||||
|
<div id="MSearchResultsWindow">
|
||||||
|
<iframe src="javascript:void(0)" frameborder="0"
|
||||||
|
name="MSearchResults" id="MSearchResults">
|
||||||
|
</iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div><!-- top -->
|
||||||
|
<div class="header">
|
||||||
|
<div class="summary">
|
||||||
|
<a href="#pub-methods">Public Member Functions</a> |
|
||||||
|
<a href="classmrchat__t-members.html">List of all members</a> </div>
|
||||||
|
<div class="headertitle">
|
||||||
|
<div class="title">mrchat_t Class Reference</div> </div>
|
||||||
|
</div><!--header-->
|
||||||
|
<div class="contents">
|
||||||
|
|
||||||
|
<p>An object representing a single chat in memory.
|
||||||
|
<a href="classmrchat__t.html#details">More...</a></p>
|
||||||
|
|
||||||
|
<p><code>#include <<a class="el" href="mrchat_8h_source.html">mrchat.h</a>></code></p>
|
||||||
|
<table class="memberdecls">
|
||||||
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||||
|
Public Member Functions</h2></td></tr>
|
||||||
|
<tr class="memitem:a3b1befb4542c1bad915f2175c7c2a2b9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9">mrchat_unref</a> (<a class="el" href="classmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
||||||
|
<tr class="memdesc:a3b1befb4542c1bad915f2175c7c2a2b9"><td class="mdescLeft"> </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"> </td></tr>
|
||||||
|
<tr class="memitem:a7bdbf583d0d565c8ca79d3d3f1a07c60"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchat__t.html#a7bdbf583d0d565c8ca79d3d3f1a07c60">mrchat_get_id</a> (<a class="el" href="classmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
||||||
|
<tr class="memdesc:a7bdbf583d0d565c8ca79d3d3f1a07c60"><td class="mdescLeft"> </td><td class="mdescRight">Get chat ID. <a href="#a7bdbf583d0d565c8ca79d3d3f1a07c60">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a7bdbf583d0d565c8ca79d3d3f1a07c60"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a187ab591ec058f4e43c1ba205bbd7503"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchat__t.html#a187ab591ec058f4e43c1ba205bbd7503">mrchat_get_type</a> (<a class="el" href="classmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
||||||
|
<tr class="memdesc:a187ab591ec058f4e43c1ba205bbd7503"><td class="mdescLeft"> </td><td class="mdescRight">Get chat type. <a href="#a187ab591ec058f4e43c1ba205bbd7503">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a187ab591ec058f4e43c1ba205bbd7503"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a809d212fc65c445c0abc98abb4554f40"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchat__t.html#a809d212fc65c445c0abc98abb4554f40">mrchat_get_name</a> (<a class="el" href="classmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
||||||
|
<tr class="memdesc:a809d212fc65c445c0abc98abb4554f40"><td class="mdescLeft"> </td><td class="mdescRight">Get name of a chat. <a href="#a809d212fc65c445c0abc98abb4554f40">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a809d212fc65c445c0abc98abb4554f40"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:ae1e9920618c9f6cb8ad66d5bb6962a08"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08">mrchat_get_subtitle</a> (<a class="el" href="classmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
||||||
|
<tr class="memdesc:ae1e9920618c9f6cb8ad66d5bb6962a08"><td class="mdescLeft"> </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"> </td></tr>
|
||||||
|
<tr class="memitem:a12bad02bef1fb6c8003f41c72d94f54b"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b">mrchat_get_profile_image</a> (<a class="el" href="classmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
||||||
|
<tr class="memdesc:a12bad02bef1fb6c8003f41c72d94f54b"><td class="mdescLeft"> </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"> </td></tr>
|
||||||
|
<tr class="memitem:a432be926badecf1d50bafa06da988d6e"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchat__t.html#a432be926badecf1d50bafa06da988d6e">mrchat_get_draft</a> (<a class="el" href="classmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
||||||
|
<tr class="memdesc:a432be926badecf1d50bafa06da988d6e"><td class="mdescLeft"> </td><td class="mdescRight">Get draft for the chat, if any. <a href="#a432be926badecf1d50bafa06da988d6e">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a432be926badecf1d50bafa06da988d6e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a03f7ce80c02b1a75043f6b9a4ed2c4d5"><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchat__t.html#a03f7ce80c02b1a75043f6b9a4ed2c4d5">mrchat_get_draft_timestamp</a> (<a class="el" href="classmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
||||||
|
<tr class="memdesc:a03f7ce80c02b1a75043f6b9a4ed2c4d5"><td class="mdescLeft"> </td><td class="mdescRight">Get timestamp of the draft. <a href="#a03f7ce80c02b1a75043f6b9a4ed2c4d5">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a03f7ce80c02b1a75043f6b9a4ed2c4d5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:acc61e5404ffdc000b79e333b7cd8480a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchat__t.html#acc61e5404ffdc000b79e333b7cd8480a">mrchat_get_archived</a> (<a class="el" href="classmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
||||||
|
<tr class="memdesc:acc61e5404ffdc000b79e333b7cd8480a"><td class="mdescLeft"> </td><td class="mdescRight">Get archived state. <a href="#acc61e5404ffdc000b79e333b7cd8480a">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:acc61e5404ffdc000b79e333b7cd8480a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:af23f2fd022f9978f7eed5ed46f3d9fbb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchat__t.html#af23f2fd022f9978f7eed5ed46f3d9fbb">mrchat_is_unpromoted</a> (<a class="el" href="classmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
||||||
|
<tr class="memdesc:af23f2fd022f9978f7eed5ed46f3d9fbb"><td class="mdescLeft"> </td><td class="mdescRight">Check if a chat is still unpromoted. <a href="#af23f2fd022f9978f7eed5ed46f3d9fbb">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:af23f2fd022f9978f7eed5ed46f3d9fbb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a293685c189ab86d230dfe27a5a28c1ca"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchat__t.html#a293685c189ab86d230dfe27a5a28c1ca">mrchat_is_self_talk</a> (<a class="el" href="classmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
||||||
|
<tr class="memdesc:a293685c189ab86d230dfe27a5a28c1ca"><td class="mdescLeft"> </td><td class="mdescRight">Check if a chat is a self talk. <a href="#a293685c189ab86d230dfe27a5a28c1ca">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a293685c189ab86d230dfe27a5a28c1ca"><td class="memSeparator" colspan="2"> </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="classmrmailbox__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="a3b1befb4542c1bad915f2175c7c2a2b9"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">void mrchat_unref </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchat__t.html">mrchat_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chat</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Free a chat object. </p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">chat</td><td>Chat object are returned eg. by <a class="el" href="classmrmailbox__t.html#ad106b9c23b3a559b524a37bb5504e096" title="Get chat object by a chat ID. ">mrmailbox_get_chat()</a>.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a7bdbf583d0d565c8ca79d3d3f1a07c60"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">uint32_t mrchat_get_id </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchat__t.html">mrchat_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chat</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get chat ID. </p>
|
||||||
|
<p>The chat ID is the ID under which the chat is filed in the database.</p>
|
||||||
|
<p>Special IDs:</p><ul>
|
||||||
|
<li>MR_CHAT_ID_DEADDROP (1) - Messages sent from unknown/unwanted users to us, chats_contacts is not set up. This group may be shown normally.</li>
|
||||||
|
<li>MR_CHAT_ID_STARRED (5) - Virtual chat containing all starred messages-</li>
|
||||||
|
<li>MR_CHAT_ID_ARCHIVED_LINK (6) - A link at the end of the chatlist, if present the UI should show the button "Archived chats"-</li>
|
||||||
|
</ul>
|
||||||
|
<p>"Normal" chat IDs are larger than these special IDs (larger than MR_CHAT_ID_LAST_SPECIAL).</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">chat</td><td>The chat object.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>Chat ID. 0 on errors. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a187ab591ec058f4e43c1ba205bbd7503"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrchat_get_type </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchat__t.html">mrchat_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chat</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get chat type. </p>
|
||||||
|
<p>Currently, there are two chat types:</p>
|
||||||
|
<ul>
|
||||||
|
<li>MR_CHAT_TYPE_NORMAL (100) - a normal chat is a chat with a single contact, chats_contacts contains one record for the user, MR_CONTACT_ID_SELF (see mrcontact_t::m_id) is added <em>only</em> for a self talk.</li>
|
||||||
|
<li>MR_CHAT_TYPE_GROUP (120) - a group chat, chats_contacts conain all group members, incl. MR_CONTACT_ID_SELF</li>
|
||||||
|
</ul>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">chat</td><td>The chat object.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>Chat type. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a809d212fc65c445c0abc98abb4554f40"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">char * mrchat_get_name </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchat__t.html">mrchat_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chat</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get name of a chat. </p>
|
||||||
|
<p>For one-to-one chats, this is the name of the contact. For group chats, this is the name given eg. to <a class="el" href="classmrmailbox__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="classmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1" title="Set group name. ">mrmailbox_set_chat_name()</a></p>
|
||||||
|
<p>See also: <a class="el" href="classmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08" title="Get a subtitle for a chat. ">mrchat_get_subtitle()</a></p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">chat</td><td>The chat object.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>Chat name as a string. Must be free()'d after usage. Never NULL. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="ae1e9920618c9f6cb8ad66d5bb6962a08"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">char * mrchat_get_subtitle </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchat__t.html">mrchat_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chat</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get a subtitle for a chat. </p>
|
||||||
|
<p>The subtitle is eg. the email-address or the number of group members.</p>
|
||||||
|
<p>See also: <a class="el" href="classmrchat__t.html#a809d212fc65c445c0abc98abb4554f40" title="Get name of a chat. ">mrchat_get_name()</a></p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">chat</td><td>The chat object to calulate the subtitle for.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>Subtitle as a string. Must be free()'d after usage. Never NULL. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<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="classmrchat__t.html">mrchat_t</a> * </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="classmrmailbox__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="a432be926badecf1d50bafa06da988d6e"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">char * mrchat_get_draft </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchat__t.html">mrchat_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chat</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get draft for the chat, if any. </p>
|
||||||
|
<p>A draft is a message that the user started to compose but that is not sent yet. You can save a draft for a chat using <a class="el" href="classmrmailbox__t.html#af50446c1a5e504d27fe29de9e3b8edc3" title="Save a draft for a chat. ">mrmailbox_set_draft()</a>.</p>
|
||||||
|
<p>Drafts are considered when sorting messages and are also returned eg. by <a class="el" href="classmrchatlist__t.html#a7bb0e80673ca253c7cb71ae6b9d4fa97" title="Get a summary for a chatlist index. ">mrchatlist_get_summary()</a>.</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">chat</td><td>The chat object.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>Draft text, must be free()'d. Returns NULL if there is no draft. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a03f7ce80c02b1a75043f6b9a4ed2c4d5"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">time_t mrchat_get_draft_timestamp </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchat__t.html">mrchat_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chat</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get timestamp of the draft. </p>
|
||||||
|
<p>The draft itself can be get using <a class="el" href="classmrchat__t.html#a432be926badecf1d50bafa06da988d6e" title="Get draft for the chat, if any. ">mrchat_get_draft()</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>Timestamp of the draft. 0 if there is no draft. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="acc61e5404ffdc000b79e333b7cd8480a"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrchat_get_archived </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchat__t.html">mrchat_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chat</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get archived state. </p>
|
||||||
|
<ul>
|
||||||
|
<li>0 = normal chat, not archived, not sticky.</li>
|
||||||
|
<li>1 = chat archived</li>
|
||||||
|
<li>2 = chat sticky (reserved for future use, if you do not support this value, just treat the chat as a normal one)</li>
|
||||||
|
</ul>
|
||||||
|
<p>To archive or unarchive chats, use <a class="el" href="classmrmailbox__t.html#a8e04e43dacbe3128afd71e1d6c1b0911" title="Archive or unarchive a chat. ">mrmailbox_archive_chat()</a>. If chats are archived, this should be shown in the UI by a little icon or text, eg. the search will also return archived chats.</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">chat</td><td>The chat object.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>Archived state. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="af23f2fd022f9978f7eed5ed46f3d9fbb"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrchat_is_unpromoted </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchat__t.html">mrchat_t</a> * </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="classmrmailbox__t.html#a47156db87107ec208d6637f460d897a8" title="Create a new group chat. ">mrmailbox_create_group_chat()</a> the chat is usuall unpromoted until the first call to mrmailbox_send_msg() or <a class="el" href="classmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b" title="Send a simple text message a given chat. ">mrmailbox_send_text_msg()</a>.</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">chat</td><td>The chat object.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>1=chat is still unpromoted, no message was ever send to the chat, 0=chat is not unpromoted, messages were send and/or received </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a293685c189ab86d230dfe27a5a28c1ca"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrchat_is_self_talk </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchat__t.html">mrchat_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chat</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Check if a chat is a self talk. </p>
|
||||||
|
<p>Self talks are normal chats with the only contact MR_CONTACT_ID_SELF.</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 self talk, 0=chat is no self talk </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||||
|
<li>/home/bpetersen/projects/deltachat-core/src/<a class="el" href="mrchat_8h_source.html">mrchat.h</a></li>
|
||||||
|
<li>/home/bpetersen/projects/deltachat-core/src/mrchat.c</li>
|
||||||
|
</ul>
|
||||||
|
</div><!-- contents -->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||||
|
</a> 1.8.11
|
||||||
|
</small></address>
|
||||||
|
</body>
|
||||||
|
</html>
|
105
docs/html/classmrchatlist__t-members.html
Normal file
105
docs/html/classmrchatlist__t-members.html
Normal file
|
@ -0,0 +1,105 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||||||
|
<title>Delta Chat Core C-API: Member List</title>
|
||||||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||||||
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||||
|
<script type="text/javascript" src="search/search.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(document).ready(function() { init_search(); });
|
||||||
|
</script>
|
||||||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">Delta Chat Core C-API
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!-- end header part -->
|
||||||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||||
|
</script>
|
||||||
|
<div id="navrow1" class="tabs">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||||
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||||||
|
<li>
|
||||||
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||||
|
<span class="left">
|
||||||
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
alt=""/>
|
||||||
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||||
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||||
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||||
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||||
|
</span><span class="right">
|
||||||
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div id="navrow2" class="tabs2">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!-- window showing the filter options -->
|
||||||
|
<div id="MSearchSelectWindow"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- iframe showing the search results (closed by default) -->
|
||||||
|
<div id="MSearchResultsWindow">
|
||||||
|
<iframe src="javascript:void(0)" frameborder="0"
|
||||||
|
name="MSearchResults" id="MSearchResults">
|
||||||
|
</iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div><!-- top -->
|
||||||
|
<div class="header">
|
||||||
|
<div class="headertitle">
|
||||||
|
<div class="title">mrchatlist_t Member List</div> </div>
|
||||||
|
</div><!--header-->
|
||||||
|
<div class="contents">
|
||||||
|
|
||||||
|
<p>This is the complete list of members for <a class="el" href="classmrchatlist__t.html">mrchatlist_t</a>, including all inherited members.</p>
|
||||||
|
<table class="directory">
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrchatlist__t.html#a8c8360c76b31057322199e8c51cadfa5">mrchatlist_get_chat_id</a>(mrchatlist_t *chatlist, size_t index)</td><td class="entry"><a class="el" href="classmrchatlist__t.html">mrchatlist_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrchatlist__t.html#aa132119f18e40e3151ac5fe0299daab7">mrchatlist_get_cnt</a>(mrchatlist_t *chatlist)</td><td class="entry"><a class="el" href="classmrchatlist__t.html">mrchatlist_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrchatlist__t.html#a8a378a8d03835048054f64a2f49a5487">mrchatlist_get_mailbox</a>(mrchatlist_t *chatlist)</td><td class="entry"><a class="el" href="classmrchatlist__t.html">mrchatlist_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrchatlist__t.html#a69b67135eeadbdbe9b4a60e645ef22b0">mrchatlist_get_msg_id</a>(mrchatlist_t *chatlist, size_t index)</td><td class="entry"><a class="el" href="classmrchatlist__t.html">mrchatlist_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrchatlist__t.html#a7bb0e80673ca253c7cb71ae6b9d4fa97">mrchatlist_get_summary</a>(mrchatlist_t *chatlist, size_t index, mrchat_t *chat)</td><td class="entry"><a class="el" href="classmrchatlist__t.html">mrchatlist_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrchatlist__t.html#ab036d6e066b5ff78779f36711c9ab2f9">mrchatlist_unref</a>(mrchatlist_t *chatlist)</td><td class="entry"><a class="el" href="classmrchatlist__t.html">mrchatlist_t</a></td><td class="entry"></td></tr>
|
||||||
|
</table></div><!-- contents -->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||||
|
</a> 1.8.11
|
||||||
|
</small></address>
|
||||||
|
</body>
|
||||||
|
</html>
|
334
docs/html/classmrchatlist__t.html
Normal file
334
docs/html/classmrchatlist__t.html
Normal file
|
@ -0,0 +1,334 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||||||
|
<title>Delta Chat Core C-API: mrchatlist_t Class Reference</title>
|
||||||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||||||
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||||
|
<script type="text/javascript" src="search/search.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(document).ready(function() { init_search(); });
|
||||||
|
</script>
|
||||||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">Delta Chat Core C-API
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!-- end header part -->
|
||||||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||||
|
</script>
|
||||||
|
<div id="navrow1" class="tabs">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||||
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||||||
|
<li>
|
||||||
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||||
|
<span class="left">
|
||||||
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
alt=""/>
|
||||||
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||||
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||||
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||||
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||||
|
</span><span class="right">
|
||||||
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div id="navrow2" class="tabs2">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!-- window showing the filter options -->
|
||||||
|
<div id="MSearchSelectWindow"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- iframe showing the search results (closed by default) -->
|
||||||
|
<div id="MSearchResultsWindow">
|
||||||
|
<iframe src="javascript:void(0)" frameborder="0"
|
||||||
|
name="MSearchResults" id="MSearchResults">
|
||||||
|
</iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div><!-- top -->
|
||||||
|
<div class="header">
|
||||||
|
<div class="summary">
|
||||||
|
<a href="#pub-methods">Public Member Functions</a> |
|
||||||
|
<a href="classmrchatlist__t-members.html">List of all members</a> </div>
|
||||||
|
<div class="headertitle">
|
||||||
|
<div class="title">mrchatlist_t Class Reference</div> </div>
|
||||||
|
</div><!--header-->
|
||||||
|
<div class="contents">
|
||||||
|
|
||||||
|
<p>An object representing a single chatlist in memory.
|
||||||
|
<a href="classmrchatlist__t.html#details">More...</a></p>
|
||||||
|
|
||||||
|
<p><code>#include <<a class="el" href="mrchatlist_8h_source.html">mrchatlist.h</a>></code></p>
|
||||||
|
<table class="memberdecls">
|
||||||
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||||
|
Public Member Functions</h2></td></tr>
|
||||||
|
<tr class="memitem:ab036d6e066b5ff78779f36711c9ab2f9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchatlist__t.html#ab036d6e066b5ff78779f36711c9ab2f9">mrchatlist_unref</a> (<a class="el" href="classmrchatlist__t.html">mrchatlist_t</a> *chatlist)</td></tr>
|
||||||
|
<tr class="memdesc:ab036d6e066b5ff78779f36711c9ab2f9"><td class="mdescLeft"> </td><td class="mdescRight">Free a chatlist object. <a href="#ab036d6e066b5ff78779f36711c9ab2f9">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:ab036d6e066b5ff78779f36711c9ab2f9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:aa132119f18e40e3151ac5fe0299daab7"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchatlist__t.html#aa132119f18e40e3151ac5fe0299daab7">mrchatlist_get_cnt</a> (<a class="el" href="classmrchatlist__t.html">mrchatlist_t</a> *chatlist)</td></tr>
|
||||||
|
<tr class="memdesc:aa132119f18e40e3151ac5fe0299daab7"><td class="mdescLeft"> </td><td class="mdescRight">Find out the number of chats in a chatlist. <a href="#aa132119f18e40e3151ac5fe0299daab7">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:aa132119f18e40e3151ac5fe0299daab7"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a8c8360c76b31057322199e8c51cadfa5"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchatlist__t.html#a8c8360c76b31057322199e8c51cadfa5">mrchatlist_get_chat_id</a> (<a class="el" href="classmrchatlist__t.html">mrchatlist_t</a> *chatlist, size_t index)</td></tr>
|
||||||
|
<tr class="memdesc:a8c8360c76b31057322199e8c51cadfa5"><td class="mdescLeft"> </td><td class="mdescRight">Get a single chat ID of a chatlist. <a href="#a8c8360c76b31057322199e8c51cadfa5">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a8c8360c76b31057322199e8c51cadfa5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a69b67135eeadbdbe9b4a60e645ef22b0"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchatlist__t.html#a69b67135eeadbdbe9b4a60e645ef22b0">mrchatlist_get_msg_id</a> (<a class="el" href="classmrchatlist__t.html">mrchatlist_t</a> *chatlist, size_t index)</td></tr>
|
||||||
|
<tr class="memdesc:a69b67135eeadbdbe9b4a60e645ef22b0"><td class="mdescLeft"> </td><td class="mdescRight">Get a single message ID of a chatlist. <a href="#a69b67135eeadbdbe9b4a60e645ef22b0">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a69b67135eeadbdbe9b4a60e645ef22b0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a7bb0e80673ca253c7cb71ae6b9d4fa97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchatlist__t.html#a7bb0e80673ca253c7cb71ae6b9d4fa97">mrchatlist_get_summary</a> (<a class="el" href="classmrchatlist__t.html">mrchatlist_t</a> *chatlist, size_t index, <a class="el" href="classmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
||||||
|
<tr class="memdesc:a7bb0e80673ca253c7cb71ae6b9d4fa97"><td class="mdescLeft"> </td><td class="mdescRight">Get a summary for a chatlist index. <a href="#a7bb0e80673ca253c7cb71ae6b9d4fa97">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a7bb0e80673ca253c7cb71ae6b9d4fa97"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a8a378a8d03835048054f64a2f49a5487"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrchatlist__t.html#a8a378a8d03835048054f64a2f49a5487">mrchatlist_get_mailbox</a> (<a class="el" href="classmrchatlist__t.html">mrchatlist_t</a> *chatlist)</td></tr>
|
||||||
|
<tr class="memdesc:a8a378a8d03835048054f64a2f49a5487"><td class="mdescLeft"> </td><td class="mdescRight">Helper function to get the associated mailbox object. <a href="#a8a378a8d03835048054f64a2f49a5487">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a8a378a8d03835048054f64a2f49a5487"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
</table>
|
||||||
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||||
|
<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="classmrmailbox__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="classmrchatlist__t.html">mrchatlist_t</a> * </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="classmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>, <a class="el" href="classmrmailbox__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="classmrchatlist__t.html">mrchatlist_t</a> * </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="classmrmailbox__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="classmrchatlist__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">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">uint32_t mrchatlist_get_chat_id </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchatlist__t.html">mrchatlist_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chatlist</em>, </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="paramkey"></td>
|
||||||
|
<td></td>
|
||||||
|
<td class="paramtype">size_t </td>
|
||||||
|
<td class="paramname"><em>index</em> </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td></td>
|
||||||
|
<td>)</td>
|
||||||
|
<td></td><td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get a single chat ID of a chatlist. </p>
|
||||||
|
<p>To get the message object from the message ID, use <a class="el" href="classmrmailbox__t.html#ad106b9c23b3a559b524a37bb5504e096" title="Get chat object by a chat ID. ">mrmailbox_get_chat()</a>.</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="classmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>.</td></tr>
|
||||||
|
<tr><td class="paramname">index</td><td>The index to get the chat ID for.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</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="classmrchatlist__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="a69b67135eeadbdbe9b4a60e645ef22b0"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">uint32_t mrchatlist_get_msg_id </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchatlist__t.html">mrchatlist_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chatlist</em>, </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="paramkey"></td>
|
||||||
|
<td></td>
|
||||||
|
<td class="paramtype">size_t </td>
|
||||||
|
<td class="paramname"><em>index</em> </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td></td>
|
||||||
|
<td>)</td>
|
||||||
|
<td></td><td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get a single message ID of a chatlist. </p>
|
||||||
|
<p>To get the message object from the message ID, use <a class="el" href="classmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13" title="Get a single message object of the type mrmsg_t. ">mrmailbox_get_msg()</a>.</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="classmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>.</td></tr>
|
||||||
|
<tr><td class="paramname">index</td><td>The index to get the chat ID for.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>Returns the message_id of the item at the given index. Index must be between 0 and <a class="el" href="classmrchatlist__t.html#aa132119f18e40e3151ac5fe0299daab7" title="Find out the number of chats in a chatlist. ">mrchatlist_get_cnt()</a>-1. If there is no message at the given index (eg. the chat may be empty), 0 is returned. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a7bb0e80673ca253c7cb71ae6b9d4fa97"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname"><a class="el" href="classmrlot__t.html">mrlot_t</a> * mrchatlist_get_summary </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchatlist__t.html">mrchatlist_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chatlist</em>, </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="paramkey"></td>
|
||||||
|
<td></td>
|
||||||
|
<td class="paramtype">size_t </td>
|
||||||
|
<td class="paramname"><em>index</em>, </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="paramkey"></td>
|
||||||
|
<td></td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchat__t.html">mrchat_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chat</em> </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td></td>
|
||||||
|
<td>)</td>
|
||||||
|
<td></td><td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get a summary for a chatlist index. </p>
|
||||||
|
<p>The summary is returned by a <a class="el" href="classmrlot__t.html" title="An object containing a set of values. ">mrlot_t</a> object with the following fields:</p>
|
||||||
|
<ul>
|
||||||
|
<li>mrlot_t::m_text1: contains the username or the strings "Me", "Draft" and so on. The string may be colored by having a look at m_text1_meaning. If there is no such name or it should not be displayed, the element is NULL.</li>
|
||||||
|
<li>mrlot_t::m_text1_meaning: one of MR_TEXT1_USERNAME, MR_TEXT1_SELF or MR_TEXT1_DRAFT. Typically used to show mrlot_t::m_text1 with different colors. 0 if not applicable.</li>
|
||||||
|
<li>mrlot_t::m_text2: contains an excerpt of the message text or strings as "No messages". May be NULL of there is no such text (eg. for the archive link)</li>
|
||||||
|
<li>mrlot_t::m_timestamp: the timestamp of the message. 0 if not applicable.</li>
|
||||||
|
<li>mrlot_t::m_state: The state of the message as one of the MR_STATE_* constants (see <a class="el" href="classmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5" title="Get the state of a message. ">mrmsg_get_state()</a>). 0 if not applicable.</li>
|
||||||
|
</ul>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">chatlist</td><td>The chatlist to query as returned eg. from <a class="el" href="classmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>. </td></tr>
|
||||||
|
<tr><td class="paramname">index</td><td>The index to query in the chatlist. </td></tr>
|
||||||
|
<tr><td class="paramname">chat</td><td>To speed up things, pass an already available chat object here. If the chat object is not yet available, it is faster to pass NULL.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>The summary as an <a class="el" href="classmrlot__t.html" title="An object containing a set of values. ">mrlot_t</a> object. Must be freed using <a class="el" href="classmrlot__t.html#a813e4d0c2f135e962cc4d5ac0753c592" title="Frees an object containing a set of parameters. ">mrlot_unref()</a>. NULL is never returned. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a8a378a8d03835048054f64a2f49a5487"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a> * mrchatlist_get_mailbox </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchatlist__t.html">mrchatlist_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chatlist</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Helper function to get the associated mailbox object. </p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">chatlist</td><td>The chatlist object to empty.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>Mailbox object associated with the chatlist. NULL if none or on errors. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||||
|
<li>/home/bpetersen/projects/deltachat-core/src/<a class="el" href="mrchatlist_8h_source.html">mrchatlist.h</a></li>
|
||||||
|
<li>/home/bpetersen/projects/deltachat-core/src/mrchatlist.c</li>
|
||||||
|
</ul>
|
||||||
|
</div><!-- contents -->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||||
|
</a> 1.8.11
|
||||||
|
</small></address>
|
||||||
|
</body>
|
||||||
|
</html>
|
106
docs/html/classmrcontact__t-members.html
Normal file
106
docs/html/classmrcontact__t-members.html
Normal file
|
@ -0,0 +1,106 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||||||
|
<title>Delta Chat Core C-API: Member List</title>
|
||||||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||||||
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||||
|
<script type="text/javascript" src="search/search.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(document).ready(function() { init_search(); });
|
||||||
|
</script>
|
||||||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">Delta Chat Core C-API
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!-- end header part -->
|
||||||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||||
|
</script>
|
||||||
|
<div id="navrow1" class="tabs">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||||
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||||||
|
<li>
|
||||||
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||||
|
<span class="left">
|
||||||
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
alt=""/>
|
||||||
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||||
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||||
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||||
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||||
|
</span><span class="right">
|
||||||
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div id="navrow2" class="tabs2">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!-- window showing the filter options -->
|
||||||
|
<div id="MSearchSelectWindow"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- iframe showing the search results (closed by default) -->
|
||||||
|
<div id="MSearchResultsWindow">
|
||||||
|
<iframe src="javascript:void(0)" frameborder="0"
|
||||||
|
name="MSearchResults" id="MSearchResults">
|
||||||
|
</iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div><!-- top -->
|
||||||
|
<div class="header">
|
||||||
|
<div class="headertitle">
|
||||||
|
<div class="title">mrcontact_t Member List</div> </div>
|
||||||
|
</div><!--header-->
|
||||||
|
<div class="contents">
|
||||||
|
|
||||||
|
<p>This is the complete list of members for <a class="el" href="classmrcontact__t.html">mrcontact_t</a>, including all inherited members.</p>
|
||||||
|
<table class="directory">
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971">mrcontact_get_addr</a>(mrcontact_t *contact)</td><td class="entry"><a class="el" href="classmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrcontact__t.html#a29a93300d97183f795fc711c93fac689">mrcontact_get_display_name</a>(mrcontact_t *contact)</td><td class="entry"><a class="el" href="classmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrcontact__t.html#a46e94fa7980706b6519024f39c4d469c">mrcontact_get_id</a>(mrcontact_t *contact)</td><td class="entry"><a class="el" href="classmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2">mrcontact_get_name</a>(mrcontact_t *contact)</td><td class="entry"><a class="el" href="classmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2">mrcontact_get_name_n_addr</a>(mrcontact_t *contact)</td><td class="entry"><a class="el" href="classmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrcontact__t.html#aa4deccaa2eaf0fc8e4b405f3e4cd93b4">mrcontact_is_blocked</a>(mrcontact_t *contact)</td><td class="entry"><a class="el" href="classmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrcontact__t.html#a38e17e55cd66f5e86a1dcb8d1f67797a">mrcontact_unref</a>(mrcontact_t *contact)</td><td class="entry"><a class="el" href="classmrcontact__t.html">mrcontact_t</a></td><td class="entry"></td></tr>
|
||||||
|
</table></div><!-- contents -->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||||
|
</a> 1.8.11
|
||||||
|
</small></address>
|
||||||
|
</body>
|
||||||
|
</html>
|
321
docs/html/classmrcontact__t.html
Normal file
321
docs/html/classmrcontact__t.html
Normal file
|
@ -0,0 +1,321 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||||||
|
<title>Delta Chat Core C-API: mrcontact_t Class Reference</title>
|
||||||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||||||
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||||
|
<script type="text/javascript" src="search/search.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(document).ready(function() { init_search(); });
|
||||||
|
</script>
|
||||||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">Delta Chat Core C-API
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!-- end header part -->
|
||||||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||||
|
</script>
|
||||||
|
<div id="navrow1" class="tabs">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||||
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||||||
|
<li>
|
||||||
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||||
|
<span class="left">
|
||||||
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
alt=""/>
|
||||||
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||||
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||||
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||||
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||||
|
</span><span class="right">
|
||||||
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div id="navrow2" class="tabs2">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!-- window showing the filter options -->
|
||||||
|
<div id="MSearchSelectWindow"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- iframe showing the search results (closed by default) -->
|
||||||
|
<div id="MSearchResultsWindow">
|
||||||
|
<iframe src="javascript:void(0)" frameborder="0"
|
||||||
|
name="MSearchResults" id="MSearchResults">
|
||||||
|
</iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div><!-- top -->
|
||||||
|
<div class="header">
|
||||||
|
<div class="summary">
|
||||||
|
<a href="#pub-methods">Public Member Functions</a> |
|
||||||
|
<a href="classmrcontact__t-members.html">List of all members</a> </div>
|
||||||
|
<div class="headertitle">
|
||||||
|
<div class="title">mrcontact_t Class Reference</div> </div>
|
||||||
|
</div><!--header-->
|
||||||
|
<div class="contents">
|
||||||
|
|
||||||
|
<p>An object representing a single contact in memory.
|
||||||
|
<a href="classmrcontact__t.html#details">More...</a></p>
|
||||||
|
|
||||||
|
<p><code>#include <<a class="el" href="mrcontact_8h_source.html">mrcontact.h</a>></code></p>
|
||||||
|
<table class="memberdecls">
|
||||||
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||||
|
Public Member Functions</h2></td></tr>
|
||||||
|
<tr class="memitem:a38e17e55cd66f5e86a1dcb8d1f67797a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrcontact__t.html#a38e17e55cd66f5e86a1dcb8d1f67797a">mrcontact_unref</a> (<a class="el" href="classmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
|
||||||
|
<tr class="memdesc:a38e17e55cd66f5e86a1dcb8d1f67797a"><td class="mdescLeft"> </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"> </td></tr>
|
||||||
|
<tr class="memitem:a46e94fa7980706b6519024f39c4d469c"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrcontact__t.html#a46e94fa7980706b6519024f39c4d469c">mrcontact_get_id</a> (<a class="el" href="classmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
|
||||||
|
<tr class="memdesc:a46e94fa7980706b6519024f39c4d469c"><td class="mdescLeft"> </td><td class="mdescRight">Get the ID of the contact. <a href="#a46e94fa7980706b6519024f39c4d469c">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a46e94fa7980706b6519024f39c4d469c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:abfe19c7f41061c1946d00556f3e4a971"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971">mrcontact_get_addr</a> (<a class="el" href="classmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
|
||||||
|
<tr class="memdesc:abfe19c7f41061c1946d00556f3e4a971"><td class="mdescLeft"> </td><td class="mdescRight">Get email address. <a href="#abfe19c7f41061c1946d00556f3e4a971">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:abfe19c7f41061c1946d00556f3e4a971"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a5b559ef46c96f38bf2d1f2c39de3ccb2"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2">mrcontact_get_name</a> (<a class="el" href="classmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
|
||||||
|
<tr class="memdesc:a5b559ef46c96f38bf2d1f2c39de3ccb2"><td class="mdescLeft"> </td><td class="mdescRight">Get name. <a href="#a5b559ef46c96f38bf2d1f2c39de3ccb2">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a5b559ef46c96f38bf2d1f2c39de3ccb2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a29a93300d97183f795fc711c93fac689"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrcontact__t.html#a29a93300d97183f795fc711c93fac689">mrcontact_get_display_name</a> (<a class="el" href="classmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
|
||||||
|
<tr class="memdesc:a29a93300d97183f795fc711c93fac689"><td class="mdescLeft"> </td><td class="mdescRight">Get display name. <a href="#a29a93300d97183f795fc711c93fac689">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a29a93300d97183f795fc711c93fac689"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a2658329d9e3c74f93943dfd8c25554b2"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2">mrcontact_get_name_n_addr</a> (<a class="el" href="classmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
|
||||||
|
<tr class="memdesc:a2658329d9e3c74f93943dfd8c25554b2"><td class="mdescLeft"> </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"> </td></tr>
|
||||||
|
<tr class="memitem:aa4deccaa2eaf0fc8e4b405f3e4cd93b4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrcontact__t.html#aa4deccaa2eaf0fc8e4b405f3e4cd93b4">mrcontact_is_blocked</a> (<a class="el" href="classmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
|
||||||
|
<tr class="memdesc:aa4deccaa2eaf0fc8e4b405f3e4cd93b4"><td class="mdescLeft"> </td><td class="mdescRight">Check if a contact is blocked. <a href="#aa4deccaa2eaf0fc8e4b405f3e4cd93b4">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:aa4deccaa2eaf0fc8e4b405f3e4cd93b4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
</table>
|
||||||
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||||
|
<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="classmrcontact__t.html">mrcontact_t</a> * </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="classmrmailbox__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="a46e94fa7980706b6519024f39c4d469c"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">uint32_t mrcontact_get_id </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrcontact__t.html">mrcontact_t</a> * </td>
|
||||||
|
<td class="paramname"><em>contact</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get the ID of the contact. </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>the ID of the contact, 0 on errors. </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="classmrcontact__t.html">mrcontact_t</a> * </td>
|
||||||
|
<td class="paramname"><em>contact</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get email address. </p>
|
||||||
|
<p>The email address is always set for a contact.</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="classmrcontact__t.html">mrcontact_t</a> * </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="classmrcontact__t.html#a29a93300d97183f795fc711c93fac689" title="Get display name. ">mrcontact_get_display_name()</a> or <a class="el" href="classmrcontact__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="classmrcontact__t.html">mrcontact_t</a> * </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="classmrcontact__t.html">mrcontact_t</a> * </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="aa4deccaa2eaf0fc8e4b405f3e4cd93b4"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrcontact_is_blocked </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrcontact__t.html">mrcontact_t</a> * </td>
|
||||||
|
<td class="paramname"><em>contact</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Check if a contact is blocked. </p>
|
||||||
|
<p>To block or unblock a contact, use <a class="el" href="classmrmailbox__t.html#abb069358386b767a60444651195e0895" title="Block or unblock a contact. ">mrmailbox_block_contact()</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>1=contact is blocked, 0=contact is not blocked. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||||
|
<li>/home/bpetersen/projects/deltachat-core/src/<a class="el" href="mrcontact_8h_source.html">mrcontact.h</a></li>
|
||||||
|
<li>/home/bpetersen/projects/deltachat-core/src/mrcontact.c</li>
|
||||||
|
</ul>
|
||||||
|
</div><!-- contents -->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||||
|
</a> 1.8.11
|
||||||
|
</small></address>
|
||||||
|
</body>
|
||||||
|
</html>
|
105
docs/html/classmrlot__t-members.html
Normal file
105
docs/html/classmrlot__t-members.html
Normal file
|
@ -0,0 +1,105 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||||||
|
<title>Delta Chat Core C-API: Member List</title>
|
||||||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||||||
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||||
|
<script type="text/javascript" src="search/search.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(document).ready(function() { init_search(); });
|
||||||
|
</script>
|
||||||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">Delta Chat Core C-API
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!-- end header part -->
|
||||||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||||
|
</script>
|
||||||
|
<div id="navrow1" class="tabs">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||||
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||||||
|
<li>
|
||||||
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||||
|
<span class="left">
|
||||||
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
alt=""/>
|
||||||
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||||
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||||
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||||
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||||
|
</span><span class="right">
|
||||||
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div id="navrow2" class="tabs2">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!-- window showing the filter options -->
|
||||||
|
<div id="MSearchSelectWindow"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- iframe showing the search results (closed by default) -->
|
||||||
|
<div id="MSearchResultsWindow">
|
||||||
|
<iframe src="javascript:void(0)" frameborder="0"
|
||||||
|
name="MSearchResults" id="MSearchResults">
|
||||||
|
</iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div><!-- top -->
|
||||||
|
<div class="header">
|
||||||
|
<div class="headertitle">
|
||||||
|
<div class="title">mrlot_t Member List</div> </div>
|
||||||
|
</div><!--header-->
|
||||||
|
<div class="contents">
|
||||||
|
|
||||||
|
<p>This is the complete list of members for <a class="el" href="classmrlot__t.html">mrlot_t</a>, including all inherited members.</p>
|
||||||
|
<table class="directory">
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrlot__t.html#ae712f421734abf829fc4e78887b2d1e2">mrlot_get_state</a>(mrlot_t *lot)</td><td class="entry"><a class="el" href="classmrlot__t.html">mrlot_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrlot__t.html#a68c40c0b1436125972bc0f58b7840031">mrlot_get_text1</a>(mrlot_t *lot)</td><td class="entry"><a class="el" href="classmrlot__t.html">mrlot_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrlot__t.html#a6c1780476b6b05f0a18446d10bad049e">mrlot_get_text1_meaning</a>(mrlot_t *lot)</td><td class="entry"><a class="el" href="classmrlot__t.html">mrlot_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrlot__t.html#a113bbdb7a4635831703d51e9948bc897">mrlot_get_text2</a>(mrlot_t *lot)</td><td class="entry"><a class="el" href="classmrlot__t.html">mrlot_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrlot__t.html#a1fb0045f9345c27ffc57ba1ab42464b9">mrlot_get_timestamp</a>(mrlot_t *lot)</td><td class="entry"><a class="el" href="classmrlot__t.html">mrlot_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrlot__t.html#a813e4d0c2f135e962cc4d5ac0753c592">mrlot_unref</a>(mrlot_t *set)</td><td class="entry"><a class="el" href="classmrlot__t.html">mrlot_t</a></td><td class="entry"></td></tr>
|
||||||
|
</table></div><!-- contents -->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||||
|
</a> 1.8.11
|
||||||
|
</small></address>
|
||||||
|
</body>
|
||||||
|
</html>
|
291
docs/html/classmrlot__t.html
Normal file
291
docs/html/classmrlot__t.html
Normal file
|
@ -0,0 +1,291 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||||||
|
<title>Delta Chat Core C-API: mrlot_t Class Reference</title>
|
||||||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||||||
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||||
|
<script type="text/javascript" src="search/search.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(document).ready(function() { init_search(); });
|
||||||
|
</script>
|
||||||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">Delta Chat Core C-API
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!-- end header part -->
|
||||||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||||
|
</script>
|
||||||
|
<div id="navrow1" class="tabs">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||||
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||||||
|
<li>
|
||||||
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||||
|
<span class="left">
|
||||||
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
alt=""/>
|
||||||
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||||
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||||
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||||
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||||
|
</span><span class="right">
|
||||||
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div id="navrow2" class="tabs2">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!-- window showing the filter options -->
|
||||||
|
<div id="MSearchSelectWindow"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- iframe showing the search results (closed by default) -->
|
||||||
|
<div id="MSearchResultsWindow">
|
||||||
|
<iframe src="javascript:void(0)" frameborder="0"
|
||||||
|
name="MSearchResults" id="MSearchResults">
|
||||||
|
</iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div><!-- top -->
|
||||||
|
<div class="header">
|
||||||
|
<div class="summary">
|
||||||
|
<a href="#pub-methods">Public Member Functions</a> |
|
||||||
|
<a href="classmrlot__t-members.html">List of all members</a> </div>
|
||||||
|
<div class="headertitle">
|
||||||
|
<div class="title">mrlot_t Class Reference</div> </div>
|
||||||
|
</div><!--header-->
|
||||||
|
<div class="contents">
|
||||||
|
|
||||||
|
<p>An object containing a set of values.
|
||||||
|
<a href="classmrlot__t.html#details">More...</a></p>
|
||||||
|
|
||||||
|
<p><code>#include <<a class="el" href="mrlot_8h_source.html">mrlot.h</a>></code></p>
|
||||||
|
<table class="memberdecls">
|
||||||
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||||
|
Public Member Functions</h2></td></tr>
|
||||||
|
<tr class="memitem:a813e4d0c2f135e962cc4d5ac0753c592"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrlot__t.html#a813e4d0c2f135e962cc4d5ac0753c592">mrlot_unref</a> (<a class="el" href="classmrlot__t.html">mrlot_t</a> *set)</td></tr>
|
||||||
|
<tr class="memdesc:a813e4d0c2f135e962cc4d5ac0753c592"><td class="mdescLeft"> </td><td class="mdescRight">Frees an object containing a set of parameters. <a href="#a813e4d0c2f135e962cc4d5ac0753c592">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a813e4d0c2f135e962cc4d5ac0753c592"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a68c40c0b1436125972bc0f58b7840031"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrlot__t.html#a68c40c0b1436125972bc0f58b7840031">mrlot_get_text1</a> (<a class="el" href="classmrlot__t.html">mrlot_t</a> *lot)</td></tr>
|
||||||
|
<tr class="memdesc:a68c40c0b1436125972bc0f58b7840031"><td class="mdescLeft"> </td><td class="mdescRight">Get first string. <a href="#a68c40c0b1436125972bc0f58b7840031">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a68c40c0b1436125972bc0f58b7840031"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a113bbdb7a4635831703d51e9948bc897"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrlot__t.html#a113bbdb7a4635831703d51e9948bc897">mrlot_get_text2</a> (<a class="el" href="classmrlot__t.html">mrlot_t</a> *lot)</td></tr>
|
||||||
|
<tr class="memdesc:a113bbdb7a4635831703d51e9948bc897"><td class="mdescLeft"> </td><td class="mdescRight">Get second string. <a href="#a113bbdb7a4635831703d51e9948bc897">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a113bbdb7a4635831703d51e9948bc897"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a6c1780476b6b05f0a18446d10bad049e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrlot__t.html#a6c1780476b6b05f0a18446d10bad049e">mrlot_get_text1_meaning</a> (<a class="el" href="classmrlot__t.html">mrlot_t</a> *lot)</td></tr>
|
||||||
|
<tr class="memdesc:a6c1780476b6b05f0a18446d10bad049e"><td class="mdescLeft"> </td><td class="mdescRight">Get the meaning of the first string. <a href="#a6c1780476b6b05f0a18446d10bad049e">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a6c1780476b6b05f0a18446d10bad049e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:ae712f421734abf829fc4e78887b2d1e2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrlot__t.html#ae712f421734abf829fc4e78887b2d1e2">mrlot_get_state</a> (<a class="el" href="classmrlot__t.html">mrlot_t</a> *lot)</td></tr>
|
||||||
|
<tr class="memdesc:ae712f421734abf829fc4e78887b2d1e2"><td class="mdescLeft"> </td><td class="mdescRight">Get the associated state. <a href="#ae712f421734abf829fc4e78887b2d1e2">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:ae712f421734abf829fc4e78887b2d1e2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a1fb0045f9345c27ffc57ba1ab42464b9"><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrlot__t.html#a1fb0045f9345c27ffc57ba1ab42464b9">mrlot_get_timestamp</a> (<a class="el" href="classmrlot__t.html">mrlot_t</a> *lot)</td></tr>
|
||||||
|
<tr class="memdesc:a1fb0045f9345c27ffc57ba1ab42464b9"><td class="mdescLeft"> </td><td class="mdescRight">Get the associated timestamp. <a href="#a1fb0045f9345c27ffc57ba1ab42464b9">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a1fb0045f9345c27ffc57ba1ab42464b9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
</table>
|
||||||
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||||
|
<div class="textblock"><p>An object containing a set of values. </p>
|
||||||
|
<p>The meaning of the values is defined by the function returning the set object. Set objects are created eg. by <a class="el" href="classmrchatlist__t.html#a7bb0e80673ca253c7cb71ae6b9d4fa97" title="Get a summary for a chatlist index. ">mrchatlist_get_summary()</a>, <a class="el" href="classmrmsg__t.html#a3c14a8dbd6cc7f90c642223a873312e3" title="Get a summary for a message. ">mrmsg_get_summary()</a> or by <a class="el" href="classmrmsg__t.html#a1c6dfee4004fe0e9b9f90720bad73ecb" title="Get real author and title. ">mrmsg_get_mediainfo()</a>.</p>
|
||||||
|
<p>NB: <em>Lot</em> is used in the meaning <em>heap</em> here. </p>
|
||||||
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||||||
|
<a class="anchor" id="a813e4d0c2f135e962cc4d5ac0753c592"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">void mrlot_unref </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td>
|
||||||
|
<td class="paramname"><em>set</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Frees an object containing a set of parameters. </p>
|
||||||
|
<p>If the set object contains strings, the strings are also freed with this function. Set objects are created eg. by <a class="el" href="classmrchatlist__t.html#a7bb0e80673ca253c7cb71ae6b9d4fa97" title="Get a summary for a chatlist index. ">mrchatlist_get_summary()</a>, mrmsg_get_summary or by <a class="el" href="classmrmsg__t.html#a1c6dfee4004fe0e9b9f90720bad73ecb" title="Get real author and title. ">mrmsg_get_mediainfo()</a>.</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">set</td><td>The 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="a68c40c0b1436125972bc0f58b7840031"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">char * mrlot_get_text1 </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td>
|
||||||
|
<td class="paramname"><em>lot</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get first string. </p>
|
||||||
|
<p>The meaning of the string is defined by the creator or the object any may be roughly described by <a class="el" href="classmrlot__t.html#a6c1780476b6b05f0a18446d10bad049e" title="Get the meaning of the first string. ">mrlot_get_text1_meaning()</a>.</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">lot</td><td>The lot object.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>A string, the string may be empty and the returned value must be free()'d. NULL if there is no such string. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a113bbdb7a4635831703d51e9948bc897"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">char * mrlot_get_text2 </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td>
|
||||||
|
<td class="paramname"><em>lot</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get second string. </p>
|
||||||
|
<p>The meaning of the string is defined by the creator or the object.</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">lot</td><td>The lot object.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>A string, the string may be empty and the returned value must be free()'d . NULL if there is no such string. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a6c1780476b6b05f0a18446d10bad049e"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrlot_get_text1_meaning </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td>
|
||||||
|
<td class="paramname"><em>lot</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get the meaning of the first string. </p>
|
||||||
|
<p>Posssible meanings of the string are defined by the creator or the object and may be returned eg. as MR_TEXT1_DRAFT, MR_TEXT1_USERNAME or MR_TEXT1_SELF.</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">lot</td><td>The lot object.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>Returns the meaning of the first string, possible meanings are defined by the creator of the object. 0 if there is no concrete meaning or on errors. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="ae712f421734abf829fc4e78887b2d1e2"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrlot_get_state </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td>
|
||||||
|
<td class="paramname"><em>lot</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get the associated state. </p>
|
||||||
|
<p>The meaning of the state is defined by the creator or the object.</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">lot</td><td>The lot object.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>The state as defined by the creator of the object. 0 if there is not state or on errors. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a1fb0045f9345c27ffc57ba1ab42464b9"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">time_t mrlot_get_timestamp </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td>
|
||||||
|
<td class="paramname"><em>lot</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get the associated timestamp. </p>
|
||||||
|
<p>The meaning of the timestamp is defined by the creator or the object.</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">lot</td><td>The lot object.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>The timestamp as defined by the creator of the object. 0 if there is not timestamp or on errors. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||||
|
<li>/home/bpetersen/projects/deltachat-core/src/<a class="el" href="mrlot_8h_source.html">mrlot.h</a></li>
|
||||||
|
<li>/home/bpetersen/projects/deltachat-core/src/mrlot.c</li>
|
||||||
|
</ul>
|
||||||
|
</div><!-- contents -->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||||
|
</a> 1.8.11
|
||||||
|
</small></address>
|
||||||
|
</body>
|
||||||
|
</html>
|
169
docs/html/classmrmailbox__t-members.html
Normal file
169
docs/html/classmrmailbox__t-members.html
Normal file
|
@ -0,0 +1,169 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||||||
|
<title>Delta Chat Core C-API: Member List</title>
|
||||||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||||||
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||||
|
<script type="text/javascript" src="search/search.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(document).ready(function() { init_search(); });
|
||||||
|
</script>
|
||||||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">Delta Chat Core C-API
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!-- end header part -->
|
||||||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||||
|
</script>
|
||||||
|
<div id="navrow1" class="tabs">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||||
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||||||
|
<li>
|
||||||
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||||
|
<span class="left">
|
||||||
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
alt=""/>
|
||||||
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||||
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||||
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||||
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||||
|
</span><span class="right">
|
||||||
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div id="navrow2" class="tabs2">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!-- window showing the filter options -->
|
||||||
|
<div id="MSearchSelectWindow"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- iframe showing the search results (closed by default) -->
|
||||||
|
<div id="MSearchResultsWindow">
|
||||||
|
<iframe src="javascript:void(0)" frameborder="0"
|
||||||
|
name="MSearchResults" id="MSearchResults">
|
||||||
|
</iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div><!-- top -->
|
||||||
|
<div class="header">
|
||||||
|
<div class="headertitle">
|
||||||
|
<div class="title">mrmailbox_t Member List</div> </div>
|
||||||
|
</div><!--header-->
|
||||||
|
<div class="contents">
|
||||||
|
|
||||||
|
<p>This is the complete list of members for <a class="el" href="classmrmailbox__t.html">mrmailbox_t</a>, including all inherited members.</p>
|
||||||
|
<table class="directory">
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a25720ea41355cc32cc93aa45709937d6">mrmailbox_add_address_book</a>(mrmailbox_t *mailbox, const char *adr_book)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a96368620971935c7ac4a0bb324ece2c9">mrmailbox_add_contact_to_chat</a>(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t contact_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a8e04e43dacbe3128afd71e1d6c1b0911">mrmailbox_archive_chat</a>(mrmailbox_t *mailbox, uint32_t chat_id, int archive)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#abb069358386b767a60444651195e0895">mrmailbox_block_contact</a>(mrmailbox_t *mailbox, uint32_t contact_id, int new_blocking)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a3b55fcb1a91c616f032e160914406ed2">mrmailbox_check_password</a>(mrmailbox_t *mailbox, const char *test_pw)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a75011d103515e088e950a64d0706ec86">mrmailbox_close</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef">mrmailbox_configure_and_connect</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a67eef5ffc3369b8ad09326471b0a266f">mrmailbox_connect</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a13fde8828b56c0fe94227d0b105c5708">mrmailbox_continue_key_transfer</a>(mrmailbox_t *mailbox, uint32_t msg_id, const char *setup_code)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a1386ec2c091b936b65b25b50a302173d">mrmailbox_create_chat_by_contact_id</a>(mrmailbox_t *mailbox, uint32_t contact_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#aa089e97e7ca1add16c10d5cc0e902824">mrmailbox_create_contact</a>(mrmailbox_t *mailbox, const char *name, const char *addr)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a47156db87107ec208d6637f460d897a8">mrmailbox_create_group_chat</a>(mrmailbox_t *mailbox, const char *chat_name)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a24813f8aea38bcf5f928ea8a5fd7a3ec">mrmailbox_delete_chat</a>(mrmailbox_t *mailbox, uint32_t chat_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a209732d105e40cd0c61d33d76d288c59">mrmailbox_delete_contact</a>(mrmailbox_t *mailbox, uint32_t contact_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#adf02bfc046577b46e1f0f5a31869890f">mrmailbox_delete_msgs</a>(mrmailbox_t *mailbox, const uint32_t *msg_ids, int msg_cnt)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a7c7921ff7b7f2e10dc30522af980b785">mrmailbox_disconnect</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#ab316ed8a30c968085fa503e6c215e2f1">mrmailbox_forward_msgs</a>(mrmailbox_t *mailbox, const uint32_t *msg_ids, int msg_cnt, uint32_t chat_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a011705ea76c8f9017b999eb009eec9ce">mrmailbox_get_blobdir</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a209e3832cd680d4677582923695ae872">mrmailbox_get_blocked_contacts</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a6c749ad5736d9c34ff492015ea10a184">mrmailbox_get_blocked_count</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#ad106b9c23b3a559b524a37bb5504e096">mrmailbox_get_chat</a>(mrmailbox_t *mailbox, uint32_t chat_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#ab996f74d0e8b5c82ec7175f29da57e3d">mrmailbox_get_chat_contacts</a>(mrmailbox_t *mailbox, uint32_t chat_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a97eb029d9dd0d33ae492217608958a73">mrmailbox_get_chat_id_by_contact_id</a>(mrmailbox_t *mailbox, uint32_t contact_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a4c69c290d57aa2b76f0260c0c2702023">mrmailbox_get_chat_media</a>(mrmailbox_t *mailbox, uint32_t chat_id, int msg_type, int or_msg_type)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#af5ac7f527aef58f8e834f3bd740acd46">mrmailbox_get_chat_msgs</a>(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t flags, uint32_t marker1before)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19">mrmailbox_get_chatlist</a>(mrmailbox_t *mailbox, int listflags, const char *query)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#aeb12e9631508fd76e3e9828a82031767">mrmailbox_get_config</a>(mrmailbox_t *ths, const char *key, const char *def)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#afba149fcbcb5a069113aed4336f4bcc7">mrmailbox_get_config_int</a>(mrmailbox_t *ths, const char *key, int32_t def)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a057660d94350ff98eca72785c6e88962">mrmailbox_get_contact</a>(mrmailbox_t *mailbox, uint32_t contact_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#aa4d582bc9d6d80e43038d213b081031f">mrmailbox_get_contact_encrinfo</a>(mrmailbox_t *mailbox, uint32_t contact_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#adcdfd1e0899d3c9778238d49933813a5">mrmailbox_get_fresh_msg_count</a>(mrmailbox_t *mailbox, uint32_t chat_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a65215149290bec16b173106269b08e5e">mrmailbox_get_fresh_msgs</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a4b3257b21c3c9ff539fc6a9315be1164">mrmailbox_get_info</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#ae4ccc69ba8e8851a04f9b17b37e5f86a">mrmailbox_get_known_contacts</a>(mrmailbox_t *mailbox, const char *query)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13">mrmailbox_get_msg</a>(mrmailbox_t *mailbox, uint32_t msg_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a13e05fe3f43102c3323ba4c7e2761593">mrmailbox_get_msg_info</a>(mrmailbox_t *mailbox, uint32_t msg_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a90b7861302d1276a07fdcb2d9c3c73b6">mrmailbox_get_next_media</a>(mrmailbox_t *mailbox, uint32_t curr_msg_id, int dir)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a5c17b77d9d26022f0bdbef548d37b5c6">mrmailbox_get_total_msg_count</a>(mrmailbox_t *mailbox, uint32_t chat_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#ac2b34d49d1bd41c2fdb77140c607225c">mrmailbox_get_userdata</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a74bd83d36d90e1201e5ab8003d9a312f">mrmailbox_get_version_str</a>(void)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a6faa8ec4056da5d1d664d88d3f6cf176">mrmailbox_heartbeat</a>(mrmailbox_t *ths)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a7db60273eae74ebbc74231f4c6d7204f">mrmailbox_imex</a>(mrmailbox_t *mailbox, int what, const char *param1, const char *param2)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#abcb59b494a430c2d3d6e77cf433f5755">mrmailbox_imex_has_backup</a>(mrmailbox_t *mailbox, const char *dir_name)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a8662e21a209936e2070f6a59479bfef4">mrmailbox_initiate_key_transfer</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#aa6e325e49ecccfc96276db6c327dba94">mrmailbox_is_configured</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#ae37988665a3d46f42a7e8199d18735c2">mrmailbox_is_contact_in_chat</a>(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t contact_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#aace7cd8b68f45b869956d5c7476a1da0">mrmailbox_is_open</a>(const mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a07cc8fe0cfd900a9449bffc4ca5a7a95">mrmailbox_marknoticed_chat</a>(mrmailbox_t *mailbox, uint32_t chat_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a7150c575193d43e048689aa264c74c79">mrmailbox_marknoticed_contact</a>(mrmailbox_t *mailbox, uint32_t contact_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a67281e50b568dc18df710275e0e13f5b">mrmailbox_markseen_msgs</a>(mrmailbox_t *mailbox, const uint32_t *msg_ids, int msg_cnt)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a">mrmailbox_new</a>(mrmailboxcb_t cb, void *userdata, const char *os_name)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#ae4c9c9f9ce4b3de82b3ce7fc582cbc5b">mrmailbox_open</a>(mrmailbox_t *mailbox, const char *dbfile, const char *blobdir)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a40226d401548b002a62648ea054ac635">mrmailbox_remove_contact_from_chat</a>(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t contact_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__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="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#ae24df813f179fdab160f94c583c63401">mrmailbox_send_audio_msg</a>(mrmailbox_t *mailbox, uint32_t chat_id, const char *file, const char *filemime, int duration, const char *author, const char *trackname)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a7f39fa026b22360e282c9138e5af4ce9">mrmailbox_send_file_msg</a>(mrmailbox_t *mailbox, uint32_t chat_id, const char *file, const char *filemime)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a2fdedd72b9f792463e4af173f21bb11c">mrmailbox_send_image_msg</a>(mrmailbox_t *mailbox, uint32_t chat_id, const char *file, const char *filemime, int width, int height)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__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="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a88e7fe7faa3576c086b6d3e0ab825892">mrmailbox_send_vcard_msg</a>(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t contact_id)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a8c0dc35fd9696d35f6a8301501f37c5a">mrmailbox_send_video_msg</a>(mrmailbox_t *mailbox, uint32_t chat_id, const char *file, const char *filemime, int width, int height, int duration)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a42935531261ba3ed8afd82cf39fe928a">mrmailbox_send_voice_msg</a>(mrmailbox_t *mailbox, uint32_t chat_id, const char *file, const char *filemime, int duration)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__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="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__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="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad">mrmailbox_set_config</a>(mrmailbox_t *ths, const char *key, const char *value)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__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="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__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="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a8ed1c3bd08cd6515abf6046ebad9cafc">mrmailbox_star_msgs</a>(mrmailbox_t *mailbox, const uint32_t *msg_ids, int msg_cnt, int star)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#ad42351c0369ed1b60f23ee0d6e96bc44">mrmailbox_stop_ongoing_process</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmailbox__t.html#a825cec4a85da05335674eae221d51374">mrmailbox_unref</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmailbox__t.html#a957f0bbae60f389bac40acf42b68b134">mrmailboxcb_t</a> typedef</td><td class="entry"><a class="el" href="classmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
|
||||||
|
</table></div><!-- contents -->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||||
|
</a> 1.8.11
|
||||||
|
</small></address>
|
||||||
|
</body>
|
||||||
|
</html>
|
3128
docs/html/classmrmailbox__t.html
Normal file
3128
docs/html/classmrmailbox__t.html
Normal file
File diff suppressed because it is too large
Load diff
126
docs/html/classmrmsg__t-members.html
Normal file
126
docs/html/classmrmsg__t-members.html
Normal file
|
@ -0,0 +1,126 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||||||
|
<title>Delta Chat Core C-API: Member List</title>
|
||||||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||||||
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||||
|
<script type="text/javascript" src="search/search.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(document).ready(function() { init_search(); });
|
||||||
|
</script>
|
||||||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">Delta Chat Core C-API
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!-- end header part -->
|
||||||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||||
|
</script>
|
||||||
|
<div id="navrow1" class="tabs">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||||
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||||||
|
<li>
|
||||||
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||||
|
<span class="left">
|
||||||
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
alt=""/>
|
||||||
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||||
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||||
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||||
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||||
|
</span><span class="right">
|
||||||
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div id="navrow2" class="tabs2">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!-- window showing the filter options -->
|
||||||
|
<div id="MSearchSelectWindow"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- iframe showing the search results (closed by default) -->
|
||||||
|
<div id="MSearchResultsWindow">
|
||||||
|
<iframe src="javascript:void(0)" frameborder="0"
|
||||||
|
name="MSearchResults" id="MSearchResults">
|
||||||
|
</iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div><!-- top -->
|
||||||
|
<div class="header">
|
||||||
|
<div class="headertitle">
|
||||||
|
<div class="title">mrmsg_t Member List</div> </div>
|
||||||
|
</div><!--header-->
|
||||||
|
<div class="contents">
|
||||||
|
|
||||||
|
<p>This is the complete list of members for <a class="el" href="classmrmsg__t.html">mrmsg_t</a>, including all inherited members.</p>
|
||||||
|
<table class="directory">
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#a6c5dd1ee3ae07f25c7ae9144832b5a13">mrmsg_get_chat_id</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmsg__t.html#aa180c0fd4c9cdd58cc47006022ebc1e0">mrmsg_get_duration</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#a2544769c77af5447546fcf5fc95c64f7">mrmsg_get_file</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmsg__t.html#afd11616dcf572662561829c0f48ca713">mrmsg_get_filebytes</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#a4afcbb38dd1f37fb5f7b2c6d1f4e9042">mrmsg_get_filemime</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmsg__t.html#ad0dcfc0a1e33d9a88b7381e368d7895a">mrmsg_get_filename</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#a31b0a7ba0ac76b79786179916f4f58be">mrmsg_get_from_id</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmsg__t.html#a8600ed157b44b1089783e66ce7b33353">mrmsg_get_height</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#aba03d1355c52426e2915c8d2d35bf13d">mrmsg_get_id</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmsg__t.html#a1c6dfee4004fe0e9b9f90720bad73ecb">mrmsg_get_mediainfo</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#a7ef8629603b2462f890dfbbe304c8f7d">mrmsg_get_setupcodebegin</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmsg__t.html#a7f1bd3d845bbc5face7636aed8f8afd4">mrmsg_get_showpadlock</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5">mrmsg_get_state</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmsg__t.html#a3c14a8dbd6cc7f90c642223a873312e3">mrmsg_get_summary</a>(mrmsg_t *msg, mrchat_t *chat)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#a8c8c1f342f01439ae40c5cf37532387e">mrmsg_get_summarytext</a>(mrmsg_t *msg, int approx_characters)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmsg__t.html#ae549e58d9ae2f73ad76bd27636b43982">mrmsg_get_text</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#af5bf52ee1adbc55c9c9d4699afee87fb">mrmsg_get_timestamp</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmsg__t.html#a705454903b36ded8c3cd43a2044de60a">mrmsg_get_type</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#adfe10086430b562b8df4e45668b51927">mrmsg_get_width</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmsg__t.html#a3256ed8c6a55a6c1a30e0fce33b85421">mrmsg_is_forwarded</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#a32d23bac4bf35ed5f8c2cfbb93d636f5">mrmsg_is_increation</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmsg__t.html#a7714f0f25b2e933dae0898965373b27d">mrmsg_is_sent</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#ab669ae58ca580d2694c6df3c95ddb89a">mrmsg_is_setupmessage</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmsg__t.html#af202a7e7527df4681cd3ea24f779848f">mrmsg_is_starred</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#a752209192e3a022d087fe6c647fb3ad9">mrmsg_is_systemcmd</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr><td class="entry"><a class="el" href="classmrmsg__t.html#a9e5dc81d4e814284b465ad23abbfb6cb">mrmsg_latefiling_mediasize</a>(mrmsg_t *msg, int width, int height, int duration)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
<tr class="even"><td class="entry"><a class="el" href="classmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02">mrmsg_unref</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="classmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
|
||||||
|
</table></div><!-- contents -->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||||
|
</a> 1.8.11
|
||||||
|
</small></address>
|
||||||
|
</body>
|
||||||
|
</html>
|
985
docs/html/classmrmsg__t.html
Normal file
985
docs/html/classmrmsg__t.html
Normal file
|
@ -0,0 +1,985 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||||
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
||||||
|
<title>Delta Chat Core C-API: mrmsg_t Class Reference</title>
|
||||||
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="dynsections.js"></script>
|
||||||
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||||
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||||
|
<script type="text/javascript" src="search/search.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
$(document).ready(function() { init_search(); });
|
||||||
|
</script>
|
||||||
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||||
|
<div id="titlearea">
|
||||||
|
<table cellspacing="0" cellpadding="0">
|
||||||
|
<tbody>
|
||||||
|
<tr style="height: 56px;">
|
||||||
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||||||
|
<div id="projectname">Delta Chat Core C-API
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<!-- end header part -->
|
||||||
|
<!-- Generated by Doxygen 1.8.11 -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||||
|
</script>
|
||||||
|
<div id="navrow1" class="tabs">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||||
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||||||
|
<li>
|
||||||
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||||
|
<span class="left">
|
||||||
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
alt=""/>
|
||||||
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||||
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||||
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||||
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||||
|
</span><span class="right">
|
||||||
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div id="navrow2" class="tabs2">
|
||||||
|
<ul class="tablist">
|
||||||
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||||
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<!-- window showing the filter options -->
|
||||||
|
<div id="MSearchSelectWindow"
|
||||||
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||||
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||||
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- iframe showing the search results (closed by default) -->
|
||||||
|
<div id="MSearchResultsWindow">
|
||||||
|
<iframe src="javascript:void(0)" frameborder="0"
|
||||||
|
name="MSearchResults" id="MSearchResults">
|
||||||
|
</iframe>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div><!-- top -->
|
||||||
|
<div class="header">
|
||||||
|
<div class="summary">
|
||||||
|
<a href="#pub-methods">Public Member Functions</a> |
|
||||||
|
<a href="classmrmsg__t-members.html">List of all members</a> </div>
|
||||||
|
<div class="headertitle">
|
||||||
|
<div class="title">mrmsg_t Class Reference</div> </div>
|
||||||
|
</div><!--header-->
|
||||||
|
<div class="contents">
|
||||||
|
|
||||||
|
<p>An object representing a single message in memory.
|
||||||
|
<a href="classmrmsg__t.html#details">More...</a></p>
|
||||||
|
|
||||||
|
<p><code>#include <<a class="el" href="mrmsg_8h_source.html">mrmsg.h</a>></code></p>
|
||||||
|
<table class="memberdecls">
|
||||||
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||||
|
Public Member Functions</h2></td></tr>
|
||||||
|
<tr class="memitem:aa33212e41efff643aa7290753f3d9b02"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02">mrmsg_unref</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:aa33212e41efff643aa7290753f3d9b02"><td class="mdescLeft"> </td><td class="mdescRight">Free a message object. <a href="#aa33212e41efff643aa7290753f3d9b02">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:aa33212e41efff643aa7290753f3d9b02"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:aba03d1355c52426e2915c8d2d35bf13d"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#aba03d1355c52426e2915c8d2d35bf13d">mrmsg_get_id</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:aba03d1355c52426e2915c8d2d35bf13d"><td class="mdescLeft"> </td><td class="mdescRight">Get the ID of the message. <a href="#aba03d1355c52426e2915c8d2d35bf13d">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:aba03d1355c52426e2915c8d2d35bf13d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a31b0a7ba0ac76b79786179916f4f58be"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a31b0a7ba0ac76b79786179916f4f58be">mrmsg_get_from_id</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a31b0a7ba0ac76b79786179916f4f58be"><td class="mdescLeft"> </td><td class="mdescRight">Get the ID of contact who wrote the message. <a href="#a31b0a7ba0ac76b79786179916f4f58be">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a31b0a7ba0ac76b79786179916f4f58be"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a6c5dd1ee3ae07f25c7ae9144832b5a13"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a6c5dd1ee3ae07f25c7ae9144832b5a13">mrmsg_get_chat_id</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a6c5dd1ee3ae07f25c7ae9144832b5a13"><td class="mdescLeft"> </td><td class="mdescRight">Get the ID of chat the message belongs to. <a href="#a6c5dd1ee3ae07f25c7ae9144832b5a13">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a6c5dd1ee3ae07f25c7ae9144832b5a13"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a705454903b36ded8c3cd43a2044de60a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a705454903b36ded8c3cd43a2044de60a">mrmsg_get_type</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a705454903b36ded8c3cd43a2044de60a"><td class="mdescLeft"> </td><td class="mdescRight">Get the type of the message. <a href="#a705454903b36ded8c3cd43a2044de60a">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a705454903b36ded8c3cd43a2044de60a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a1f411e4be17fb5fe408a1aa74cba90a5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5">mrmsg_get_state</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a1f411e4be17fb5fe408a1aa74cba90a5"><td class="mdescLeft"> </td><td class="mdescRight">Get the state of a message. <a href="#a1f411e4be17fb5fe408a1aa74cba90a5">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a1f411e4be17fb5fe408a1aa74cba90a5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:af5bf52ee1adbc55c9c9d4699afee87fb"><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#af5bf52ee1adbc55c9c9d4699afee87fb">mrmsg_get_timestamp</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:af5bf52ee1adbc55c9c9d4699afee87fb"><td class="mdescLeft"> </td><td class="mdescRight">Get message time. <a href="#af5bf52ee1adbc55c9c9d4699afee87fb">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:af5bf52ee1adbc55c9c9d4699afee87fb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:ae549e58d9ae2f73ad76bd27636b43982"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#ae549e58d9ae2f73ad76bd27636b43982">mrmsg_get_text</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:ae549e58d9ae2f73ad76bd27636b43982"><td class="mdescLeft"> </td><td class="mdescRight">Get the text of the message. <a href="#ae549e58d9ae2f73ad76bd27636b43982">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:ae549e58d9ae2f73ad76bd27636b43982"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a2544769c77af5447546fcf5fc95c64f7"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a2544769c77af5447546fcf5fc95c64f7">mrmsg_get_file</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a2544769c77af5447546fcf5fc95c64f7"><td class="mdescLeft"> </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"> </td></tr>
|
||||||
|
<tr class="memitem:ad0dcfc0a1e33d9a88b7381e368d7895a"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#ad0dcfc0a1e33d9a88b7381e368d7895a">mrmsg_get_filename</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:ad0dcfc0a1e33d9a88b7381e368d7895a"><td class="mdescLeft"> </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"> </td></tr>
|
||||||
|
<tr class="memitem:a4afcbb38dd1f37fb5f7b2c6d1f4e9042"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a4afcbb38dd1f37fb5f7b2c6d1f4e9042">mrmsg_get_filemime</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a4afcbb38dd1f37fb5f7b2c6d1f4e9042"><td class="mdescLeft"> </td><td class="mdescRight">Get mime type of the file. <a href="#a4afcbb38dd1f37fb5f7b2c6d1f4e9042">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a4afcbb38dd1f37fb5f7b2c6d1f4e9042"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:afd11616dcf572662561829c0f48ca713"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#afd11616dcf572662561829c0f48ca713">mrmsg_get_filebytes</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:afd11616dcf572662561829c0f48ca713"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the file. <a href="#afd11616dcf572662561829c0f48ca713">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:afd11616dcf572662561829c0f48ca713"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a1c6dfee4004fe0e9b9f90720bad73ecb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a1c6dfee4004fe0e9b9f90720bad73ecb">mrmsg_get_mediainfo</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a1c6dfee4004fe0e9b9f90720bad73ecb"><td class="mdescLeft"> </td><td class="mdescRight">Get real author and title. <a href="#a1c6dfee4004fe0e9b9f90720bad73ecb">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a1c6dfee4004fe0e9b9f90720bad73ecb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:adfe10086430b562b8df4e45668b51927"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#adfe10086430b562b8df4e45668b51927">mrmsg_get_width</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:adfe10086430b562b8df4e45668b51927"><td class="mdescLeft"> </td><td class="mdescRight">Get width of image or video. <a href="#adfe10086430b562b8df4e45668b51927">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:adfe10086430b562b8df4e45668b51927"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a8600ed157b44b1089783e66ce7b33353"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a8600ed157b44b1089783e66ce7b33353">mrmsg_get_height</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a8600ed157b44b1089783e66ce7b33353"><td class="mdescLeft"> </td><td class="mdescRight">Get height of image or video. <a href="#a8600ed157b44b1089783e66ce7b33353">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a8600ed157b44b1089783e66ce7b33353"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:aa180c0fd4c9cdd58cc47006022ebc1e0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#aa180c0fd4c9cdd58cc47006022ebc1e0">mrmsg_get_duration</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:aa180c0fd4c9cdd58cc47006022ebc1e0"><td class="mdescLeft"> </td><td class="mdescRight">Get duration of audio or video. <a href="#aa180c0fd4c9cdd58cc47006022ebc1e0">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:aa180c0fd4c9cdd58cc47006022ebc1e0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a7f1bd3d845bbc5face7636aed8f8afd4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a7f1bd3d845bbc5face7636aed8f8afd4">mrmsg_get_showpadlock</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a7f1bd3d845bbc5face7636aed8f8afd4"><td class="mdescLeft"> </td><td class="mdescRight">Check if a padlock should be shown beside the message. <a href="#a7f1bd3d845bbc5face7636aed8f8afd4">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a7f1bd3d845bbc5face7636aed8f8afd4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a3c14a8dbd6cc7f90c642223a873312e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrlot__t.html">mrlot_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a3c14a8dbd6cc7f90c642223a873312e3">mrmsg_get_summary</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg, <a class="el" href="classmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
||||||
|
<tr class="memdesc:a3c14a8dbd6cc7f90c642223a873312e3"><td class="mdescLeft"> </td><td class="mdescRight">Get a summary for a message. <a href="#a3c14a8dbd6cc7f90c642223a873312e3">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a3c14a8dbd6cc7f90c642223a873312e3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a8c8c1f342f01439ae40c5cf37532387e"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a8c8c1f342f01439ae40c5cf37532387e">mrmsg_get_summarytext</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg, int approx_characters)</td></tr>
|
||||||
|
<tr class="memdesc:a8c8c1f342f01439ae40c5cf37532387e"><td class="mdescLeft"> </td><td class="mdescRight">Get a message summary as a single line of text. <a href="#a8c8c1f342f01439ae40c5cf37532387e">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a8c8c1f342f01439ae40c5cf37532387e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a7714f0f25b2e933dae0898965373b27d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a7714f0f25b2e933dae0898965373b27d">mrmsg_is_sent</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a7714f0f25b2e933dae0898965373b27d"><td class="mdescLeft"> </td><td class="mdescRight">Check if a message was sent successfully. <a href="#a7714f0f25b2e933dae0898965373b27d">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a7714f0f25b2e933dae0898965373b27d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:af202a7e7527df4681cd3ea24f779848f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#af202a7e7527df4681cd3ea24f779848f">mrmsg_is_starred</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:af202a7e7527df4681cd3ea24f779848f"><td class="mdescLeft"> </td><td class="mdescRight">Check if a message is starred. <a href="#af202a7e7527df4681cd3ea24f779848f">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:af202a7e7527df4681cd3ea24f779848f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a3256ed8c6a55a6c1a30e0fce33b85421"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a3256ed8c6a55a6c1a30e0fce33b85421">mrmsg_is_forwarded</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a3256ed8c6a55a6c1a30e0fce33b85421"><td class="mdescLeft"> </td><td class="mdescRight">Check if the message is a forwarded message. <a href="#a3256ed8c6a55a6c1a30e0fce33b85421">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a3256ed8c6a55a6c1a30e0fce33b85421"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a752209192e3a022d087fe6c647fb3ad9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a752209192e3a022d087fe6c647fb3ad9">mrmsg_is_systemcmd</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a752209192e3a022d087fe6c647fb3ad9"><td class="mdescLeft"> </td><td class="mdescRight">Check if the message is a system command. <a href="#a752209192e3a022d087fe6c647fb3ad9">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a752209192e3a022d087fe6c647fb3ad9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:ab669ae58ca580d2694c6df3c95ddb89a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#ab669ae58ca580d2694c6df3c95ddb89a">mrmsg_is_setupmessage</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:ab669ae58ca580d2694c6df3c95ddb89a"><td class="mdescLeft"> </td><td class="mdescRight">Check if the message is an Autocrypt Setup Message. <a href="#ab669ae58ca580d2694c6df3c95ddb89a">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:ab669ae58ca580d2694c6df3c95ddb89a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a7ef8629603b2462f890dfbbe304c8f7d"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a7ef8629603b2462f890dfbbe304c8f7d">mrmsg_get_setupcodebegin</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a7ef8629603b2462f890dfbbe304c8f7d"><td class="mdescLeft"> </td><td class="mdescRight">Get the first characters of the setup code. <a href="#a7ef8629603b2462f890dfbbe304c8f7d">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a7ef8629603b2462f890dfbbe304c8f7d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
<tr class="memitem:a32d23bac4bf35ed5f8c2cfbb93d636f5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a32d23bac4bf35ed5f8c2cfbb93d636f5">mrmsg_is_increation</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
|
||||||
|
<tr class="memdesc:a32d23bac4bf35ed5f8c2cfbb93d636f5"><td class="mdescLeft"> </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"> </td></tr>
|
||||||
|
<tr class="memitem:a9e5dc81d4e814284b465ad23abbfb6cb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrmsg__t.html#a9e5dc81d4e814284b465ad23abbfb6cb">mrmsg_latefiling_mediasize</a> (<a class="el" href="classmrmsg__t.html">mrmsg_t</a> *msg, int width, int height, int duration)</td></tr>
|
||||||
|
<tr class="memdesc:a9e5dc81d4e814284b465ad23abbfb6cb"><td class="mdescLeft"> </td><td class="mdescRight">Late filing information to a message. <a href="#a9e5dc81d4e814284b465ad23abbfb6cb">More...</a><br /></td></tr>
|
||||||
|
<tr class="separator:a9e5dc81d4e814284b465ad23abbfb6cb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||||
|
</table>
|
||||||
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||||
|
<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="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="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Free a message object. </p>
|
||||||
|
<p>Message objects are created eg. by <a class="el" href="classmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13" title="Get a single message object of the type mrmsg_t. ">mrmailbox_get_msg()</a>.</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="aba03d1355c52426e2915c8d2d35bf13d"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">uint32_t mrmsg_get_id </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get the ID 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>the ID of the message, 0 on errors. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a31b0a7ba0ac76b79786179916f4f58be"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">uint32_t mrmsg_get_from_id </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get the ID of contact who wrote the message. </p>
|
||||||
|
<p>To get details about the contact, pass the returned ID to <a class="el" href="classmrmailbox__t.html#a057660d94350ff98eca72785c6e88962" title="Get a single contact object. ">mrmailbox_get_contact()</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 ID of the contact who wrote the message, MR_CONTACT_ID_SELF (1) if this is an outgoing message, 0 on errors. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a6c5dd1ee3ae07f25c7ae9144832b5a13"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">uint32_t mrmsg_get_chat_id </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get the ID of chat the message belongs to. </p>
|
||||||
|
<p>To get details about the chat, pass the returned ID to <a class="el" href="classmrmailbox__t.html#ad106b9c23b3a559b524a37bb5504e096" title="Get chat object by a chat ID. ">mrmailbox_get_chat()</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 ID of the chat the message belongs to, 0 on errors. </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="classmrmsg__t.html">mrmsg_t</a> * </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="classmrmsg__t.html">mrmsg_t</a> * </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="classmrmailbox__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="classmrmailbox__t.html#a07cc8fe0cfd900a9449bffc4ca5a7a95" title="Mark all message in a chat as noticed. ">mrmailbox_marknoticed_chat()</a> or <a class="el" href="classmrmailbox__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="classmrmailbox__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 sent 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>If you just want to check if a message is sent or not, please use <a class="el" href="classmrmsg__t.html#a7714f0f25b2e933dae0898965373b27d" title="Check if a message was sent successfully. ">mrmsg_is_sent()</a> which regards all states accordingly.</p>
|
||||||
|
<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="classmrmailbox__t.html#a07cc8fe0cfd900a9449bffc4ca5a7a95" title="Mark all message in a chat as noticed. ">mrmailbox_marknoticed_chat()</a> or <a class="el" href="classmrmailbox__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="af5bf52ee1adbc55c9c9d4699afee87fb"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">time_t mrmsg_get_timestamp </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get message time. </p>
|
||||||
|
<p>Unix time the message was sended or received.</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 time 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="classmrmsg__t.html">mrmsg_t</a> * </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>
|
||||||
|
<p>If there is no text associalted with the message, an empty string is returned. NULL is never returned.</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. Never returns NULL. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a2544769c77af5447546fcf5fc95c64f7"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">char * mrmsg_get_file </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Find out full path, file name and extension of the file associated with a message. </p>
|
||||||
|
<p>Typically files are associated with images, videos, audios, documents. Plain text messages do not have a file.</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>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="classmrmsg__t.html">mrmsg_t</a> * </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="classmrmsg__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="a4afcbb38dd1f37fb5f7b2c6d1f4e9042"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">char * mrmsg_get_filemime </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get mime type of the file. </p>
|
||||||
|
<p>If there is not file, an empty string is returned. If there is no associated mime type with the file, the function guesses on; if in doubt, <code>application/octet-stream</code> is returned. NULL is never returned.</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>String containing the mime type. Must be free()'d after usage. NULL is never returned. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="afd11616dcf572662561829c0f48ca713"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">uint64_t mrmsg_get_filebytes </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get the size of the file. </p>
|
||||||
|
<p>Returns the size of the file associated with a message, if applicable.</p>
|
||||||
|
<p>Typically, this is used to show the size of document messages, eg. a PDF.</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>File size in bytes, 0 if not applicable or on errors. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a1c6dfee4004fe0e9b9f90720bad73ecb"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname"><a class="el" href="classmrlot__t.html">mrlot_t</a> * mrmsg_get_mediainfo </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get real author and title. </p>
|
||||||
|
<p>The information is returned by a <a class="el" href="classmrlot__t.html" title="An object containing a set of values. ">mrlot_t</a> object with the following fields:</p>
|
||||||
|
<ul>
|
||||||
|
<li>mrlot_t::m_text1: Author of the media. For voice messages, this is the sender. For music messages, the information are read from the filename. NULL if unknown.</li>
|
||||||
|
<li>mrlot_t::m_text2: Title of the media. For voice messages, this is the date. For music messages, the information are read from the filename. NULL if unknown.</li>
|
||||||
|
</ul>
|
||||||
|
<p>Currently, we do not read ID3 and such at this stage, the needed libraries are too complicated and oversized. However, this is no big problem, as the sender usually sets the filename in a way we expect it.</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>Media information as an <a class="el" href="classmrlot__t.html" title="An object containing a set of values. ">mrlot_t</a> object. Must be freed using <a class="el" href="classmrlot__t.html#a813e4d0c2f135e962cc4d5ac0753c592" title="Frees an object containing a set of parameters. ">mrlot_unref()</a>. NULL is never returned. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="adfe10086430b562b8df4e45668b51927"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrmsg_get_width </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get width of image or video. </p>
|
||||||
|
<p>The width is returned in pixels. If the width is unknown or if the associated file is no image or video file, 0 is returned.</p>
|
||||||
|
<p>Often the ascpect ratio is the more interesting thing. You can calculate this using <a class="el" href="classmrmsg__t.html#adfe10086430b562b8df4e45668b51927" title="Get width of image or video. ">mrmsg_get_width()</a> / <a class="el" href="classmrmsg__t.html#a8600ed157b44b1089783e66ce7b33353" title="Get height of image or video. ">mrmsg_get_height()</a>.</p>
|
||||||
|
<p>See also <a class="el" href="classmrmsg__t.html#aa180c0fd4c9cdd58cc47006022ebc1e0" title="Get duration of audio or video. ">mrmsg_get_duration()</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>Width in pixels, if applicable. 0 otherwise or if unknown. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a8600ed157b44b1089783e66ce7b33353"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrmsg_get_height </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get height of image or video. </p>
|
||||||
|
<p>The height is returned in pixels. If the height is unknown or if the associated file is no image or video file, 0 is returned.</p>
|
||||||
|
<p>Often the ascpect ratio is the more interesting thing. You can calculate this using <a class="el" href="classmrmsg__t.html#adfe10086430b562b8df4e45668b51927" title="Get width of image or video. ">mrmsg_get_width()</a> / <a class="el" href="classmrmsg__t.html#a8600ed157b44b1089783e66ce7b33353" title="Get height of image or video. ">mrmsg_get_height()</a>.</p>
|
||||||
|
<p>See also <a class="el" href="classmrmsg__t.html#aa180c0fd4c9cdd58cc47006022ebc1e0" title="Get duration of audio or video. ">mrmsg_get_duration()</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>Height in pixels, if applicable. 0 otherwise or if unknown. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="aa180c0fd4c9cdd58cc47006022ebc1e0"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrmsg_get_duration </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get duration of audio or video. </p>
|
||||||
|
<p>The duration is returned in milliseconds (ms). If the duration is unknown or if the associated file is no audio or video file, 0 is returned.</p>
|
||||||
|
<p>See also <a class="el" href="classmrmsg__t.html#adfe10086430b562b8df4e45668b51927" title="Get width of image or video. ">mrmsg_get_width()</a> and <a class="el" href="classmrmsg__t.html#a8600ed157b44b1089783e66ce7b33353" title="Get height of image or video. ">mrmsg_get_height()</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>Duration in milliseconds, if applicable. 0 otherwise or if unknown. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a7f1bd3d845bbc5face7636aed8f8afd4"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrmsg_get_showpadlock </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Check if a padlock should be shown beside 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>1=padlock should be shown beside message, 0=do not show a padlock beside the message. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a3c14a8dbd6cc7f90c642223a873312e3"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname"><a class="el" href="classmrlot__t.html">mrlot_t</a> * mrmsg_get_summary </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em>, </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="paramkey"></td>
|
||||||
|
<td></td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrchat__t.html">mrchat_t</a> * </td>
|
||||||
|
<td class="paramname"><em>chat</em> </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td></td>
|
||||||
|
<td>)</td>
|
||||||
|
<td></td><td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get a summary for a message. </p>
|
||||||
|
<p>The summary is returned by a <a class="el" href="classmrlot__t.html" title="An object containing a set of values. ">mrlot_t</a> object with the following fields:</p>
|
||||||
|
<ul>
|
||||||
|
<li>mrlot_t::m_text1: contains the username or the string "Me". The string may be colored by having a look at m_text1_meaning. If the name should not be displayed, the element is NULL.</li>
|
||||||
|
<li>mrlot_t::m_text1_meaning: one of MR_TEXT1_USERNAME or MR_TEXT1_SELF. Typically used to show mrlot_t::m_text1 with different colors. 0 if not applicable.</li>
|
||||||
|
<li>mrlot_t::m_text2: contains an excerpt of the message text.</li>
|
||||||
|
<li>mrlot_t::m_timestamp: the timestamp of the message.</li>
|
||||||
|
<li>mrlot_t::m_state: The state of the message as one of the MR_STATE_* constants (see <a class="el" href="classmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5" title="Get the state of a message. ">mrmsg_get_state()</a>).</li>
|
||||||
|
</ul>
|
||||||
|
<p>Typically used to display a search result. See also <a class="el" href="classmrchatlist__t.html#a7bb0e80673ca253c7cb71ae6b9d4fa97" title="Get a summary for a chatlist index. ">mrchatlist_get_summary()</a> to display a list of chats.</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">msg</td><td>The message object.</td></tr>
|
||||||
|
<tr><td class="paramname">chat</td><td>To speed up things, pass an already available chat object here. If the chat object is not yet available, it is faster to pass NULL.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>The summary as an <a class="el" href="classmrlot__t.html" title="An object containing a set of values. ">mrlot_t</a> object. Must be freed using <a class="el" href="classmrlot__t.html#a813e4d0c2f135e962cc4d5ac0753c592" title="Frees an object containing a set of parameters. ">mrlot_unref()</a>. NULL is never returned. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a8c8c1f342f01439ae40c5cf37532387e"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">char * mrmsg_get_summarytext </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em>, </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="paramkey"></td>
|
||||||
|
<td></td>
|
||||||
|
<td class="paramtype">int </td>
|
||||||
|
<td class="paramname"><em>approx_characters</em> </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td></td>
|
||||||
|
<td>)</td>
|
||||||
|
<td></td><td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get a message summary as a single line of text. </p>
|
||||||
|
<p>Typically used for notifications.</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">msg</td><td>The message object.</td></tr>
|
||||||
|
<tr><td class="paramname">approx_characters</td><td>Rough length of the expected string.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</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="a7714f0f25b2e933dae0898965373b27d"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrmsg_is_sent </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Check if a message was sent successfully. </p>
|
||||||
|
<p>Currently, "sent" messages are messages that are in the state "delivered" or "mdn received", see <a class="el" href="classmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5" title="Get the state of a message. ">mrmsg_get_state()</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>1=message sent successfully, 0=message not yet sent or message is an incoming message. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="af202a7e7527df4681cd3ea24f779848f"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrmsg_is_starred </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Check if a message is starred. </p>
|
||||||
|
<p>Starred messages are "favorites" marked by the user with a "star" or something like that. Starred messages can typically be shown easily and are not deleted automatically.</p>
|
||||||
|
<p>To star one or more messages, use <a class="el" href="classmrmailbox__t.html#a8ed1c3bd08cd6515abf6046ebad9cafc" title="Star/unstar messages by setting the last parameter to 0 (unstar) or 1(star). ">mrmailbox_star_msgs()</a>, to get a list of starred messages, use <a class="el" href="classmrmailbox__t.html#af5ac7f527aef58f8e834f3bd740acd46" title="Get all message IDs belonging to a chat. ">mrmailbox_get_chat_msgs()</a> using MR_CHAT_ID_STARRED as the chat_id.</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>1=message is starred, 0=message not starred. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a3256ed8c6a55a6c1a30e0fce33b85421"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrmsg_is_forwarded </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Check if the message is a forwarded message. </p>
|
||||||
|
<p>Forwarded messages may not be created by the contact given as "from".</p>
|
||||||
|
<p>Typically, the UI shows a little text for a symbol above forwarded messages.</p>
|
||||||
|
<p>For privacy reasons, we do not provide the name or the email address of the original author (in a typical GUI, you select the messages text and click on "forwared"; you won't expect other data to be send to the new recipient, esp. as the new recipient may not be in any relationship to the original author)</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>1=message is a forwarded message, 0=message not forwarded. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a752209192e3a022d087fe6c647fb3ad9"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrmsg_is_systemcmd </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Check if the message is a system command. </p>
|
||||||
|
<p>System command messages are messages not "typed" by the user but created due to other actions, eg. <a class="el" href="classmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1" title="Set group name. ">mrmailbox_set_chat_name()</a>, <a class="el" href="classmrmailbox__t.html#a08c527170681c949ddd6931a004fdd5f" title="Set group profile image. ">mrmailbox_set_chat_profile_image()</a> or <a class="el" href="classmrmailbox__t.html#a96368620971935c7ac4a0bb324ece2c9" title="Add a member to a group. ">mrmailbox_add_contact_to_chat()</a>.</p>
|
||||||
|
<p><a class="el" href="classmrmsg__t.html#ae549e58d9ae2f73ad76bd27636b43982" title="Get the text of the message. ">mrmsg_get_text()</a> returns a descriptive text about what is going on.</p>
|
||||||
|
<p>There is no need to perfrom any action when seeing such a message - this is already done by the core. Typically, this text is displayed in another color or in another font than normal user messages.</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>1=message is a system command, 0=normal message </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="ab669ae58ca580d2694c6df3c95ddb89a"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrmsg_is_setupmessage </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Check if the message is an Autocrypt Setup Message. </p>
|
||||||
|
<p>Setup messages should be shown in an unique way eg. using a different text color. On a click or another action, the user should be prompted for the setup code which is forwarded to <a class="el" href="classmrmailbox__t.html#a13fde8828b56c0fe94227d0b105c5708" title="Continue the Autocrypt Key Transfer on another device. ">mrmailbox_continue_key_transfer()</a> then.</p>
|
||||||
|
<p>Setup message are typically generated by <a class="el" href="classmrmailbox__t.html#a8662e21a209936e2070f6a59479bfef4" title="Initiate Autocrypt Key Transfer. ">mrmailbox_initiate_key_transfer()</a> on another device.</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>1=message is a setup message, 0=no setup message. For setup messages, <a class="el" href="classmrmsg__t.html#a752209192e3a022d087fe6c647fb3ad9" title="Check if the message is a system command. ">mrmsg_is_systemcmd()</a> returns 1 and <a class="el" href="classmrmsg__t.html#a705454903b36ded8c3cd43a2044de60a" title="Get the type of the message. ">mrmsg_get_type()</a> returns MR_MSG_FILE. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a7ef8629603b2462f890dfbbe304c8f7d"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">char * mrmsg_get_setupcodebegin </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Get the first characters of the setup code. </p>
|
||||||
|
<p>Typically, this is used to pre-fill the first entry field of the setup code. If the user has several setup messages, he can be sure typing in the correct digits.</p>
|
||||||
|
<p>To check, if a message is a setup message, use <a class="el" href="classmrmsg__t.html#ab669ae58ca580d2694c6df3c95ddb89a" title="Check if the message is an Autocrypt Setup Message. ">mrmsg_is_setupmessage()</a>. To decrypt a secret key from a setup message, use <a class="el" href="classmrmailbox__t.html#a13fde8828b56c0fe94227d0b105c5708" title="Continue the Autocrypt Key Transfer on another device. ">mrmailbox_continue_key_transfer()</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>Typically, the first two digits of the setup code or an empty string if unknown. NULL is never returned. Must be free()'d when done. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a32d23bac4bf35ed5f8c2cfbb93d636f5"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">int mrmsg_is_increation </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</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><filename>.increation</code>. If <code><filename></code> is created then, the user should just delete <code><filename>.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>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>1=message is still in creation (<code><filename>.increation</code> exists), 0=message no longer in creation </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a class="anchor" id="a9e5dc81d4e814284b465ad23abbfb6cb"></a>
|
||||||
|
<div class="memitem">
|
||||||
|
<div class="memproto">
|
||||||
|
<table class="memname">
|
||||||
|
<tr>
|
||||||
|
<td class="memname">void mrmsg_latefiling_mediasize </td>
|
||||||
|
<td>(</td>
|
||||||
|
<td class="paramtype"><a class="el" href="classmrmsg__t.html">mrmsg_t</a> * </td>
|
||||||
|
<td class="paramname"><em>msg</em>, </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="paramkey"></td>
|
||||||
|
<td></td>
|
||||||
|
<td class="paramtype">int </td>
|
||||||
|
<td class="paramname"><em>width</em>, </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="paramkey"></td>
|
||||||
|
<td></td>
|
||||||
|
<td class="paramtype">int </td>
|
||||||
|
<td class="paramname"><em>height</em>, </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="paramkey"></td>
|
||||||
|
<td></td>
|
||||||
|
<td class="paramtype">int </td>
|
||||||
|
<td class="paramname"><em>duration</em> </td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td></td>
|
||||||
|
<td>)</td>
|
||||||
|
<td></td><td></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div><div class="memdoc">
|
||||||
|
|
||||||
|
<p>Late filing information to a message. </p>
|
||||||
|
<p>Sometimes, the core cannot find out the width, the height or the duration of an image, an audio or a video.</p>
|
||||||
|
<p>If, in these cases, the frontend can provide the information, it can save them together with the message object for later usage.</p>
|
||||||
|
<p>This function should only be used if <a class="el" href="classmrmsg__t.html#adfe10086430b562b8df4e45668b51927" title="Get width of image or video. ">mrmsg_get_width()</a>, <a class="el" href="classmrmsg__t.html#a8600ed157b44b1089783e66ce7b33353" title="Get height of image or video. ">mrmsg_get_height()</a> or <a class="el" href="classmrmsg__t.html#aa180c0fd4c9cdd58cc47006022ebc1e0" title="Get duration of audio or video. ">mrmsg_get_duration()</a> do not provide the expected values.</p>
|
||||||
|
<p>To get the stored values later, use <a class="el" href="classmrmsg__t.html#adfe10086430b562b8df4e45668b51927" title="Get width of image or video. ">mrmsg_get_width()</a>, <a class="el" href="classmrmsg__t.html#a8600ed157b44b1089783e66ce7b33353" title="Get height of image or video. ">mrmsg_get_height()</a> or <a class="el" href="classmrmsg__t.html#aa180c0fd4c9cdd58cc47006022ebc1e0" title="Get duration of audio or video. ">mrmsg_get_duration()</a>.</p>
|
||||||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||||||
|
<table class="params">
|
||||||
|
<tr><td class="paramname">msg</td><td>The message object.</td></tr>
|
||||||
|
<tr><td class="paramname">width</td><td>The new width to store in the message object. 0 if you do not want to change it.</td></tr>
|
||||||
|
<tr><td class="paramname">height</td><td>The new height to store in the message object. 0 if you do not want to change it.</td></tr>
|
||||||
|
<tr><td class="paramname">duration</td><td>The new duration to store in the message object. 0 if you do not want to change it.</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||||
|
<li>/home/bpetersen/projects/deltachat-core/src/<a class="el" href="mrmsg_8h_source.html">mrmsg.h</a></li>
|
||||||
|
<li>/home/bpetersen/projects/deltachat-core/src/mrmsg.c</li>
|
||||||
|
</ul>
|
||||||
|
</div><!-- contents -->
|
||||||
|
<!-- start footer part -->
|
||||||
|
<hr class="footer"/><address class="footer"><small>
|
||||||
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||||
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||||
|
</a> 1.8.11
|
||||||
|
</small></address>
|
||||||
|
</body>
|
||||||
|
</html>
|
101
docs/html/mrarray-private_8h_source.html
Normal file
101
docs/html/mrarray-private_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
102
docs/html/mrchat-private_8h_source.html
Normal file
102
docs/html/mrchat-private_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
103
docs/html/mrchatlist-private_8h_source.html
Normal file
103
docs/html/mrchatlist-private_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
101
docs/html/mrcontact-private_8h_source.html
Normal file
101
docs/html/mrcontact-private_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
100
docs/html/mrlot-private_8h_source.html
Normal file
100
docs/html/mrlot-private_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
103
docs/html/mrmailbox-private_8h_source.html
Normal file
103
docs/html/mrmailbox-private_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
102
docs/html/mrmsg-private_8h_source.html
Normal file
102
docs/html/mrmsg-private_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
Loading…
Add table
Add a link
Reference in a new issue