diff options
| author | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
|---|---|---|
| committer | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
| commit | 93adc6aec9ba4671884d9692308b239d3064e553 (patch) | |
| tree | a5906e560045c841577473a9118ef06a39950a73 /doc/html/classQXmppArchiveManager.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppArchiveManager.html')
| -rw-r--r-- | doc/html/classQXmppArchiveManager.html | 224 |
1 files changed, 224 insertions, 0 deletions
diff --git a/doc/html/classQXmppArchiveManager.html b/doc/html/classQXmppArchiveManager.html new file mode 100644 index 00000000..3cc32559 --- /dev/null +++ b/doc/html/classQXmppArchiveManager.html @@ -0,0 +1,224 @@ +<!-- This comment will put IE 6, 7 and 8 in quirks mode --> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<title>QXmpp: QXmppArchiveManager Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javaScript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css"/> +</head> +<body onload='searchBox.OnSelectItem(0);'> +<!-- Generated by Doxygen 1.6.1 --> +<script type="text/javascript"><!-- +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +--></script> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <img id="MSearchSelect" src="search/search.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </div> + </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> +<div class="contents"> +<h1>QXmppArchiveManager Class Reference<br/> +<small> +[<a class="el" href="group__Managers.html">Managers</a>]</small> +</h1><!-- doxytag: class="QXmppArchiveManager" --> +<p>The <a class="el" href="classQXmppArchiveManager.html" title="The QXmppArchiveManager class makes it possible to access message archives as defined...">QXmppArchiveManager</a> class makes it possible to access message archives as defined by XEP-0136: Message Archiving. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="QXmppArchiveManager_8h_source.html">QXmppArchiveManager.h</a>></code></p> + +<p><a href="classQXmppArchiveManager-members.html">List of all members.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Signals</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppArchiveManager.html#a2c0b11bdb39bbf9eadbde3a7542cc99e">archiveListReceived</a> (const QList< QXmppArchiveChat > &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppArchiveManager.html#a8e4b194bb348c6c9a5348e4ce4ad8249">archiveChatReceived</a> (const QXmppArchiveChat &)</td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a8052187972105577973924e4274309"></a><!-- doxytag: member="QXmppArchiveManager::QXmppArchiveManager" ref="a5a8052187972105577973924e4274309" args="(QXmppStream *stream, QObject *parent=0)" --> + </td><td class="memItemRight" valign="bottom"><b>QXmppArchiveManager</b> (QXmppStream *stream, QObject *parent=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppArchiveManager.html#a79c125c02aff4cfab229a30864ff2d9b">listCollections</a> (const QString &jid, const QDateTime &start=QDateTime(), const QDateTime &end=QDateTime(), int max=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppArchiveManager.html#a079d1795b51ab24e00a7b10a6a0bba15">retrieveCollection</a> (const QString &jid, const QDateTime &start, int max=0)</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>The <a class="el" href="classQXmppArchiveManager.html" title="The QXmppArchiveManager class makes it possible to access message archives as defined...">QXmppArchiveManager</a> class makes it possible to access message archives as defined by XEP-0136: Message Archiving. </p> +<dl class="note"><dt><b>Note:</b></dt><dd>Few servers support message archiving. Check if the server in use supports this XEP. </dd></dl> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a8e4b194bb348c6c9a5348e4ce4ad8249"></a><!-- doxytag: member="QXmppArchiveManager::archiveChatReceived" ref="a8e4b194bb348c6c9a5348e4ce4ad8249" args="(const QXmppArchiveChat &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppArchiveManager::archiveChatReceived </td> + <td>(</td> + <td class="paramtype">const QXmppArchiveChat & </td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted when archive chat is received after calling <a class="el" href="classQXmppArchiveManager.html#a079d1795b51ab24e00a7b10a6a0bba15">retrieveCollection()</a> </p> + +</div> +</div> +<a class="anchor" id="a2c0b11bdb39bbf9eadbde3a7542cc99e"></a><!-- doxytag: member="QXmppArchiveManager::archiveListReceived" ref="a2c0b11bdb39bbf9eadbde3a7542cc99e" args="(const QList< QXmppArchiveChat > &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppArchiveManager::archiveListReceived </td> + <td>(</td> + <td class="paramtype">const QList< QXmppArchiveChat > & </td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted when archive list is received after calling <a class="el" href="classQXmppArchiveManager.html#a79c125c02aff4cfab229a30864ff2d9b">listCollections()</a> </p> + +</div> +</div> +<a class="anchor" id="a79c125c02aff4cfab229a30864ff2d9b"></a><!-- doxytag: member="QXmppArchiveManager::listCollections" ref="a79c125c02aff4cfab229a30864ff2d9b" args="(const QString &jid, const QDateTime &start=QDateTime(), const QDateTime &end=QDateTime(), int max=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppArchiveManager::listCollections </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>jid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QDateTime & </td> + <td class="paramname"> <em>start</em> = <code>QDateTime()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QDateTime & </td> + <td class="paramname"> <em>end</em> = <code>QDateTime()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>max</em> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Retrieves the list of available collections. Once the results are received, the <a class="el" href="classQXmppArchiveManager.html#a2c0b11bdb39bbf9eadbde3a7542cc99e">archiveListReceived()</a> signal will be emitted.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>jid</em> </td><td>Optional JID if you only want conversations with a specific JID. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>start</em> </td><td>Optional start time. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>Optional end time. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>Optional maximum. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a079d1795b51ab24e00a7b10a6a0bba15"></a><!-- doxytag: member="QXmppArchiveManager::retrieveCollection" ref="a079d1795b51ab24e00a7b10a6a0bba15" args="(const QString &jid, const QDateTime &start, int max=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppArchiveManager::retrieveCollection </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>jid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QDateTime & </td> + <td class="paramname"> <em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>max</em> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Retrieves the specified collection. Once the results are received, the <a class="el" href="classQXmppArchiveManager.html#a8e4b194bb348c6c9a5348e4ce4ad8249">archiveChatReceived()</a> will be emitted.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>jid</em> </td><td>The JID of the collection </td></tr> + <tr><td valign="top"></td><td valign="top"><em>start</em> </td><td>The start time of the collection. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>Optional maximum number of messages to retrieve. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="QXmppArchiveManager_8h_source.html">QXmppArchiveManager.h</a></li> +<li>QXmppArchiveManager.cpp</li> +</ul> +</div> +<!--- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerator</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 22 00:44:23 2010 for QXmpp by +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> |