![]() |
LeechCraft Azoth
0.6.70-16373-g319c272718
Modular multiprotocol IM plugin for LeechCraft
|
Interface for plugins storing chat history. More...
#include "ihistoryplugin.h"
Public Types | |
using | MaxTimestampResult_t = Util::Either< QString, QDateTime > |
Public Member Functions | |
virtual | ~IHistoryPlugin () |
virtual bool | IsHistoryEnabledFor (QObject *entry) const =0 |
Whether history is enabled for the given entry. More... | |
virtual void | RequestLastMessages (QObject *entry, int num)=0 |
Requests last messages for the given entry. More... | |
virtual QFuture< MaxTimestampResult_t > | RequestMaxTimestamp (IAccount *acc)=0 |
virtual void | AddRawMessages (const QString &accountId, const QString &entryId, const QString &visibleName, const QList< HistoryItem > &items)=0 |
Adds a set of messages to the history. More... | |
Protected Member Functions | |
virtual void | gotLastMessages (QObject *entry, const QList< QObject *> &messages)=0 |
Notifies about last messages for the given entry. More... | |
Interface for plugins storing chat history.
This interface should be implemented by plugins that store chat history for Azoth to provide additional features using these plugins.
Definition at line 69 of file ihistoryplugin.h.
using LC::Azoth::IHistoryPlugin::MaxTimestampResult_t = Util::Either<QString, QDateTime> |
Definition at line 101 of file ihistoryplugin.h.
|
inlinevirtual |
Definition at line 72 of file ihistoryplugin.h.
|
pure virtual |
Adds a set of messages to the history.
[in] | accountId | The unique ID of the corresponding account. |
[in] | entryId | The unique ID of the corresponding entry. |
[in] | visibleName | The human-readable name of the entry. |
[in] | items | A list of HistoryItem structures describing the messages. |
|
protectedpure virtual |
Notifies about last messages for the given entry.
This signal should be emitted when last chat messages with the given entry have been retrieved from the history as the result of the call to RequestLastMessages().
If there are no messages for the entry, the implementation may either emit this signal with empty messages list or choose to not emit any signals at all.
|
pure virtual |
Whether history is enabled for the given entry.
This method checks if history logging is enabled for the given entry.
[in] | entry | The entry to check (implements ICLEntry). |
|
pure virtual |
Requests last messages for the given entry.
This method, when called, requests last num messages from the chat log with the entry.
This method is asynchronous: it is expected to return soon after being called, and the result is expected to be emitted via the gotLastMessages() signal.
[in] | entry | The entry for which to query the history (implements ICLEntry). |
[in] | num | The maximum number of messages to retrieve. |
|
pure virtual |