Git-Mirrors/RetroShare
1
0
Fork 0
mirror of https://github.com/RetroShare/RetroShare.git synced 2025-01-13 00:19:30 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #2438 from csoler/v0.6-rsHistory

Browse Source 
[WIP] Documenting rsHistory.h to bring history to JSON api
This commit is contained in:
csoler 2021-07-04 23:39:26 +02:00 committed by GitHub
commit 0c98b7f178
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 82 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
libretroshare/src/retroshare/rshistory.h
View File

@ -41,7 +41,7 @@ static const uint32_t RS_HISTORY_TYPE_PRIVATE = 1 ;
static const uint32_t RS_HISTORY_TYPE_LOBBY = 2 ;
static const uint32_t RS_HISTORY_TYPE_DISTANT = 3 ;
class HistoryMsg
class HistoryMsg: RsSerializable
{
public:
HistoryMsg()
@ -52,7 +52,18 @@ public:
recvTime = 0;
}
public:
virtual void serial_process(RsGenericSerializer::SerializeJob j, RsGenericSerializer::SerializeContext& ctx) override
{
RS_SERIAL_PROCESS(msgId);
RS_SERIAL_PROCESS(chatPeerId);
RS_SERIAL_PROCESS(incoming);
RS_SERIAL_PROCESS(peerId);
RS_SERIAL_PROCESS(peerName);
RS_SERIAL_PROCESS(sendTime);
RS_SERIAL_PROCESS(recvTime);
RS_SERIAL_PROCESS(message);
}
uint32_t msgId;
RsPeerId chatPeerId;
bool incoming;
@ -71,19 +82,79 @@ class RsHistory
{
public:
virtual bool chatIdToVirtualPeerId(const ChatId &chat_id, RsPeerId &peer_id) = 0;
virtual bool getMessages(const ChatId &chatPeerId, std::list<HistoryMsg> &msgs, uint32_t loadCount) = 0;
/*!
* @brief Retrieves the history of messages for a given chatId
* @jsonapi{development}
* @param[in] chatPeerId Chat Id for which the history needs to be retrieved
* @param[out] msgs retrieved messages
* @param[in] loadCount maximum number of messages to get
* @return true if messages can be retrieved, false otherwise.
*/
virtual bool getMessages(const ChatId& chatPeerId, std::list<HistoryMsg> &msgs, uint32_t loadCount) = 0;
/*!
* @brief Retrieves a specific message from the history
* @jsonapi{development}
* @param[in] msgId Id of the message to get
* @param[out] msg retrieved message
* @return true if message can be retrieved, false otherwise.
*/
virtual bool getMessage(uint32_t msgId, HistoryMsg &msg) = 0;
virtual void removeMessages(const std::list<uint32_t> &msgIds) = 0;
/*!
* @brief Remove messages from the history
* @jsonapi{development}
* @param[in] msgIds list of messages to remove
*/
virtual void removeMessages(const std::list<uint32_t>& msgIds) = 0;
/*!
* @brief clears the message history for a given chat peer
* @jsonapi{development}
* @param[in] chatPeerID Id of the chat/peer for which the history needs to be wiped
*/
virtual void clear(const ChatId &chatPeerId) = 0;
/*!
* @brief Get whether chat history is enabled or not
* @jsonapi{development}
* @param[in] chat_type Type of chat (see list of constants above)
* @return true when the information is available
*/
virtual bool getEnable(uint32_t chat_type) = 0;
/*!
* @brief Set whether chat history is enabled or not
* @jsonapi{development}
* @param[in] chat_type Type of chat (see list of constants above)
* @param[in] enabled Desired state of the variable
*/
virtual void setEnable(uint32_t chat_type, bool enable) = 0;
/*!
* @brief Retrieves the maximum storage time period for messages in history
* @return max storage duration of chat.
*/
virtual uint32_t getMaxStorageDuration() = 0;
/*!
* @brief Sets the maximum storage time period for messages in history
* @param[in] seconds max storage duration time in seconds
*/
virtual void setMaxStorageDuration(uint32_t seconds) = 0;
// 0 = no limit, >0 count of saved messages
/*!
* @brief Gets the maximum number of messages to save
* @param[in] chat_type Type of chat for that number limit
* @return maximum number of messages to save
*/
virtual uint32_t getSaveCount(uint32_t chat_type) = 0;
/*!
* @brief Sets the maximum number of messages to save
* @param[in] chat_type Type of chat for that number limit
* @param[in] count Max umber of messages, 0 meaning indefinitly
*/
virtual void setSaveCount(uint32_t chat_type, uint32_t count) = 0;
};