Skip to content

Commit fedfa60

Browse files
Regenerate Doxygen docs from f948069
1 parent 203d0cc commit fedfa60

11 files changed

Lines changed: 141 additions & 26 deletions

Messaging_8hpp_source.html

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -276,18 +276,35 @@
276276
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> <span class="keyword">const</span> std::vector&lt;std::string&gt; &amp;userId = {});</div>
277277
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span><span class="comment"></span> </div>
278278
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span><span class="comment"> /**</span></div>
279-
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span><span class="comment"> * @brief Delete a message by its ID.</span></div>
280-
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span><span class="comment"> * @param messageId ID of the message.</span></div>
281-
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span><span class="comment"> * @return JSON response.</span></div>
282-
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span><span class="comment"> */</span></div>
283-
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"><a class="line" href="classMessaging.html#a39c06798a06c32d23a58f0f9d619f630"> 182</a></span> std::string <a class="code hl_function" href="classMessaging.html#a39c06798a06c32d23a58f0f9d619f630">deleteMessages</a>(<span class="keyword">const</span> std::string &amp;messageId);</div>
284-
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> <span class="keyword">private</span>:</div>
285-
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> std::string projectId; <span class="comment">///&lt; Project ID</span></div>
286-
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> std::string apiKey; <span class="comment">///&lt; API Key</span></div>
287-
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span>};</div>
279+
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span><span class="comment"> * @brief List all message logs with optional filters.</span></div>
280+
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span><span class="comment"> * @param messageId ID of the message</span></div>
281+
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span><span class="comment"> * @param queries Query parameters for filtering</span></div>
282+
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span><span class="comment"> * @return JSON string of messageLog list</span></div>
283+
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span><span class="comment"> */</span></div>
284+
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"><a class="line" href="classMessaging.html#aab2cfcd2f79171a204ef1780beef1103"> 183</a></span> std::string <a class="code hl_function" href="classMessaging.html#aab2cfcd2f79171a204ef1780beef1103">listMessageLogs</a>(<span class="keyword">const</span> std::string &amp;messageId, <a class="code hl_class" href="classQueries.html">Queries</a> &amp;queries);</div>
285+
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> <span class="comment"></span></div>
286+
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span><span class="comment"> /**</span></div>
287+
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span><span class="comment"> * @brief Delete a message by its ID.</span></div>
288+
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span><span class="comment"> * @param messageId ID of the message.</span></div>
289+
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span><span class="comment"> * @return JSON response.</span></div>
290+
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span><span class="comment"> */</span></div>
291+
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"><a class="line" href="classMessaging.html#a39c06798a06c32d23a58f0f9d619f630"> 190</a></span> std::string <a class="code hl_function" href="classMessaging.html#a39c06798a06c32d23a58f0f9d619f630">deleteMessages</a>(<span class="keyword">const</span> std::string &amp;messageId);</div>
292+
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span><span class="comment"></span> </div>
293+
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span><span class="comment"> /**</span></div>
294+
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span><span class="comment"> * @brief List all targets for a given message.</span></div>
295+
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span><span class="comment"> * @param messageId ID of the message.</span></div>
296+
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span><span class="comment"> * @param queries Optional query filters.</span></div>
297+
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span><span class="comment"> * @return JSON response.</span></div>
298+
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span><span class="comment"> */</span></div>
299+
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"><a class="line" href="classMessaging.html#aed59aaab660e767275e118c3ffc23968"> 198</a></span> std::string <a class="code hl_function" href="classMessaging.html#aed59aaab660e767275e118c3ffc23968">listTargets</a>(<span class="keyword">const</span> std::string &amp;messageId, </div>
300+
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> <span class="keyword">const</span> std::vector&lt;std::string&gt; &amp;queries = {});</div>
301+
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> <span class="keyword">private</span>:</div>
302+
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span> std::string projectId; <span class="comment">///&lt; Project ID</span></div>
303+
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> std::string apiKey; <span class="comment">///&lt; API Key</span></div>
304+
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span>};</div>
288305
</div>
289-
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> </div>
290-
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span><span class="preprocessor">#endif</span></div>
306+
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> </div>
307+
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span><span class="preprocessor">#endif</span></div>
291308
<div class="ttc" id="aAppwriteException_8hpp_html"><div class="ttname"><a href="AppwriteException_8hpp.html">AppwriteException.hpp</a></div><div class="ttdoc">Declares the base exception class used to represent Appwrite SDK errors.</div></div>
292309
<div class="ttc" id="aHttpStatus_8hpp_html"><div class="ttname"><a href="HttpStatus_8hpp.html">HttpStatus.hpp</a></div><div class="ttdoc">Defines HTTP status code enums for consistent error and response handling.</div></div>
293310
<div class="ttc" id="aQuery_8hpp_html"><div class="ttname"><a href="Query_8hpp.html">Query.hpp</a></div><div class="ttdoc">Offers helper methods to construct query parameters for filtering and sorting API responses.</div></div>
@@ -302,11 +319,13 @@
302319
<div class="ttc" id="aclassMessaging_html_a47f9b222b054338040d95f559acb916b"><div class="ttname"><a href="classMessaging.html#a47f9b222b054338040d95f559acb916b">Messaging::createSubscribers</a></div><div class="ttdeci">std::string createSubscribers(const std::string &amp;topicId, const std::string &amp;name, const std::string &amp;targetId, const std::string &amp;subscriberId)</div><div class="ttdoc">Add a subscriber to a topic.</div></div>
303320
<div class="ttc" id="aclassMessaging_html_a6a097bd5ad8238b4c91e282fc2f57b68"><div class="ttname"><a href="classMessaging.html#a6a097bd5ad8238b4c91e282fc2f57b68">Messaging::listTopics</a></div><div class="ttdeci">std::string listTopics(Queries &amp;queries)</div><div class="ttdoc">List all topics with optional filters.</div></div>
304321
<div class="ttc" id="aclassMessaging_html_aa596d2b309995e8d3e7196a3037f24ff"><div class="ttname"><a href="classMessaging.html#aa596d2b309995e8d3e7196a3037f24ff">Messaging::getMessages</a></div><div class="ttdeci">std::string getMessages(const std::string &amp;messageId)</div><div class="ttdoc">Get a specific message by ID.</div></div>
322+
<div class="ttc" id="aclassMessaging_html_aab2cfcd2f79171a204ef1780beef1103"><div class="ttname"><a href="classMessaging.html#aab2cfcd2f79171a204ef1780beef1103">Messaging::listMessageLogs</a></div><div class="ttdeci">std::string listMessageLogs(const std::string &amp;messageId, Queries &amp;queries)</div><div class="ttdoc">List all message logs with optional filters.</div></div>
305323
<div class="ttc" id="aclassMessaging_html_ab8e8cb4df3f5c106da6bab81e7eb67f2"><div class="ttname"><a href="classMessaging.html#ab8e8cb4df3f5c106da6bab81e7eb67f2">Messaging::createPush</a></div><div class="ttdeci">std::string createPush(const std::string &amp;messageId, const std::string &amp;title, const std::string &amp;body, const std::vector&lt; std::string &gt; &amp;topicId={}, const std::vector&lt; std::string &gt; &amp;userId={}, bool draft=false)</div><div class="ttdoc">Creates a new push notification message.</div></div>
306324
<div class="ttc" id="aclassMessaging_html_ac4206d4f3710b00f0b914f2c8cdf23a5"><div class="ttname"><a href="classMessaging.html#ac4206d4f3710b00f0b914f2c8cdf23a5">Messaging::getTopic</a></div><div class="ttdeci">std::string getTopic(const std::string &amp;topicId)</div><div class="ttdoc">Get details of a topic by ID.</div></div>
307325
<div class="ttc" id="aclassMessaging_html_ad6775b6b42ba1f5892b46643a548aa85"><div class="ttname"><a href="classMessaging.html#ad6775b6b42ba1f5892b46643a548aa85">Messaging::Messaging</a></div><div class="ttdeci">Messaging(const std::string &amp;projectId, const std::string &amp;apiKey)</div><div class="ttdoc">Constructor for Messaging service.</div></div>
308326
<div class="ttc" id="aclassMessaging_html_adcce04cbe30abcb19f17b9b7390247b5"><div class="ttname"><a href="classMessaging.html#adcce04cbe30abcb19f17b9b7390247b5">Messaging::getSubscriber</a></div><div class="ttdeci">std::string getSubscriber(const std::string &amp;topicId, const std::string &amp;subscriberId)</div><div class="ttdoc">Get details of a subscriber to a topic.</div></div>
309327
<div class="ttc" id="aclassMessaging_html_adf1111aaf72b9d0d4dfc4b08dd551f6a"><div class="ttname"><a href="classMessaging.html#adf1111aaf72b9d0d4dfc4b08dd551f6a">Messaging::updateTopic</a></div><div class="ttdeci">std::string updateTopic(const std::string &amp;topicId, const std::string &amp;name, const std::vector&lt; std::string &gt; &amp;subscribe={})</div><div class="ttdoc">Update an existing topic.</div></div>
328+
<div class="ttc" id="aclassMessaging_html_aed59aaab660e767275e118c3ffc23968"><div class="ttname"><a href="classMessaging.html#aed59aaab660e767275e118c3ffc23968">Messaging::listTargets</a></div><div class="ttdeci">std::string listTargets(const std::string &amp;messageId, const std::vector&lt; std::string &gt; &amp;queries={})</div><div class="ttdoc">List all targets for a given message.</div></div>
310329
<div class="ttc" id="aclassMessaging_html_af9cf658c971cc754e4e560520b94ad8f"><div class="ttname"><a href="classMessaging.html#af9cf658c971cc754e4e560520b94ad8f">Messaging::listSubscribers</a></div><div class="ttdeci">std::string listSubscribers(const std::string &amp;topicId, Queries &amp;queries)</div><div class="ttdoc">List all subscribers of a topic.</div></div>
311330
<div class="ttc" id="aclassMessaging_html_afa46132a851eeca06d601a0ea889d577"><div class="ttname"><a href="classMessaging.html#afa46132a851eeca06d601a0ea889d577">Messaging::listMessages</a></div><div class="ttdeci">std::string listMessages(Queries &amp;queries)</div><div class="ttdoc">List all messages with optional filters.</div></div>
312331
<div class="ttc" id="aclassQueries_html"><div class="ttname"><a href="classQueries.html">Queries</a></div><div class="ttdoc">Utility class to construct and manage Appwrite-style database query filters.</div><div class="ttdef"><b>Definition</b> <a href="Query_8hpp_source.html#l00024">Query.hpp:24</a></div></div>

classMessaging-members.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,10 @@
106106
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#aa596d2b309995e8d3e7196a3037f24ff">getMessages</a>(const std::string &amp;messageId)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
107107
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#adcce04cbe30abcb19f17b9b7390247b5">getSubscriber</a>(const std::string &amp;topicId, const std::string &amp;subscriberId)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
108108
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#ac4206d4f3710b00f0b914f2c8cdf23a5">getTopic</a>(const std::string &amp;topicId)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
109-
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#afa46132a851eeca06d601a0ea889d577">listMessages</a>(Queries &amp;queries)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
110-
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#af9cf658c971cc754e4e560520b94ad8f">listSubscribers</a>(const std::string &amp;topicId, Queries &amp;queries)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
109+
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#aab2cfcd2f79171a204ef1780beef1103">listMessageLogs</a>(const std::string &amp;messageId, Queries &amp;queries)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
110+
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#afa46132a851eeca06d601a0ea889d577">listMessages</a>(Queries &amp;queries)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
111+
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#af9cf658c971cc754e4e560520b94ad8f">listSubscribers</a>(const std::string &amp;topicId, Queries &amp;queries)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
112+
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#aed59aaab660e767275e118c3ffc23968">listTargets</a>(const std::string &amp;messageId, const std::vector&lt; std::string &gt; &amp;queries={})</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
111113
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#a6a097bd5ad8238b4c91e282fc2f57b68">listTopics</a>(Queries &amp;queries)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
112114
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#ad6775b6b42ba1f5892b46643a548aa85">Messaging</a>(const std::string &amp;projectId, const std::string &amp;apiKey)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
113115
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#a0175a63caca1dde7df9fa4c21b08d9d9">updatePush</a>(const std::string &amp;messageId, const std::string &amp;title, const std::string &amp;body, const std::vector&lt; std::string &gt; &amp;topicId={}, const std::vector&lt; std::string &gt; &amp;userId={})</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>

0 commit comments

Comments
 (0)