The QXmppArchiveManager class makes it possible to access message archives as defined by XEP-0136: Message Archiving.
More...
#include <QXmppArchiveManager.h>
|
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) |
|
| QXmppClientExtension () |
|
virtual QStringList | discoveryFeatures () const |
|
virtual QList< QXmppDiscoveryIq::Identity > | discoveryIdentities () const |
|
virtual bool | handleStanza (const QDomElement &stanza) |
| You need to implement this method to process incoming XMPP stanzas.
|
|
virtual bool | handleStanza (const QDomElement &stanza, const std::optional< QXmppE2eeMetadata > &e2eeMetadata) |
| You need to implement this method to process incoming XMPP stanzas.
|
|
| QXmppLoggable (QObject *parent=nullptr) |
|
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:
The QXmppArchiveManager class makes it possible to access message archives as defined by XEP-0136: Me...
Definition QXmppArchiveManager.h:31
QXmppClient * client()
Definition QXmppClientExtension.cpp:78
bool addExtension(QXmppClientExtension *extension)
Definition QXmppClient.cpp:263
- Note
- Few servers support message archiving. Check if the server in use supports this XEP.
◆ archiveChatReceived
◆ archiveListReceived
◆ listCollections() [1/2]
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
-
jid | JID you want conversations with. |
start | Start time. |
end | End time. |
max | Maximum number of collections to list. |
◆ listCollections() [2/2]
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
-
jid | JID you want conversations with. |
start | Optional start time. |
end | Optional end time. |
rsm | Optional Result Set Management query |
◆ removeCollections()
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. |
◆ retrieveCollection() [1/2]
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. |
rsm | Optional Result Set Management query |
◆ retrieveCollection() [2/2]
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
-
jid | The JID of the collection |
start | The start time of the collection. |
max | Maximum number of messages to retrieve. |
The documentation for this class was generated from the following files: