mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 10:19:16 +02:00
321 lines
16 KiB
HTML
321 lines
16 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: 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>
|