PrivMX Endpoint v2.7.0
Loading...
Searching...
No Matches
InboxApi.hpp
1#ifndef _PRIVMXLIB_ENDPOINT_INBOX_INBOXAPI_HPP_
2#define _PRIVMXLIB_ENDPOINT_INBOX_INBOXAPI_HPP_
3
4#include <memory>
5#include <optional>
6#include <string>
7#include <vector>
8
9#include "privmx/endpoint/core/Connection.hpp"
10#include "privmx/endpoint/core/Types.hpp"
11
12#include "privmx/endpoint/store/StoreApi.hpp"
13#include "privmx/endpoint/thread/ThreadApi.hpp"
14#include "privmx/endpoint/inbox/Types.hpp"
15#include <privmx/endpoint/core/ExtendedPointer.hpp>
16
17namespace privmx {
18namespace endpoint {
19namespace inbox {
20
21
22
23class InboxApiImpl;
24
29public:
39 static InboxApi create(core::Connection& connection, thread::ThreadApi& threadApi, store::StoreApi& storeApi);
40
45 InboxApi(const InboxApi& obj);
46 InboxApi& operator=(const InboxApi& obj);
47 InboxApi(InboxApi&& obj);
48 ~InboxApi();
49
63 std::string createInbox(const std::string& contextId, const std::vector<core::UserWithPubKey>& users,
64 const std::vector<core::UserWithPubKey>& managers, const core::Buffer& publicMeta, const core::Buffer& privateMeta,
65 const std::optional<inbox::FilesConfig>& filesConfig,
66 const std::optional<core::ContainerPolicyWithoutItem>& policies = std::nullopt);
67
68
84 void updateInbox(const std::string& inboxId, const std::vector<core::UserWithPubKey>& users,
85 const std::vector<core::UserWithPubKey>& managers,
86 const core::Buffer& publicMeta, const core::Buffer& privateMeta,
87 const std::optional<inbox::FilesConfig>& filesConfig, const int64_t version, const bool force,
88 const bool forceGenerateNewKey,
89 const std::optional<core::ContainerPolicyWithoutItem>& policies = std::nullopt);
90
97 Inbox getInbox(const std::string& inboxId);
98
106 core::PagingList<inbox::Inbox> listInboxes(const std::string& contextId, const core::PagingQuery& pagingQuery);
107
108
116 inbox::InboxPublicView getInboxPublicView(const std::string& inboxId);
117
123 void deleteInbox(const std::string& inboxId);
124
135 int64_t /*inboxHandle*/ prepareEntry(const std::string& inboxId, const core::Buffer& data,
136 const std::vector<int64_t>& inboxFileHandles = std::vector<int64_t>(),
137 const std::optional<std::string>& userPrivKey = std::nullopt);
138
145 void sendEntry(const int64_t inboxHandle);
146
153 inbox::InboxEntry readEntry(const std::string& inboxEntryId);
154
162 core::PagingList<inbox::InboxEntry> listEntries(const std::string& inboxId, const core::PagingQuery& pagingQuery);
163
169 void deleteEntry(const std::string& inboxEntryId);
170
180 int64_t /*inboxFileHandle*/ createFileHandle(const core::Buffer& publicMeta, const core::Buffer& privateMeta, const int64_t& fileSize);
181
191 void writeToFile(const int64_t inboxHandle, const int64_t inboxFileHandle,
192 const core::Buffer& dataChunk);
193
194
201 int64_t openFile(const std::string& fileId);
202
211 core::Buffer readFromFile(const int64_t fileHandle, const int64_t length);
212
219 void seekInFile(const int64_t fileHandle, const int64_t position);
220
227 std::string closeFile(const int64_t fileHandle);
228
235 std::vector<std::string> subscribeFor(const std::vector<std::string>& subscriptionQueries);
236
241 void unsubscribeFrom(const std::vector<std::string>& subscriptionIds);
242
249 std::string buildSubscriptionQuery(EventType eventType, EventSelectorType selectorType, const std::string& selectorId);
250
251private:
252 InboxApi(const std::shared_ptr<InboxApiImpl>& impl);
253};
254
255} // namespace inbox
256} // namespace endpoint
257} // namespace privmx
258
259#endif // _PRIVMXLIB_ENDPOINT_INBOX_INBOXAPI_HPP_
Definition Buffer.hpp:13
Definition Connection.hpp:22
Definition ExtendedPointer.hpp:16
int64_t 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)
std::string buildSubscriptionQuery(EventType eventType, EventSelectorType selectorType, const std::string &selectorId)
void unsubscribeFrom(const std::vector< std::string > &subscriptionIds)
static InboxApi create(core::Connection &connection, thread::ThreadApi &threadApi, store::StoreApi &storeApi)
core::Buffer readFromFile(const int64_t fileHandle, const int64_t length)
inbox::InboxEntry readEntry(const std::string &inboxEntryId)
std::string closeFile(const int64_t fileHandle)
void deleteEntry(const std::string &inboxEntryId)
void deleteInbox(const std::string &inboxId)
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)
std::vector< std::string > subscribeFor(const std::vector< std::string > &subscriptionQueries)
core::PagingList< inbox::InboxEntry > listEntries(const std::string &inboxId, const core::PagingQuery &pagingQuery)
void sendEntry(const int64_t inboxHandle)
int64_t createFileHandle(const core::Buffer &publicMeta, const core::Buffer &privateMeta, const int64_t &fileSize)
Inbox getInbox(const std::string &inboxId)
void writeToFile(const int64_t inboxHandle, const int64_t inboxFileHandle, const core::Buffer &dataChunk)
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::InboxPublicView getInboxPublicView(const std::string &inboxId)
int64_t openFile(const std::string &fileId)
void seekInFile(const int64_t fileHandle, const int64_t position)
core::PagingList< inbox::Inbox > listInboxes(const std::string &contextId, const core::PagingQuery &pagingQuery)
Definition StoreApi.hpp:23
Definition ThreadApi.hpp:23
Definition Types.hpp:16
Definition Types.hpp:140
Definition Types.hpp:60