mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 18:29:19 +02:00
250 lines
14 KiB
HTML
250 lines
14 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-Library: mrchat_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-Library
|
|
</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="structmrchat__t-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">mrchat_t Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>An object representing a single chat in memory.
|
|
<a href="structmrchat__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="structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9">mrchat_unref</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
|
<tr class="memdesc:a3b1befb4542c1bad915f2175c7c2a2b9"><td class="mdescLeft"> </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:af0d39be9ac9885810d8765053cfb81eb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#af0d39be9ac9885810d8765053cfb81eb">mrchat_empty</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *ths)</td></tr>
|
|
<tr class="memdesc:af0d39be9ac9885810d8765053cfb81eb"><td class="mdescLeft"> </td><td class="mdescRight">Empty a chat object. <a href="#af0d39be9ac9885810d8765053cfb81eb">More...</a><br /></td></tr>
|
|
<tr class="separator:af0d39be9ac9885810d8765053cfb81eb"><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="structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08">mrchat_get_subtitle</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
|
|
<tr class="memdesc:ae1e9920618c9f6cb8ad66d5bb6962a08"><td class="mdescLeft"> </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>
|
|
</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:a1591431716413350eaffce0b588e4911"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1591431716413350eaffce0b588e4911"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><b>m_id</b></td></tr>
|
|
<tr class="separator:a1591431716413350eaffce0b588e4911"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a568c4e6fb9633ffe9a76428db16e0201"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a568c4e6fb9633ffe9a76428db16e0201"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>m_type</b></td></tr>
|
|
<tr class="separator:a568c4e6fb9633ffe9a76428db16e0201"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abbd344d8d361a1a4d14bfc9b5dc57140"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abbd344d8d361a1a4d14bfc9b5dc57140"></a>
|
|
char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140">m_name</a></td></tr>
|
|
<tr class="memdesc:abbd344d8d361a1a4d14bfc9b5dc57140"><td class="mdescLeft"> </td><td class="mdescRight">NULL if unset. <br /></td></tr>
|
|
<tr class="separator:abbd344d8d361a1a4d14bfc9b5dc57140"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a565101f53278f5ab1ff58317ffc9555c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a565101f53278f5ab1ff58317ffc9555c"></a>
|
|
time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a565101f53278f5ab1ff58317ffc9555c">m_draft_timestamp</a></td></tr>
|
|
<tr class="memdesc:a565101f53278f5ab1ff58317ffc9555c"><td class="mdescLeft"> </td><td class="mdescRight">0 if there is no draft <br /></td></tr>
|
|
<tr class="separator:a565101f53278f5ab1ff58317ffc9555c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe916f48ac83c2ca6476312eae084cfa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe916f48ac83c2ca6476312eae084cfa"></a>
|
|
char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#abe916f48ac83c2ca6476312eae084cfa">m_draft_text</a></td></tr>
|
|
<tr class="memdesc:abe916f48ac83c2ca6476312eae084cfa"><td class="mdescLeft"> </td><td class="mdescRight">NULL if unset. <br /></td></tr>
|
|
<tr class="separator:abe916f48ac83c2ca6476312eae084cfa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf3e1a34f567e168bc0597f9a544a50d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf3e1a34f567e168bc0597f9a544a50d"></a>
|
|
<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#abf3e1a34f567e168bc0597f9a544a50d">m_mailbox</a></td></tr>
|
|
<tr class="memdesc:abf3e1a34f567e168bc0597f9a544a50d"><td class="mdescLeft"> </td><td class="mdescRight">!= NULL <br /></td></tr>
|
|
<tr class="separator:abf3e1a34f567e168bc0597f9a544a50d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b28b343ceb290d4a613d0e5a7d528bc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a5b28b343ceb290d4a613d0e5a7d528bc">m_archived</a></td></tr>
|
|
<tr class="memdesc:a5b28b343ceb290d4a613d0e5a7d528bc"><td class="mdescLeft"> </td><td class="mdescRight">1=chat archived, this state should always be shown the UI, eg. <a href="#a5b28b343ceb290d4a613d0e5a7d528bc">More...</a><br /></td></tr>
|
|
<tr class="separator:a5b28b343ceb290d4a613d0e5a7d528bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2792ee7df778521de61087bc79795a7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2792ee7df778521de61087bc79795a7"></a>
|
|
<a class="el" href="structmrparam__t.html">mrparam_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#ad2792ee7df778521de61087bc79795a7">m_param</a></td></tr>
|
|
<tr class="memdesc:ad2792ee7df778521de61087bc79795a7"><td class="mdescLeft"> </td><td class="mdescRight">!= NULL <br /></td></tr>
|
|
<tr class="separator:ad2792ee7df778521de61087bc79795a7"><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="structmrmailbox__t.html#ad106b9c23b3a559b524a37bb5504e096" title="Get a chat object of type mrchat_t 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="af0d39be9ac9885810d8765053cfb81eb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mrchat_empty </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrchat__t.html">mrchat_t</a> * </td>
|
|
<td class="paramname"><em>ths</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Empty a chat object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">chat</td><td>The chat object to empty.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae1e9920618c9f6cb8ad66d5bb6962a08"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char * mrchat_get_subtitle </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrchat__t.html">mrchat_t</a> * </td>
|
|
<td class="paramname"><em>chat</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get a subtitle for a chat. </p>
|
|
<p>The sibtitle is eg. the email-address or the number of group members.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">chat</td><td>The chat object to calulate the subtitle for.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Subtitle as a string. Must be free()'d after usage. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3b1befb4542c1bad915f2175c7c2a2b9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mrchat_unref </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrchat__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="structmrmailbox__t.html#ad106b9c23b3a559b524a37bb5504e096" title="Get a chat object of type mrchat_t by a chat_id. ">mrmailbox_get_chat()</a> or mrchat_new().</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="a5b28b343ceb290d4a613d0e5a7d528bc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int mrchat_t::m_archived</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>1=chat archived, this state should always be shown the UI, eg. </p>
|
|
<p>the search will also return archived chats </p>
|
|
|
|
</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="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 on Tue Nov 14 2017 11:55:36 for Delta Chat Core C-Library 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>
|