Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-release > by-pkgid > d4a6745d7fbd92dfb64dce5e91e08f80 > files > 109

lib64meanwhile1-doc-1.0.2-1mdv2008.1.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>meanwhile: mw_srvc_im.h File 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.4 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>mw_srvc_im.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
The IM service provides one-on-one communication between users. 
<p>
Messages sent over conversations may relay different types of information, in a variety of formats. The basic feature-set provides plain-text chat with typing notification. More complex features may be negotiated transparently by setting the IM Client Type for a conversation, or for the service as a whole. 
<p>
<code>#include &lt;glib.h&gt;</code><br>
<code>#include &quot;<a class="el" href="mw__common_8h-source.html">mw_common.h</a>&quot;</code><br>

<p>
<a href="mw__srvc__im_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmwImHandler.html">mwImHandler</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IM Service Handler.  <a href="structmwImHandler.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#cd26403ebeb75cde250ddb57b8cfc3fe">mwConversation_isClosed</a>(conv)&nbsp;&nbsp;&nbsp;mwConversation_isState((conv), mwConversation_CLOSED)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#18c14bbf9e6f0fd68ddec28310897a25">mwConversation_isOpen</a>(conv)&nbsp;&nbsp;&nbsp;mwConversation_isState((conv), mwConversation_OPEN)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#7ccb3181436b318174121c25b40742d0">mwConversation_isPending</a>(conv)&nbsp;&nbsp;&nbsp;mwConversation_isState((conv), mwConversation_PENDING)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#c9988b2be0d17a9eeb77451a87196cad">mwConversation_isState</a>(conv, <a class="el" href="structmwService.html#b5adc0f5a0cbeddaece7a4512ec66099">state</a>)&nbsp;&nbsp;&nbsp;(mwConversation_getState(conv) == (<a class="el" href="structmwService.html#b5adc0f5a0cbeddaece7a4512ec66099">state</a>))</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#fd6e82bbc1046ce9d52b842dba7722d2">mwService_IM</a>&nbsp;&nbsp;&nbsp;0x00001000</td></tr>

<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#cfdf4c12398d17d8e936a2a7fe371d06">mwConversationState</a> { <br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#cfdf4c12398d17d8e936a2a7fe371d06ba419e21933109ec87f690571cbad41d">mwConversation_CLOSED</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#cfdf4c12398d17d8e936a2a7fe371d06642450bf83850c99d021574f08eb2cca">mwConversation_PENDING</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#cfdf4c12398d17d8e936a2a7fe371d061f4a6c1f815e45963e201e115044e6f8">mwConversation_OPEN</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#cfdf4c12398d17d8e936a2a7fe371d060a9b2dc324406ff896170f45aac3b886">mwConversation_UNKNOWN</a>
<br>
 }</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__srvc__im_8h.html#8c32b70e52ab20bb2887f37962180b7d" title="get the state of a conversation">mwConversation_getState</a> </dd></dl>
 <a href="mw__srvc__im_8h.html#cfdf4c12398d17d8e936a2a7fe371d06">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#d127e58a93fa52166065266a6041fc17">mwImClientType</a> { <br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#d127e58a93fa52166065266a6041fc178a32a92f7402725dea621147b63c315b">mwImClient_PLAIN</a> =  0x00000001, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#d127e58a93fa52166065266a6041fc170b649d9e379256e9f11064cb4083eae7">mwImClient_NOTESBUDDY</a> =  0x00033453, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#d127e58a93fa52166065266a6041fc17c33797c61e096df2a75bb3c185387756">mwImClient_PRECONF</a> =  0x00000019, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#d127e58a93fa52166065266a6041fc173aaa9667089e6a9260d3e3f4dbbee70a">mwImClient_UNKNOWN</a> =  0xffffffff
<br>
 }</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a63">mwImSendType</a> { <br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a631dc9ac1e49b18739d6a9877b1b264f99">mwImSend_PLAIN</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a63967a6006d197bd292680562b4e86988a">mwImSend_TYPING</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a636cc56c9b2bdce2f1e4035e818d77d29f">mwImSend_HTML</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a63c1eabb5d6f9c551313634ab13bfc2abc">mwImSend_SUBJECT</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a63dfbd9dd7f630ca2202e98401c43c8115">mwImSend_MIME</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a630be05e58874a146e136e97fc32382d26">mwImSend_TIMESTAMP</a>
<br>
 }</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Types of supported messages.  <a href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a63">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#39757a34b81911a80ef817e6e45bc43a">mwConversation_close</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv, guint32 err)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">close a conversation.  <a href="#39757a34b81911a80ef817e6e45bc43a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#92aa89cc6cb34ebf4b4f232f532af961">mwConversation_free</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">close and destroy the conversation and its backing channel, and call the optional client data cleanup function  <a href="#92aa89cc6cb34ebf4b4f232f532af961"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gpointer&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#b38ac095354a0b0514eeeb7a8c55b121">mwConversation_getClientData</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reference associated client data.  <a href="#b38ac095354a0b0514eeeb7a8c55b121"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum <a class="el" href="mw__srvc__im_8h.html#d127e58a93fa52166065266a6041fc17">mwImClientType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#0267c3e82ea1c8c49652d6fb827895a0">mwConversation_getClientType</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#f359f37a1f33d3804efafe1f0865732b">mwConversation_getService</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl class="return" compact><dt><b>Returns:</b></dt><dd>owning service for a conversation </dd></dl>
 <a href="#f359f37a1f33d3804efafe1f0865732b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum <a class="el" href="mw__srvc__im_8h.html#cfdf4c12398d17d8e936a2a7fe371d06">mwConversationState</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#8c32b70e52ab20bb2887f37962180b7d">mwConversation_getState</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get the state of a conversation  <a href="#8c32b70e52ab20bb2887f37962180b7d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwIdBlock.html">mwIdBlock</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#b6ffb1c3f5e532eb6a17218fd15f3e2c">mwConversation_getTarget</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ID for conversation partner.  <a href="#b6ffb1c3f5e532eb6a17218fd15f3e2c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwLoginInfo.html">mwLoginInfo</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#9b2a0d0bb164a7de3d09e58fb0d0a0de">mwConversation_getTargetInfo</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">login information for conversation partner.  <a href="#9b2a0d0bb164a7de3d09e58fb0d0a0de"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gboolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#139fef3e5530529e593d164648d0d626">mwConversation_isEncrypted</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">determine whether outgoing messages are being encrypted  <a href="#139fef3e5530529e593d164648d0d626"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#2960bacb6c2f6307b60f8f92e1ac51f1">mwConversation_open</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">attempt to open a conversation.  <a href="#2960bacb6c2f6307b60f8f92e1ac51f1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#9e0c7574ae526c04c0c8433138dca068">mwConversation_removeClientData</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove any associated client data, calling the optional cleanup function if one was provided.  <a href="#9e0c7574ae526c04c0c8433138dca068"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#deb608f4473b09907bf096a8b4aee881">mwConversation_send</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv, enum <a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a63">mwImSendType</a> type, gconstpointer send)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">send a message over an open conversation  <a href="#deb608f4473b09907bf096a8b4aee881"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#f81229e742e279eb8f8104d6369e692c">mwConversation_setClientData</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv, gpointer data, GDestroyNotify clean)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Associates client data with a conversation.  <a href="#f81229e742e279eb8f8104d6369e692c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#1118f842f0373657f5ab8ada5a2a66c6">mwConversation_setEncrypted</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv, gboolean useCipher)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set whether outgoing messages should be encrypted using the negotiated cipher, if any  <a href="#1118f842f0373657f5ab8ada5a2a66c6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gboolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#beaf3935e8d6970920e4536fc97e1503">mwConversation_supports</a> (struct <a class="el" href="structmwConversation.html">mwConversation</a> *conv, enum <a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a63">mwImSendType</a> type)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">determine whether a conversation supports the given message type  <a href="#beaf3935e8d6970920e4536fc97e1503"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#9113d0a9a0dc47d4fb259d42f400bb98">mwServiceIm_findConversation</a> (struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *srvc, struct <a class="el" href="structmwIdBlock.html">mwIdBlock</a> *target)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">reference an existing conversation to target  <a href="#9113d0a9a0dc47d4fb259d42f400bb98"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum <a class="el" href="mw__srvc__im_8h.html#d127e58a93fa52166065266a6041fc17">mwImClientType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#a52f0d24ee0183085dd46e38e47261da">mwServiceIm_getClientType</a> (struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *srvc)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#4a2deb23c2063d564c43551f4d6fa7d7">mwServiceIm_getConversation</a> (struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *srvc, struct <a class="el" href="structmwIdBlock.html">mwIdBlock</a> *target)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">reference an existing conversation to target, or create a new conversation to target if one does not already exist  <a href="#4a2deb23c2063d564c43551f4d6fa7d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwImHandler.html">mwImHandler</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#afa4673b2fc2b5644a434ac563412ee7">mwServiceIm_getHandler</a> (struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *srvc)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#d0b319c6ffc1b62082dc6cd6533a64de">mwServiceIm_new</a> (struct <a class="el" href="structmwSession.html">mwSession</a> *<a class="el" href="structmwService.html#0c2badd2256155b2bee149fa4b57b7d6">session</a>, struct <a class="el" href="structmwImHandler.html">mwImHandler</a> *handler)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#bd6566ad7e1d2b5b3a64a8fe5b0ea27e">mwServiceIm_setClientType</a> (struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *srvc, enum <a class="el" href="mw__srvc__im_8h.html#d127e58a93fa52166065266a6041fc17">mwImClientType</a> type)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the default client type for the service.  <a href="#bd6566ad7e1d2b5b3a64a8fe5b0ea27e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gboolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__im_8h.html#f74d89d1656f69853b68cd2576783a3a">mwServiceIm_supports</a> (struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *srvc, enum <a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a63">mwImSendType</a> type)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">determine if the conversations created from this service will support a given send type  <a href="#f74d89d1656f69853b68cd2576783a3a"></a><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="cd26403ebeb75cde250ddb57b8cfc3fe"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_isClosed" ref="cd26403ebeb75cde250ddb57b8cfc3fe" args="(conv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define mwConversation_isClosed          </td>
          <td>(</td>
          <td class="paramtype">conv&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%">&nbsp;&nbsp;&nbsp;mwConversation_isState((conv), mwConversation_CLOSED)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="18c14bbf9e6f0fd68ddec28310897a25"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_isOpen" ref="18c14bbf9e6f0fd68ddec28310897a25" args="(conv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define mwConversation_isOpen          </td>
          <td>(</td>
          <td class="paramtype">conv&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%">&nbsp;&nbsp;&nbsp;mwConversation_isState((conv), mwConversation_OPEN)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="7ccb3181436b318174121c25b40742d0"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_isPending" ref="7ccb3181436b318174121c25b40742d0" args="(conv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define mwConversation_isPending          </td>
          <td>(</td>
          <td class="paramtype">conv&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%">&nbsp;&nbsp;&nbsp;mwConversation_isState((conv), mwConversation_PENDING)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="c9988b2be0d17a9eeb77451a87196cad"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_isState" ref="c9988b2be0d17a9eeb77451a87196cad" args="(conv, state)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define mwConversation_isState          </td>
          <td>(</td>
          <td class="paramtype">conv,         <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structmwService.html#b5adc0f5a0cbeddaece7a4512ec66099">state</a>&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%">&nbsp;&nbsp;&nbsp;(mwConversation_getState(conv) == (<a class="el" href="structmwService.html#b5adc0f5a0cbeddaece7a4512ec66099">state</a>))</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="fd6e82bbc1046ce9d52b842dba7722d2"></a><!-- doxytag: member="mw_srvc_im.h::mwService_IM" ref="fd6e82bbc1046ce9d52b842dba7722d2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define mwService_IM&nbsp;&nbsp;&nbsp;0x00001000          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="cfdf4c12398d17d8e936a2a7fe371d06"></a><!-- doxytag: member="mw_srvc_im.h::mwConversationState" ref="cfdf4c12398d17d8e936a2a7fe371d06" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="mw__srvc__im_8h.html#cfdf4c12398d17d8e936a2a7fe371d06">mwConversationState</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__srvc__im_8h.html#8c32b70e52ab20bb2887f37962180b7d" title="get the state of a conversation">mwConversation_getState</a> </dd></dl>

<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="cfdf4c12398d17d8e936a2a7fe371d06ba419e21933109ec87f690571cbad41d"></a><!-- doxytag: member="mwConversation_CLOSED" ref="cfdf4c12398d17d8e936a2a7fe371d06ba419e21933109ec87f690571cbad41d" args="" -->mwConversation_CLOSED</em>&nbsp;</td><td>
conversation is not open </td></tr>
<tr><td valign="top"><em><a class="anchor" name="cfdf4c12398d17d8e936a2a7fe371d06642450bf83850c99d021574f08eb2cca"></a><!-- doxytag: member="mwConversation_PENDING" ref="cfdf4c12398d17d8e936a2a7fe371d06642450bf83850c99d021574f08eb2cca" args="" -->mwConversation_PENDING</em>&nbsp;</td><td>
conversation is opening </td></tr>
<tr><td valign="top"><em><a class="anchor" name="cfdf4c12398d17d8e936a2a7fe371d061f4a6c1f815e45963e201e115044e6f8"></a><!-- doxytag: member="mwConversation_OPEN" ref="cfdf4c12398d17d8e936a2a7fe371d061f4a6c1f815e45963e201e115044e6f8" args="" -->mwConversation_OPEN</em>&nbsp;</td><td>
conversation is open </td></tr>
<tr><td valign="top"><em><a class="anchor" name="cfdf4c12398d17d8e936a2a7fe371d060a9b2dc324406ff896170f45aac3b886"></a><!-- doxytag: member="mwConversation_UNKNOWN" ref="cfdf4c12398d17d8e936a2a7fe371d060a9b2dc324406ff896170f45aac3b886" args="" -->mwConversation_UNKNOWN</em>&nbsp;</td><td>
unknown state </td></tr>
</table>
</dl>

</div>
</div><p>
<a class="anchor" name="d127e58a93fa52166065266a6041fc17"></a><!-- doxytag: member="mw_srvc_im.h::mwImClientType" ref="d127e58a93fa52166065266a6041fc17" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="mw__srvc__im_8h.html#d127e58a93fa52166065266a6041fc17">mwImClientType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="d127e58a93fa52166065266a6041fc178a32a92f7402725dea621147b63c315b"></a><!-- doxytag: member="mwImClient_PLAIN" ref="d127e58a93fa52166065266a6041fc178a32a92f7402725dea621147b63c315b" args="" -->mwImClient_PLAIN</em>&nbsp;</td><td>
text, typing </td></tr>
<tr><td valign="top"><em><a class="anchor" name="d127e58a93fa52166065266a6041fc170b649d9e379256e9f11064cb4083eae7"></a><!-- doxytag: member="mwImClient_NOTESBUDDY" ref="d127e58a93fa52166065266a6041fc170b649d9e379256e9f11064cb4083eae7" args="" -->mwImClient_NOTESBUDDY</em>&nbsp;</td><td>
adds html, subject, mime </td></tr>
<tr><td valign="top"><em><a class="anchor" name="d127e58a93fa52166065266a6041fc17c33797c61e096df2a75bb3c185387756"></a><!-- doxytag: member="mwImClient_PRECONF" ref="d127e58a93fa52166065266a6041fc17c33797c61e096df2a75bb3c185387756" args="" -->mwImClient_PRECONF</em>&nbsp;</td><td>
pre-conference, legacy </td></tr>
<tr><td valign="top"><em><a class="anchor" name="d127e58a93fa52166065266a6041fc173aaa9667089e6a9260d3e3f4dbbee70a"></a><!-- doxytag: member="mwImClient_UNKNOWN" ref="d127e58a93fa52166065266a6041fc173aaa9667089e6a9260d3e3f4dbbee70a" args="" -->mwImClient_UNKNOWN</em>&nbsp;</td><td>
trouble determining type </td></tr>
</table>
</dl>

</div>
</div><p>
<a class="anchor" name="cdce2eef1ff823bf823e533410061a63"></a><!-- doxytag: member="mw_srvc_im.h::mwImSendType" ref="cdce2eef1ff823bf823e533410061a63" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a63">mwImSendType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Types of supported messages. 
<p>
When a conversation is created, the least common denominator of features between either side of the conversation (based on what features are available in the IM service itself) becomes the set of supported features for that conversation. At any point, the feature set for the service may change, without affecting any existing conversations.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__srvc__im_8h.html#f74d89d1656f69853b68cd2576783a3a" title="determine if the conversations created from this service will support a given send...">mwServiceIm_supports</a> <p>
mwServiceIm_setSupported <p>
<a class="el" href="mw__srvc__im_8h.html#beaf3935e8d6970920e4536fc97e1503" title="determine whether a conversation supports the given message type">mwConversation_supports</a> <p>
<a class="el" href="mw__srvc__im_8h.html#deb608f4473b09907bf096a8b4aee881" title="send a message over an open conversation">mwConversation_send</a> <p>
mwServiceImHandler::conversation_recv </dd></dl>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="cdce2eef1ff823bf823e533410061a631dc9ac1e49b18739d6a9877b1b264f99"></a><!-- doxytag: member="mwImSend_PLAIN" ref="cdce2eef1ff823bf823e533410061a631dc9ac1e49b18739d6a9877b1b264f99" args="" -->mwImSend_PLAIN</em>&nbsp;</td><td>
char *, plain-text message </td></tr>
<tr><td valign="top"><em><a class="anchor" name="cdce2eef1ff823bf823e533410061a63967a6006d197bd292680562b4e86988a"></a><!-- doxytag: member="mwImSend_TYPING" ref="cdce2eef1ff823bf823e533410061a63967a6006d197bd292680562b4e86988a" args="" -->mwImSend_TYPING</em>&nbsp;</td><td>
gboolean, typing status </td></tr>
<tr><td valign="top"><em><a class="anchor" name="cdce2eef1ff823bf823e533410061a636cc56c9b2bdce2f1e4035e818d77d29f"></a><!-- doxytag: member="mwImSend_HTML" ref="cdce2eef1ff823bf823e533410061a636cc56c9b2bdce2f1e4035e818d77d29f" args="" -->mwImSend_HTML</em>&nbsp;</td><td>
char *, HTML formatted message (NOTESBUDDY) </td></tr>
<tr><td valign="top"><em><a class="anchor" name="cdce2eef1ff823bf823e533410061a63c1eabb5d6f9c551313634ab13bfc2abc"></a><!-- doxytag: member="mwImSend_SUBJECT" ref="cdce2eef1ff823bf823e533410061a63c1eabb5d6f9c551313634ab13bfc2abc" args="" -->mwImSend_SUBJECT</em>&nbsp;</td><td>
char *, conversation subject (NOTESBUDDY) </td></tr>
<tr><td valign="top"><em><a class="anchor" name="cdce2eef1ff823bf823e533410061a63dfbd9dd7f630ca2202e98401c43c8115"></a><!-- doxytag: member="mwImSend_MIME" ref="cdce2eef1ff823bf823e533410061a63dfbd9dd7f630ca2202e98401c43c8115" args="" -->mwImSend_MIME</em>&nbsp;</td><td>
char *, MIME-encoded message (NOTESBUDDY) </td></tr>
<tr><td valign="top"><em><a class="anchor" name="cdce2eef1ff823bf823e533410061a630be05e58874a146e136e97fc32382d26"></a><!-- doxytag: member="mwImSend_TIMESTAMP" ref="cdce2eef1ff823bf823e533410061a630be05e58874a146e136e97fc32382d26" args="" -->mwImSend_TIMESTAMP</em>&nbsp;</td><td>
char *, YYYY:MM:DD:HH:mm:SS format (NOTESBUDDY) </td></tr>
</table>
</dl>

</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="39757a34b81911a80ef817e6e45bc43a"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_close" ref="39757a34b81911a80ef817e6e45bc43a" args="(struct mwConversation *conv, guint32 err)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mwConversation_close           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">guint32&nbsp;</td>
          <td class="paramname"> <em>err</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
close a conversation. 
<p>
If the conversation was not already closed, mwServiceImHandler::conversation_closed will be triggered 
</div>
</div><p>
<a class="anchor" name="92aa89cc6cb34ebf4b4f232f532af961"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_free" ref="92aa89cc6cb34ebf4b4f232f532af961" args="(struct mwConversation *conv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mwConversation_free           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
close and destroy the conversation and its backing channel, and call the optional client data cleanup function 
<p>

</div>
</div><p>
<a class="anchor" name="b38ac095354a0b0514eeeb7a8c55b121"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_getClientData" ref="b38ac095354a0b0514eeeb7a8c55b121" args="(struct mwConversation *conv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gpointer mwConversation_getClientData           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Reference associated client data. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__srvc__im_8h.html#f81229e742e279eb8f8104d6369e692c" title="Associates client data with a conversation.">mwConversation_setClientData</a> <p>
<a class="el" href="mw__srvc__im_8h.html#9e0c7574ae526c04c0c8433138dca068" title="Remove any associated client data, calling the optional cleanup function if one was...">mwConversation_removeClientData</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="0267c3e82ea1c8c49652d6fb827895a0"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_getClientType" ref="0267c3e82ea1c8c49652d6fb827895a0" args="(struct mwConversation *conv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="mw__srvc__im_8h.html#d127e58a93fa52166065266a6041fc17">mwImClientType</a> mwConversation_getClientType           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="f359f37a1f33d3804efafe1f0865732b"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_getService" ref="f359f37a1f33d3804efafe1f0865732b" args="(struct mwConversation *conv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a>* mwConversation_getService           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>owning service for a conversation </dd></dl>

<p>

</div>
</div><p>
<a class="anchor" name="8c32b70e52ab20bb2887f37962180b7d"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_getState" ref="8c32b70e52ab20bb2887f37962180b7d" args="(struct mwConversation *conv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="mw__srvc__im_8h.html#cfdf4c12398d17d8e936a2a7fe371d06">mwConversationState</a> mwConversation_getState           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
get the state of a conversation 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__srvc__im_8h.html#18c14bbf9e6f0fd68ddec28310897a25">mwConversation_isOpen</a> <p>
<a class="el" href="mw__srvc__im_8h.html#cd26403ebeb75cde250ddb57b8cfc3fe">mwConversation_isClosed</a> <p>
<a class="el" href="mw__srvc__im_8h.html#7ccb3181436b318174121c25b40742d0">mwConversation_isPending</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="b6ffb1c3f5e532eb6a17218fd15f3e2c"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_getTarget" ref="b6ffb1c3f5e532eb6a17218fd15f3e2c" args="(struct mwConversation *conv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structmwIdBlock.html">mwIdBlock</a>* mwConversation_getTarget           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
ID for conversation partner. 
<p>

</div>
</div><p>
<a class="anchor" name="9b2a0d0bb164a7de3d09e58fb0d0a0de"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_getTargetInfo" ref="9b2a0d0bb164a7de3d09e58fb0d0a0de" args="(struct mwConversation *conv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structmwLoginInfo.html">mwLoginInfo</a>* mwConversation_getTargetInfo           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
login information for conversation partner. 
<p>
returns NULL if conversation is not OPEN 
</div>
</div><p>
<a class="anchor" name="139fef3e5530529e593d164648d0d626"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_isEncrypted" ref="139fef3e5530529e593d164648d0d626" args="(struct mwConversation *conv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gboolean mwConversation_isEncrypted           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
determine whether outgoing messages are being encrypted 
<p>

</div>
</div><p>
<a class="anchor" name="2960bacb6c2f6307b60f8f92e1ac51f1"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_open" ref="2960bacb6c2f6307b60f8f92e1ac51f1" args="(struct mwConversation *conv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mwConversation_open           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
attempt to open a conversation. 
<p>
If the conversation was not already open and it is accepted, mwServiceImHandler::conversation_opened will be triggered. Upon failure, mwServiceImHandler::conversation_closed will be triggered 
</div>
</div><p>
<a class="anchor" name="9e0c7574ae526c04c0c8433138dca068"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_removeClientData" ref="9e0c7574ae526c04c0c8433138dca068" args="(struct mwConversation *conv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mwConversation_removeClientData           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Remove any associated client data, calling the optional cleanup function if one was provided. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__srvc__im_8h.html#f81229e742e279eb8f8104d6369e692c" title="Associates client data with a conversation.">mwConversation_setClientData</a> <p>
<a class="el" href="mw__srvc__im_8h.html#b38ac095354a0b0514eeeb7a8c55b121" title="Reference associated client data.">mwConversation_getClientData</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="deb608f4473b09907bf096a8b4aee881"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_send" ref="deb608f4473b09907bf096a8b4aee881" args="(struct mwConversation *conv, enum mwImSendType type, gconstpointer send)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int mwConversation_send           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a63">mwImSendType</a>&nbsp;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">gconstpointer&nbsp;</td>
          <td class="paramname"> <em>send</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
send a message over an open conversation 
<p>

</div>
</div><p>
<a class="anchor" name="f81229e742e279eb8f8104d6369e692c"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_setClientData" ref="f81229e742e279eb8f8104d6369e692c" args="(struct mwConversation *conv, gpointer data, GDestroyNotify clean)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mwConversation_setClientData           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">gpointer&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">GDestroyNotify&nbsp;</td>
          <td class="paramname"> <em>clean</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Associates client data with a conversation. 
<p>
If there is existing data, it will not have its cleanup function called.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mw__srvc__im_8h.html#b38ac095354a0b0514eeeb7a8c55b121" title="Reference associated client data.">mwConversation_getClientData</a> <p>
<a class="el" href="mw__srvc__im_8h.html#9e0c7574ae526c04c0c8433138dca068" title="Remove any associated client data, calling the optional cleanup function if one was...">mwConversation_removeClientData</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="1118f842f0373657f5ab8ada5a2a66c6"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_setEncrypted" ref="1118f842f0373657f5ab8ada5a2a66c6" args="(struct mwConversation *conv, gboolean useCipher)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mwConversation_setEncrypted           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">gboolean&nbsp;</td>
          <td class="paramname"> <em>useCipher</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
set whether outgoing messages should be encrypted using the negotiated cipher, if any 
<p>

</div>
</div><p>
<a class="anchor" name="beaf3935e8d6970920e4536fc97e1503"></a><!-- doxytag: member="mw_srvc_im.h::mwConversation_supports" ref="beaf3935e8d6970920e4536fc97e1503" args="(struct mwConversation *conv, enum mwImSendType type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gboolean mwConversation_supports           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConversation.html">mwConversation</a> *&nbsp;</td>
          <td class="paramname"> <em>conv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a63">mwImSendType</a>&nbsp;</td>
          <td class="paramname"> <em>type</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
determine whether a conversation supports the given message type 
<p>

</div>
</div><p>
<a class="anchor" name="9113d0a9a0dc47d4fb259d42f400bb98"></a><!-- doxytag: member="mw_srvc_im.h::mwServiceIm_findConversation" ref="9113d0a9a0dc47d4fb259d42f400bb98" args="(struct mwServiceIm *srvc, struct mwIdBlock *target)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structmwConversation.html">mwConversation</a>* mwServiceIm_findConversation           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *&nbsp;</td>
          <td class="paramname"> <em>srvc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structmwIdBlock.html">mwIdBlock</a> *&nbsp;</td>
          <td class="paramname"> <em>target</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
reference an existing conversation to target 
<p>

</div>
</div><p>
<a class="anchor" name="a52f0d24ee0183085dd46e38e47261da"></a><!-- doxytag: member="mw_srvc_im.h::mwServiceIm_getClientType" ref="a52f0d24ee0183085dd46e38e47261da" args="(struct mwServiceIm *srvc)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="mw__srvc__im_8h.html#d127e58a93fa52166065266a6041fc17">mwImClientType</a> mwServiceIm_getClientType           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *&nbsp;</td>
          <td class="paramname"> <em>srvc</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="4a2deb23c2063d564c43551f4d6fa7d7"></a><!-- doxytag: member="mw_srvc_im.h::mwServiceIm_getConversation" ref="4a2deb23c2063d564c43551f4d6fa7d7" args="(struct mwServiceIm *srvc, struct mwIdBlock *target)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structmwConversation.html">mwConversation</a>* mwServiceIm_getConversation           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *&nbsp;</td>
          <td class="paramname"> <em>srvc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structmwIdBlock.html">mwIdBlock</a> *&nbsp;</td>
          <td class="paramname"> <em>target</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
reference an existing conversation to target, or create a new conversation to target if one does not already exist 
<p>

</div>
</div><p>
<a class="anchor" name="afa4673b2fc2b5644a434ac563412ee7"></a><!-- doxytag: member="mw_srvc_im.h::mwServiceIm_getHandler" ref="afa4673b2fc2b5644a434ac563412ee7" args="(struct mwServiceIm *srvc)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structmwImHandler.html">mwImHandler</a>* mwServiceIm_getHandler           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *&nbsp;</td>
          <td class="paramname"> <em>srvc</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="d0b319c6ffc1b62082dc6cd6533a64de"></a><!-- doxytag: member="mw_srvc_im.h::mwServiceIm_new" ref="d0b319c6ffc1b62082dc6cd6533a64de" args="(struct mwSession *session, struct mwImHandler *handler)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a>* mwServiceIm_new           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwSession.html">mwSession</a> *&nbsp;</td>
          <td class="paramname"> <em>session</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structmwImHandler.html">mwImHandler</a> *&nbsp;</td>
          <td class="paramname"> <em>handler</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="bd6566ad7e1d2b5b3a64a8fe5b0ea27e"></a><!-- doxytag: member="mw_srvc_im.h::mwServiceIm_setClientType" ref="bd6566ad7e1d2b5b3a64a8fe5b0ea27e" args="(struct mwServiceIm *srvc, enum mwImClientType type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mwServiceIm_setClientType           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *&nbsp;</td>
          <td class="paramname"> <em>srvc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="mw__srvc__im_8h.html#d127e58a93fa52166065266a6041fc17">mwImClientType</a>&nbsp;</td>
          <td class="paramname"> <em>type</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the default client type for the service. 
<p>
Newly created conversations will attempt to meet this level of functionality first.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>srvc</em>&nbsp;</td><td>the IM service </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the send type to enable/disable </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="f74d89d1656f69853b68cd2576783a3a"></a><!-- doxytag: member="mw_srvc_im.h::mwServiceIm_supports" ref="f74d89d1656f69853b68cd2576783a3a" args="(struct mwServiceIm *srvc, enum mwImSendType type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gboolean mwServiceIm_supports           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwServiceIm.html">mwServiceIm</a> *&nbsp;</td>
          <td class="paramname"> <em>srvc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="mw__srvc__im_8h.html#cdce2eef1ff823bf823e533410061a63">mwImSendType</a>&nbsp;</td>
          <td class="paramname"> <em>type</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
determine if the conversations created from this service will support a given send type 
<p>

</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 19 09:10:34 2007 for meanwhile by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
</body>
</html>