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.
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::archiveListReceived |
( |
const QList< QXmppArchiveChat > & |
| ) |
|
|
signal |
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 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:
-
jid | The JID of the collection |
start | Optional start time. |
end | Optional 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:
-
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: