From 93adc6aec9ba4671884d9692308b239d3064e553 Mon Sep 17 00:00:00 2001 From: Manjeet Dahiya Date: Sat, 21 Aug 2010 19:15:30 +0000 Subject: add doc html --- doc/html/classQXmppArchiveManager.html | 224 +++++++++++++++++++++++++++++++++ 1 file changed, 224 insertions(+) create mode 100644 doc/html/classQXmppArchiveManager.html (limited to 'doc/html/classQXmppArchiveManager.html') 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 @@ + + + + + +QXmpp: QXmppArchiveManager Class Reference + + + + + + + + + +
+

QXmppArchiveManager Class Reference
+ +[Managers] +

+

The QXmppArchiveManager class makes it possible to access message archives as defined by XEP-0136: Message Archiving. +More...

+ +

#include <QXmppArchiveManager.h>

+ +

List of all members.

+ + + + + + + + +

Signals

void archiveListReceived (const QList< QXmppArchiveChat > &)
void archiveChatReceived (const QXmppArchiveChat &)

Public Member Functions

+ QXmppArchiveManager (QXmppStream *stream, QObject *parent=0)
void listCollections (const QString &jid, const QDateTime &start=QDateTime(), const QDateTime &end=QDateTime(), int max=0)
void retrieveCollection (const QString &jid, const QDateTime &start, int max=0)
+

Detailed Description

+

The QXmppArchiveManager class makes it possible to access message archives as defined by XEP-0136: Message Archiving.

+
Note:
Few servers support message archiving. Check if the server in use supports this XEP.
+

Member Function Documentation

+ +
+
+ + + + + + + + + +
void QXmppArchiveManager::archiveChatReceived (const QXmppArchiveChat &  )  [signal]
+
+
+

This signal is emitted when archive chat is received after calling retrieveCollection()

+ +
+
+ +
+
+ + + + + + + + + +
void QXmppArchiveManager::archiveListReceived (const QList< QXmppArchiveChat > &  )  [signal]
+
+
+

This signal is emitted when archive list is received after calling listCollections()

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void QXmppArchiveManager::listCollections (const QString &  jid,
const QDateTime &  start = QDateTime(),
const QDateTime &  end = QDateTime(),
int  max = 0 
)
+
+
+

Retrieves the list of available collections. Once the results are received, the archiveListReceived() signal will be emitted.

+
Parameters:
+ + + + + +
jid Optional JID if you only want conversations with a specific JID.
start Optional start time.
end Optional end time.
max Optional maximum.
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void QXmppArchiveManager::retrieveCollection (const QString &  jid,
const QDateTime &  start,
int  max = 0 
)
+
+
+

Retrieves the specified collection. Once the results are received, the archiveChatReceived() will be emitted.

+
Parameters:
+ + + + +
jid The JID of the collection
start The start time of the collection.
max Optional maximum number of messages to retrieve.
+
+
+ +
+
+
The documentation for this class was generated from the following files: +
+ +
+ All Classes Functions Enumerations Enumerator
+ + +
+ +
+ +
Generated on Sun Aug 22 00:44:23 2010 for QXmpp by  + +doxygen 1.6.1
+ + -- cgit v1.2.3