mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 18:29:19 +02:00
314 lines
18 KiB
HTML
314 lines
18 KiB
HTML
<!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 Struct 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="#pub-attribs">Public Attributes</a> |
|
|
<a href="structmrchatlist__t-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">mrchatlist_t Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>An object representing a single chatlist in memory.
|
|
<a href="structmrchatlist__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="structmrchatlist__t.html#ab036d6e066b5ff78779f36711c9ab2f9">mrchatlist_unref</a> (<a class="el" href="structmrchatlist__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="structmrchatlist__t.html#aa132119f18e40e3151ac5fe0299daab7">mrchatlist_get_cnt</a> (<a class="el" href="structmrchatlist__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="structmrchatlist__t.html#a8c8360c76b31057322199e8c51cadfa5">mrchatlist_get_chat_id</a> (<a class="el" href="structmrchatlist__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="structmrchatlist__t.html#a69b67135eeadbdbe9b4a60e645ef22b0">mrchatlist_get_msg_id</a> (<a class="el" href="structmrchatlist__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:ae7670d62ab7fc83aff18f299f26853d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrpoortext__t.html">mrpoortext_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchatlist__t.html#ae7670d62ab7fc83aff18f299f26853d8">mrchatlist_get_summary</a> (<a class="el" href="structmrchatlist__t.html">mrchatlist_t</a> *chatlist, size_t index, <a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
|
<tr class="memdesc:ae7670d62ab7fc83aff18f299f26853d8"><td class="mdescLeft"> </td><td class="mdescRight">Get a summary for a chatlist index. <a href="#ae7670d62ab7fc83aff18f299f26853d8">More...</a><br /></td></tr>
|
|
<tr class="separator:ae7670d62ab7fc83aff18f299f26853d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a025d213cde2fa547b2f3cae4e1facbf7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a025d213cde2fa547b2f3cae4e1facbf7"></a>
|
|
<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchatlist__t.html#a025d213cde2fa547b2f3cae4e1facbf7">m_mailbox</a></td></tr>
|
|
<tr class="memdesc:a025d213cde2fa547b2f3cae4e1facbf7"><td class="mdescLeft"> </td><td class="mdescRight">The mailbox, the chatlist belongs to. <br /></td></tr>
|
|
<tr class="separator:a025d213cde2fa547b2f3cae4e1facbf7"><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="structmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>. The chatlist object is not updated. If you want an update, you have to recreate the object. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="ab036d6e066b5ff78779f36711c9ab2f9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mrchatlist_unref </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrchatlist__t.html">mrchatlist_t</a> * </td>
|
|
<td class="paramname"><em>chatlist</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Free a chatlist object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">chatlist</td><td>The chatlist object to free, created eg. by <a class="el" href="structmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>, <a class="el" href="structmrmailbox__t.html#abbb08c91369ff2fedc8575f2e1f01e56" title="Search messages containing the given query string. ">mrmailbox_search_msgs()</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa132119f18e40e3151ac5fe0299daab7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t mrchatlist_get_cnt </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrchatlist__t.html">mrchatlist_t</a> * </td>
|
|
<td class="paramname"><em>chatlist</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Find out the number of chats in a chatlist. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">chatlist</td><td>The chatlist object as created eg. by <a class="el" href="structmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the number of items in a <a class="el" href="structmrchatlist__t.html" title="An object representing a single chatlist in memory. ">mrchatlist_t</a> object. 0 on errors or if the list is empty. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8c8360c76b31057322199e8c51cadfa5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mrchatlist_get_chat_id </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrchatlist__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="structmrmailbox__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="structmrmailbox__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="structmrchatlist__t.html#aa132119f18e40e3151ac5fe0299daab7" title="Find out the number of chats in a chatlist. ">mrchatlist_get_cnt()</a>-1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="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="structmrchatlist__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="structmrmailbox__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="structmrmailbox__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="structmrchatlist__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="ae7670d62ab7fc83aff18f299f26853d8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structmrpoortext__t.html">mrpoortext_t</a> * mrchatlist_get_summary </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrchatlist__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="structmrchat__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="structmrpoortext__t.html" title="An object representing text with some attributes. ">mrpoortext_t</a> object with the following fields:</p>
|
|
<ul>
|
|
<li>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, the element is NULL (eg. for "No messages")</li>
|
|
<li>m_text1_meaning: one of the MR_TEXT1_* constants</li>
|
|
<li>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)</li>
|
|
<li>m_timestamp: the timestamp of the message. May be 0 if there is no message</li>
|
|
<li>m_state: the state of the message as one of the MR_STATE_* identifiers. 0 if there is no message.</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="structmrmailbox__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>Giving the correct chat object here, this this will speed up things a little. If the chat object is not available by you, it is faster to pass NULL here.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The result must be freed using <a class="el" href="structmrpoortext__t.html#a89c28735bfd718051ffc6b742f9c10ed" title="Frees a poortext object. ">mrpoortext_unref()</a>. The function never returns NULL. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct 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>
|