Contents

QXmppArchiveManager Class

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

Header: #include <QXmppArchiveManager.h>
Inherits: QXmppClientExtension

Public 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)

Signals

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

Detailed Description

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

[signal] void QXmppArchiveManager::archiveChatReceived(const QXmppArchiveChat &, const QXmppResultSetReply &rsm = QXmppResultSetReply())

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

rsm.

[signal] void QXmppArchiveManager::archiveListReceived(const QList<QXmppArchiveChat> &, const QXmppResultSetReply &rsm = QXmppResultSetReply())

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

rsm.

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.

jid is the JID you want conversations with. start is an optional start time, end an optional end time. rsm is an optional Result Set Management query.

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

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

jid is the JID you want conversations with. start is the start time, end the end time. max is the maximum number of collections to list.

This is an overloaded function.

void QXmppArchiveManager::removeCollections(const QString &jid, const QDateTime &start = QDateTime(), const QDateTime &end = QDateTime())

Removes the specified collection(s).

jid is the JID of the collection. start is an optional start time, end an optional 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.

jid is the JID of the collection. start is the start time of the collection. rsm is an optional Result Set Management query.

void QXmppArchiveManager::retrieveCollection(const QString &jid, const QDateTime &start, int max)

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

jid is the JID of the collection. start is the start time of the collection. max is the maximum number of messages to retrieve.

This is an overloaded function.