mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 18:29:19 +02:00
454 lines
24 KiB
HTML
454 lines
24 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: 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; in addition to this, for self talks also the flag MRP_SELFTALK is set.</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>
|