QXmpp Version:0.3.91
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 > &)
void archiveChatReceived (const QXmppArchiveChat &)

Public Member Functions

void listCollections (const QString &jid, const QDateTime &start=QDateTime(), const QDateTime &end=QDateTime(), int max=0)
void removeCollections (const QString &jid, const QDateTime &start=QDateTime(), const QDateTime &end=QDateTime())
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.

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

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:
jidOptional JID if you only want conversations with a specific JID.
startOptional start time.
endOptional end time.
maxOptional maximum 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,
int  max = 0 
)

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.
maxOptional maximum number of messages to retrieve.

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