QXmpp  Version:0.9.3
Signals | Public Member Functions
QXmppArchiveManager Class Reference

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

#include <QXmppArchiveManager.h>

Inheritance diagram for QXmppArchiveManager:
QXmppClientExtension QXmppLoggable

List of all members.

Signals

void archiveListReceived (const QList< QXmppArchiveChat > &, const QXmppResultSetReply &rsm=QXmppResultSetReply())
void archiveChatReceived (const QXmppArchiveChat &, const QXmppResultSetReply &rsm=QXmppResultSetReply())

Public Member Functions

void listCollections (const QString &jid, const QDateTime &start=QDateTime(), const QDateTime &end=QDateTime(), const QXmppResultSetQuery &rsm=QXmppResultSetQuery())
void listCollections (const QString &jid, const QDateTime &start, const QDateTime &end, int max)
void removeCollections (const QString &jid, const QDateTime &start=QDateTime(), const QDateTime &end=QDateTime())
void retrieveCollection (const QString &jid, const QDateTime &start, const QXmppResultSetQuery &rsm=QXmppResultSetQuery())
void retrieveCollection (const QString &jid, const QDateTime &start, int max)

Detailed Description

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

To make use of this manager, you need to instantiate it and load it into the QXmppClient instance as follows:

 QXmppArchiveManager *manager = new QXmppArchiveManager;
 client->addExtension(manager);
Note:
Few servers support message archiving. Check if the server in use supports this XEP.

Member Function Documentation

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

void QXmppArchiveManager::archiveListReceived ( const QList< QXmppArchiveChat > &  ,
const QXmppResultSetReply rsm = QXmppResultSetReply() 
) [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(),
const QXmppResultSetQuery rsm = QXmppResultSetQuery() 
)

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

Parameters:
jidJID you want conversations with.
startOptional start time.
endOptional end time.
rsmOptional Result Set Management query
void QXmppArchiveManager::listCollections ( const QString &  jid,
const QDateTime &  start,
const QDateTime &  end,
int  max 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Retrieves the list of available collections. Once the results are received, the archiveListReceived() signal will be emitted.

Parameters:
jidJID you want conversations with.
startStart time.
endEnd time.
maxMaximum number of collections to list.
void QXmppArchiveManager::removeCollections ( const QString &  jid,
const QDateTime &  start = QDateTime(),
const QDateTime &  end = QDateTime() 
)

Removes the specified collection(s).

Parameters:
jidThe JID of the collection
startOptional start time.
endOptional end time.
void QXmppArchiveManager::retrieveCollection ( const QString &  jid,
const QDateTime &  start,
const QXmppResultSetQuery rsm = QXmppResultSetQuery() 
)

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

Parameters:
jidThe JID of the collection
startThe start time of the collection.
rsmOptional Result Set Management query
void QXmppArchiveManager::retrieveCollection ( const QString &  jid,
const QDateTime &  start,
int  max 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Retrieves the specified collection. Once the results are received, the archiveChatReceived() will be emitted.

Parameters:
jidThe JID of the collection
startThe start time of the collection.
maxMaximum number of messages to retrieve.

The documentation for this class was generated from the following files:
 All Classes Functions Enumerations Enumerator Properties