<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Yate: ClientContact Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a>
</div>
</div>
<div class="contents">
<h1>ClientContact Class Reference</h1><!-- doxytag: class="TelEngine::ClientContact" --><!-- doxytag: inherits="TelEngine::RefObject" -->A client contact.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatecbase_8h-source.html">yatecbase.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for ClientContact:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1ClientContact.png" usemap="#ClientContact_map" border="0" alt=""></center>
<map name="ClientContact_map">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,87,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,87,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1ClientContact-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#0403640d0fb9a719a5cee146ac0910cc">ClientContact</a> (<a class="el" href="classTelEngine_1_1ClientAccount.html">ClientAccount</a> *owner, const char *id, const char *name=0, bool chat=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#609ad882c40e651ab7ace5e236828be8">ClientContact</a> (<a class="el" href="classTelEngine_1_1ClientAccount.html">ClientAccount</a> *owner, <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &params, bool chat)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ClientAccount.html">ClientAccount</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#0febbc23245956f27520864c135e583b">account</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1URI.html">URI</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#ae1f9ac7c016cf12c35e0e8f1cd034f3">uri</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#7be149f79e0d20f72af4ea9e44aa534c">resources</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#c327d2558d09464fa99a183ac78170a1">groups</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#4a7bd56fb99593ace9379ed699f2719c">toString</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#6da8756b6e3a1c7b031f9146c9b5b5c1">buildContactId</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &dest)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#9ff81d46a1dabc46e4290e62c613d5ed">isChatWnd</a> (<a class="el" href="classTelEngine_1_1Window.html">Window</a> *wnd)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#7e3c5d4be16e13981484a3fe5ba7e4e4">hasChat</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#acad140f7ff582c5b0144c20e408433f">isChatVisible</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#17fb951bb8e45f976017236ee96865fa">showChat</a> (bool active)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#efcc90c4d5eda017fd980431dae39931">createChatWindow</a> (bool force=false, const char *name="chat")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#e190eae1a68555c9134086a4ed985a9f">destroyChatWindow</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1String.html">String</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#de19db16d4d43ce0e31a87c9fb9ffb37">findGroup</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &group)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#47fd3a8e0c64819c7896c69cf7a41109">appendGroup</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &group)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#5efcb34dc9a60eff4319743ce0bb56bf">removeGroup</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &group)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1ClientResource.html">ClientResource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#8e2c2f7cf8d6357edea3fb91b63eecf8">findResource</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &id, bool ref=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1ClientResource.html">ClientResource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#40099f48bbc76c68b62a13198269412d">findAudioResource</a> (bool ref=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1ClientResource.html">ClientResource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#df3670127cd0a775a3b13a5fb76906cb">appendResource</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#38d597a42a0057b106a17efd109c66e7">removeResource</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &id)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#82f28fbb8f5e5ea35d802bf09c79823b">isChatWndPrefix</a> (<a class="el" href="classTelEngine_1_1Window.html">Window</a> *wnd)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#6119cfa6cb30d7e7cfe276c86ab90f5d">buildContactId</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &dest, const <a class="el" href="classTelEngine_1_1String.html">String</a> &account, const <a class="el" href="classTelEngine_1_1String.html">String</a> &contact)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#37af32ddd9699dbb91a3b789e1d50810">splitContactId</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &src, <a class="el" href="classTelEngine_1_1String.html">String</a> &account, <a class="el" href="classTelEngine_1_1String.html">String</a> &contact)</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bcf1cd8e42c8d2c130ff1d20e3083fb8"></a><!-- doxytag: member="TelEngine::ClientContact::m_name" ref="bcf1cd8e42c8d2c130ff1d20e3083fb8" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_name</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4e1ce03c625a7b8534adfe1ed147d2a0"></a><!-- doxytag: member="TelEngine::ClientContact::m_subscription" ref="4e1ce03c625a7b8534adfe1ed147d2a0" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_subscription</b></td></tr>
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7ff91386b30e345de05530547d2154ae"></a><!-- doxytag: member="TelEngine::ClientContact::s_chatPrefix" ref="7ff91386b30e345de05530547d2154ae" args="" -->
static <a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>s_chatPrefix</b></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ClientContact.html#29e169c1327513d2db6127ddb301dc19">destroyed</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="115d57366dc92b55813306150ecace07"></a><!-- doxytag: member="TelEngine::ClientContact::m_owner" ref="115d57366dc92b55813306150ecace07" args="" -->
<a class="el" href="classTelEngine_1_1ClientAccount.html">ClientAccount</a> * </td><td class="memItemRight" valign="bottom"><b>m_owner</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3769ef194d9094a1b4b4394e4190ac81"></a><!-- doxytag: member="TelEngine::ClientContact::m_id" ref="3769ef194d9094a1b4b4394e4190ac81" args="" -->
<a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><b>m_id</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="69c81746c9fc4a8b8957d9df67a2dae3"></a><!-- doxytag: member="TelEngine::ClientContact::m_uri" ref="69c81746c9fc4a8b8957d9df67a2dae3" args="" -->
<a class="el" href="classTelEngine_1_1URI.html">URI</a> </td><td class="memItemRight" valign="bottom"><b>m_uri</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="43a9a64ebe5ca0affc7d0a97d8369691"></a><!-- doxytag: member="TelEngine::ClientContact::m_resources" ref="43a9a64ebe5ca0affc7d0a97d8369691" args="" -->
<a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> </td><td class="memItemRight" valign="bottom"><b>m_resources</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ce698d72b2375095c970e96c93f3c4d7"></a><!-- doxytag: member="TelEngine::ClientContact::m_groups" ref="ce698d72b2375095c970e96c93f3c4d7" args="" -->
<a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> </td><td class="memItemRight" valign="bottom"><b>m_groups</b></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4be533349f3c78979c5404de2ef91e06"></a><!-- doxytag: member="TelEngine::ClientContact::ClientAccount" ref="4be533349f3c78979c5404de2ef91e06" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>ClientAccount</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A client contact.
<p>
A client contact The contact is using the owner's mutex to lock it's operations <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="0403640d0fb9a719a5cee146ac0910cc"></a><!-- doxytag: member="TelEngine::ClientContact::ClientContact" ref="0403640d0fb9a719a5cee146ac0910cc" args="(ClientAccount *owner, const char *id, const char *name=0, bool chat=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ClientAccount.html">ClientAccount</a> * </td>
<td class="paramname"> <em>owner</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>chat</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. Append itself to the owner's list <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>owner</em> </td><td>The contact's owner </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The contact's id </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Optional display name. Defaults to the id's value if 0 </td></tr>
<tr><td valign="top"></td><td valign="top"><em>chat</em> </td><td>True to create the chat window </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="609ad882c40e651ab7ace5e236828be8"></a><!-- doxytag: member="TelEngine::ClientContact::ClientContact" ref="609ad882c40e651ab7ace5e236828be8" args="(ClientAccount *owner, NamedList &params, bool chat)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ClientContact.html">ClientContact</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ClientAccount.html">ClientAccount</a> * </td>
<td class="paramname"> <em>owner</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> & </td>
<td class="paramname"> <em>params</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>chat</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. Build a contact from a list of parameters. . Append itself to the owner's list <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>owner</em> </td><td>The contact's owner </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>The list of parameters used to build this contact </td></tr>
<tr><td valign="top"></td><td valign="top"><em>chat</em> </td><td>True to create the chat window </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0febbc23245956f27520864c135e583b"></a><!-- doxytag: member="TelEngine::ClientContact::account" ref="0febbc23245956f27520864c135e583b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ClientAccount.html">ClientAccount</a>* account </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get this contact's account <dl class="return" compact><dt><b>Returns:</b></dt><dd>This contact's account </dd></dl>
</div>
</div><p>
<a class="anchor" name="47fd3a8e0c64819c7896c69cf7a41109"></a><!-- doxytag: member="TelEngine::ClientContact::appendGroup" ref="47fd3a8e0c64819c7896c69cf7a41109" args="(const String &group)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool appendGroup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>group</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Append a group to this contact <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>Group's name </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the group already exists </dd></dl>
</div>
</div><p>
<a class="anchor" name="df3670127cd0a775a3b13a5fb76906cb"></a><!-- doxytag: member="TelEngine::ClientContact::appendResource" ref="df3670127cd0a775a3b13a5fb76906cb" args="(const String &id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1ClientResource.html">ClientResource</a>* appendResource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Append a resource having a given id <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The id of the desired resource </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1ClientResource.html" title="A client contact's resource.">ClientResource</a> pointer or 0 if a resource with the given name already exists </dd></dl>
</div>
</div><p>
<a class="anchor" name="6119cfa6cb30d7e7cfe276c86ab90f5d"></a><!-- doxytag: member="TelEngine::ClientContact::buildContactId" ref="6119cfa6cb30d7e7cfe276c86ab90f5d" args="(String &dest, const String &account, const String &contact)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void buildContactId </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>account</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>contact</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Build a contact id to be used in UI <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>account</em> </td><td>Account owning the contact </td></tr>
<tr><td valign="top"></td><td valign="top"><em>contact</em> </td><td>The contact's id </td></tr>
</table>
</dl>
<p>References <a class="el" href="classTelEngine_1_1String.html#8fd5f3c864af3d60885cc09888dd18d3">String::toLower()</a>.</p>
</div>
</div><p>
<a class="anchor" name="6da8756b6e3a1c7b031f9146c9b5b5c1"></a><!-- doxytag: member="TelEngine::ClientContact::buildContactId" ref="6da8756b6e3a1c7b031f9146c9b5b5c1" args="(String &dest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void buildContactId </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>dest</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Build a contact id to be used in UI <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination string </td></tr>
</table>
</dl>
<p>References <a class="el" href="yatecbase_8h-source.html#l02320">ClientContact::buildContactId()</a>, <a class="el" href="classTelEngine_1_1String.html#45d69b02f1e1f30d7b0b5320725950be">String::empty()</a>, and <a class="el" href="classTelEngine_1_1String.html#4a7bd56fb99593ace9379ed699f2719c">String::toString()</a>.</p>
<p>Referenced by <a class="el" href="yatecbase_8h-source.html#l02320">ClientContact::buildContactId()</a>.</p>
</div>
</div><p>
<a class="anchor" name="efcc90c4d5eda017fd980431dae39931"></a><!-- doxytag: member="TelEngine::ClientContact::createChatWindow" ref="efcc90c4d5eda017fd980431dae39931" args="(bool force=false, const char *name="chat")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void createChatWindow </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>force</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> = <code>"chat"</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create the chat window <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>force</em> </td><td>True to destroy the current one if any </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The window's name </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e190eae1a68555c9134086a4ed985a9f"></a><!-- doxytag: member="TelEngine::ClientContact::destroyChatWindow" ref="e190eae1a68555c9134086a4ed985a9f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void destroyChatWindow </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close (desrtoy) the chat window
</div>
</div><p>
<a class="anchor" name="29e169c1327513d2db6127ddb301dc19"></a><!-- doxytag: member="TelEngine::ClientContact::destroyed" ref="29e169c1327513d2db6127ddb301dc19" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void destroyed </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Pre-destruction notification, called just before the object is deleted. Unlike in the destructor it is safe to call virtual methods here. Reimplementing this method allows to perform any object cleanups.
<p>Reimplemented from <a class="el" href="classTelEngine_1_1RefObject.html#29e169c1327513d2db6127ddb301dc19">RefObject</a>.</p>
</div>
</div><p>
<a class="anchor" name="40099f48bbc76c68b62a13198269412d"></a><!-- doxytag: member="TelEngine::ClientContact::findAudioResource" ref="40099f48bbc76c68b62a13198269412d" args="(bool ref=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1ClientResource.html">ClientResource</a>* findAudioResource </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>ref</em> = <code>false</code> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the first resource with audio capability <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ref</em> </td><td>True to obtain a referenced pointer </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1ClientResource.html" title="A client contact's resource.">ClientResource</a> pointer or 0 if not found </dd></dl>
</div>
</div><p>
<a class="anchor" name="de19db16d4d43ce0e31a87c9fb9ffb37"></a><!-- doxytag: member="TelEngine::ClientContact::findGroup" ref="de19db16d4d43ce0e31a87c9fb9ffb37" args="(const String &group)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1String.html">String</a>* findGroup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>group</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a group this contact might belong to <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>The name of the group to find </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> pointer or 0 if not found </dd></dl>
</div>
</div><p>
<a class="anchor" name="8e2c2f7cf8d6357edea3fb91b63eecf8"></a><!-- doxytag: member="TelEngine::ClientContact::findResource" ref="8e2c2f7cf8d6357edea3fb91b63eecf8" args="(const String &id, bool ref=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1ClientResource.html">ClientResource</a>* findResource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>ref</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a resource having a given id <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The id of the desired resource </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ref</em> </td><td>True to obtain a referenced pointer </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1ClientResource.html" title="A client contact's resource.">ClientResource</a> pointer or 0 if not found </dd></dl>
</div>
</div><p>
<a class="anchor" name="c327d2558d09464fa99a183ac78170a1"></a><!-- doxytag: member="TelEngine::ClientContact::groups" ref="c327d2558d09464fa99a183ac78170a1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a>& groups </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the group list of this contact <dl class="return" compact><dt><b>Returns:</b></dt><dd>The group list of this contact </dd></dl>
</div>
</div><p>
<a class="anchor" name="7e3c5d4be16e13981484a3fe5ba7e4e4"></a><!-- doxytag: member="TelEngine::ClientContact::hasChat" ref="7e3c5d4be16e13981484a3fe5ba7e4e4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hasChat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this contact has a chat window <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this contact has a chat window </dd></dl>
</div>
</div><p>
<a class="anchor" name="acad140f7ff582c5b0144c20e408433f"></a><!-- doxytag: member="TelEngine::ClientContact::isChatVisible" ref="acad140f7ff582c5b0144c20e408433f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isChatVisible </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this contact's chat window is visible <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this contact's chat window is visible </dd></dl>
</div>
</div><p>
<a class="anchor" name="9ff81d46a1dabc46e4290e62c613d5ed"></a><!-- doxytag: member="TelEngine::ClientContact::isChatWnd" ref="9ff81d46a1dabc46e4290e62c613d5ed" args="(Window *wnd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isChatWnd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Window.html">Window</a> * </td>
<td class="paramname"> <em>wnd</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if a window is this contact's chat <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>wnd</em> </td><td>The window to check </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the given window is this contact's chat </dd></dl>
<p>References <a class="el" href="classTelEngine_1_1Window.html#4a7bd56fb99593ace9379ed699f2719c">Window::toString()</a>.</p>
</div>
</div><p>
<a class="anchor" name="82f28fbb8f5e5ea35d802bf09c79823b"></a><!-- doxytag: member="TelEngine::ClientContact::isChatWndPrefix" ref="82f28fbb8f5e5ea35d802bf09c79823b" args="(Window *wnd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool isChatWndPrefix </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1Window.html">Window</a> * </td>
<td class="paramname"> <em>wnd</em> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if a window is a chat one <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>wnd</em> </td><td>The window to check </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the given window's name starts with the chat refix </dd></dl>
<p>References <a class="el" href="classTelEngine_1_1String.html#ae79f8663afb4c009a053ec942bfb254">String::startsWith()</a>, and <a class="el" href="classTelEngine_1_1Window.html#4a7bd56fb99593ace9379ed699f2719c">Window::toString()</a>.</p>
</div>
</div><p>
<a class="anchor" name="5efcb34dc9a60eff4319743ce0bb56bf"></a><!-- doxytag: member="TelEngine::ClientContact::removeGroup" ref="5efcb34dc9a60eff4319743ce0bb56bf" args="(const String &group)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool removeGroup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>group</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a contact's group <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>group</em> </td><td>Group's name </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the group was not found </dd></dl>
</div>
</div><p>
<a class="anchor" name="38d597a42a0057b106a17efd109c66e7"></a><!-- doxytag: member="TelEngine::ClientContact::removeResource" ref="38d597a42a0057b106a17efd109c66e7" args="(const String &id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool removeResource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a resource having a given id <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The id of the desired resource </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the resource was removed </dd></dl>
</div>
</div><p>
<a class="anchor" name="7be149f79e0d20f72af4ea9e44aa534c"></a><!-- doxytag: member="TelEngine::ClientContact::resources" ref="7be149f79e0d20f72af4ea9e44aa534c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a>& resources </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the resource list of this contact <dl class="return" compact><dt><b>Returns:</b></dt><dd>The resource list of this contact </dd></dl>
</div>
</div><p>
<a class="anchor" name="17fb951bb8e45f976017236ee96865fa"></a><!-- doxytag: member="TelEngine::ClientContact::showChat" ref="17fb951bb8e45f976017236ee96865fa" args="(bool active)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool showChat </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>active</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Show or hide this contact's chat window <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>The chat window's visibility flag </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success </dd></dl>
</div>
</div><p>
<a class="anchor" name="37af32ddd9699dbb91a3b789e1d50810"></a><!-- doxytag: member="TelEngine::ClientContact::splitContactId" ref="37af32ddd9699dbb91a3b789e1d50810" args="(const String &src, String &account, String &contact)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void splitContactId </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>account</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>contact</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Split a contact id <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>Source string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>account</em> </td><td>Account name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>contact</em> </td><td>Contact's name </td></tr>
</table>
</dl>
<p>References <a class="el" href="classTelEngine_1_1String.html#3ebb1d4a8a875366bf361b1e2cadacb3">String::find()</a>, and <a class="el" href="classTelEngine_1_1String.html#5056e1432afe4b050ec8af00d2da3ff7">String::substr()</a>.</p>
</div>
</div><p>
<a class="anchor" name="4a7bd56fb99593ace9379ed699f2719c"></a><!-- doxytag: member="TelEngine::ClientContact::toString" ref="4a7bd56fb99593ace9379ed699f2719c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classTelEngine_1_1String.html">String</a>& toString </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a string representation of this object <dl class="return" compact><dt><b>Returns:</b></dt><dd>The contact's id </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1GenObject.html#4a7bd56fb99593ace9379ed699f2719c">GenObject</a>.</p>
</div>
</div><p>
<a class="anchor" name="ae1f9ac7c016cf12c35e0e8f1cd034f3"></a><!-- doxytag: member="TelEngine::ClientContact::uri" ref="ae1f9ac7c016cf12c35e0e8f1cd034f3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1URI.html">URI</a>& uri </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get this contact's <a class="el" href="classTelEngine_1_1URI.html" title="Encapsulation for an URI.">URI</a> <dl class="return" compact><dt><b>Returns:</b></dt><dd>This contact's <a class="el" href="classTelEngine_1_1URI.html" title="Encapsulation for an URI.">URI</a> </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatecbase_8h-source.html">yatecbase.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:12 2008 for Yate by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
64
