InboxApi.hpp

#ifndef _PRIVMXLIB_ENDPOINT_INBOX_INBOXAPI_HPP_
#define _PRIVMXLIB_ENDPOINT_INBOX_INBOXAPI_HPP_
 
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
#include "privmx/endpoint/core/Connection.hpp"
#include "privmx/endpoint/core/Types.hpp"
 
#include "privmx/endpoint/inbox/Types.hpp"
#include "privmx/endpoint/store/StoreApi.hpp"
#include "privmx/endpoint/thread/ThreadApi.hpp"
#include <privmx/endpoint/core/ExtendedPointer.hpp>
 
namespace privmx {
namespace endpoint {
namespace inbox {
 
class InboxApiImpl;

class InboxApi : public privmx::endpoint::core::ExtendedPointer<InboxApiImpl> {
public:
    static InboxApi create(core::Connection& connection, thread::ThreadApi& threadApi, store::StoreApi& storeApi);

    InboxApi();
    InboxApi(const InboxApi& obj);
    InboxApi& operator=(const InboxApi& obj);
    InboxApi(InboxApi&& obj);
    ~InboxApi();

    std::string createInbox(
        const std::string& contextId,
        const std::vector<core::UserWithPubKey>& users,
        const std::vector<core::UserWithPubKey>& managers,
        const core::Buffer& publicMeta,
        const core::Buffer& privateMeta,
        const std::optional<inbox::FilesConfig>& filesConfig,
        const std::optional<core::ContainerPolicyWithoutItem>& policies = std::nullopt
    );

    void updateInbox(
        const std::string& inboxId,
        const std::vector<core::UserWithPubKey>& users,
        const std::vector<core::UserWithPubKey>& managers,
        const core::Buffer& publicMeta,
        const core::Buffer& privateMeta,
        const std::optional<inbox::FilesConfig>& filesConfig,
        const int64_t version,
        const bool force,
        const bool forceGenerateNewKey,
        const std::optional<core::ContainerPolicyWithoutItem>& policies = std::nullopt
    );

    Inbox getInbox(const std::string& inboxId);

    core::PagingList<inbox::Inbox> listInboxes(const std::string& contextId, const core::PagingQuery& pagingQuery);

    inbox::InboxPublicView getInboxPublicView(const std::string& inboxId);

    void deleteInbox(const std::string& inboxId);

    int64_t /*inboxHandle*/ prepareEntry(
        const std::string& inboxId,
        const core::Buffer& data,
        const std::vector<int64_t>& inboxFileHandles = std::vector<int64_t>(),
        const std::optional<std::string>& userPrivKey = std::nullopt
    );

    void sendEntry(const int64_t inboxHandle);

    inbox::InboxEntry readEntry(const std::string& inboxEntryId);

    core::PagingList<inbox::InboxEntry> listEntries(const std::string& inboxId, const core::PagingQuery& pagingQuery);

    void deleteEntry(const std::string& inboxEntryId);

    int64_t /*inboxFileHandle*/ createFileHandle(
        const core::Buffer& publicMeta,
        const core::Buffer& privateMeta,
        const int64_t& fileSize
    );

    void writeToFile(const int64_t inboxHandle, const int64_t inboxFileHandle, const core::Buffer& dataChunk);

    int64_t openFile(const std::string& fileId);

    core::Buffer readFromFile(const int64_t fileHandle, const int64_t length);

    void seekInFile(const int64_t fileHandle, const int64_t position);

    std::string closeFile(const int64_t fileHandle);

    std::vector<std::string> subscribeFor(const std::vector<std::string>& subscriptionQueries);

    void unsubscribeFrom(const std::vector<std::string>& subscriptionIds);

    std::string buildSubscriptionQuery(
        EventType eventType,
        EventSelectorType selectorType,
        const std::string& selectorId
    );
 
private:
    InboxApi(const std::shared_ptr<InboxApiImpl>& impl);
};
 
} // namespace inbox
} // namespace endpoint
} // namespace privmx
 
#endif // _PRIVMXLIB_ENDPOINT_INBOX_INBOXAPI_HPP_