Skip to content

Commit a88de55

Browse files
Regenerate Doxygen docs from dca4773
1 parent fedfa60 commit a88de55

15 files changed

Lines changed: 239 additions & 103 deletions

Messaging_8hpp_source.html

Lines changed: 54 additions & 29 deletions
Large diffs are not rendered by default.

classMessaging-members.html

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -101,19 +101,22 @@
101101
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#a47f9b222b054338040d95f559acb916b">createSubscribers</a>(const std::string &amp;topicId, const std::string &amp;name, const std::string &amp;targetId, const std::string &amp;subscriberId)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
102102
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#a10e4125080cde9483e1d22c3fe4d26be">createTopic</a>(const std::string &amp;topicId, const std::string &amp;name, const std::vector&lt; std::string &gt; &amp;subscribe)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
103103
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#a39c06798a06c32d23a58f0f9d619f630">deleteMessages</a>(const std::string &amp;messageId)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
104-
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#a3d23e0d1f5313c7ef7e05de5f0774818">deleteSubscribers</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>
105-
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#a12f8f20f51bd8ec80de6d3f2d6b467ce">deleteTopic</a>(const std::string &amp;topicId)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
106-
<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>
104+
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#a40a9efa92535ca3c745b38ac77021222">deleteProvider</a>(const std::string &amp;providerId)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
105+
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#a3d23e0d1f5313c7ef7e05de5f0774818">deleteSubscribers</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>
106+
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#a12f8f20f51bd8ec80de6d3f2d6b467ce">deleteTopic</a>(const std::string &amp;topicId)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
107+
<tr class="even"><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>
108+
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#a5cd5fb3e33bbbe79efd2c33aaa4ee7f1">getProvider</a>(const std::string &amp;providerId)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
107109
<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>
108110
<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>
109111
<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>
110112
<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>
113-
<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>
114-
<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>
115-
<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>
116-
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#adf1111aaf72b9d0d4dfc4b08dd551f6a">updateTopic</a>(const std::string &amp;topicId, const std::string &amp;name, const std::vector&lt; std::string &gt; &amp;subscribe={})</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
113+
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#ae5433ab8389b8f3e2f0816baeef95eae">listProviders</a>(Queries &amp;queries)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
114+
<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>
115+
<tr class="even"><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>
116+
<tr class="odd"><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>
117+
<tr class="even"><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>
118+
<tr class="odd"><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>
119+
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#adf1111aaf72b9d0d4dfc4b08dd551f6a">updateTopic</a>(const std::string &amp;topicId, const std::string &amp;name, const std::vector&lt; std::string &gt; &amp;subscribe={})</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
117120
</table></div><!-- contents -->
118121
</div><!-- doc-content -->
119122
<!-- start footer part -->

classMessaging.html

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,9 @@
124124
<tr class="memitem:a39c06798a06c32d23a58f0f9d619f630" id="r_a39c06798a06c32d23a58f0f9d619f630"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessaging.html#a39c06798a06c32d23a58f0f9d619f630">deleteMessages</a> (const std::string &amp;messageId)</td></tr>
125125
<tr class="memdesc:a39c06798a06c32d23a58f0f9d619f630"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a message by its ID. <br /></td></tr>
126126
<tr class="separator:a39c06798a06c32d23a58f0f9d619f630"><td class="memSeparator" colspan="2">&#160;</td></tr>
127+
<tr class="memitem:a40a9efa92535ca3c745b38ac77021222" id="r_a40a9efa92535ca3c745b38ac77021222"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessaging.html#a40a9efa92535ca3c745b38ac77021222">deleteProvider</a> (const std::string &amp;providerId)</td></tr>
128+
<tr class="memdesc:a40a9efa92535ca3c745b38ac77021222"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a provider. <br /></td></tr>
129+
<tr class="separator:a40a9efa92535ca3c745b38ac77021222"><td class="memSeparator" colspan="2">&#160;</td></tr>
127130
<tr class="memitem:a3d23e0d1f5313c7ef7e05de5f0774818" id="r_a3d23e0d1f5313c7ef7e05de5f0774818"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessaging.html#a3d23e0d1f5313c7ef7e05de5f0774818">deleteSubscribers</a> (const std::string &amp;topicId, const std::string &amp;subscriberId)</td></tr>
128131
<tr class="memdesc:a3d23e0d1f5313c7ef7e05de5f0774818"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a subscriber from a topic. <br /></td></tr>
129132
<tr class="separator:a3d23e0d1f5313c7ef7e05de5f0774818"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -133,6 +136,9 @@
133136
<tr class="memitem:aa596d2b309995e8d3e7196a3037f24ff" id="r_aa596d2b309995e8d3e7196a3037f24ff"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessaging.html#aa596d2b309995e8d3e7196a3037f24ff">getMessages</a> (const std::string &amp;messageId)</td></tr>
134137
<tr class="memdesc:aa596d2b309995e8d3e7196a3037f24ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a specific message by ID. <br /></td></tr>
135138
<tr class="separator:aa596d2b309995e8d3e7196a3037f24ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
139+
<tr class="memitem:a5cd5fb3e33bbbe79efd2c33aaa4ee7f1" id="r_a5cd5fb3e33bbbe79efd2c33aaa4ee7f1"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessaging.html#a5cd5fb3e33bbbe79efd2c33aaa4ee7f1">getProvider</a> (const std::string &amp;providerId)</td></tr>
140+
<tr class="memdesc:a5cd5fb3e33bbbe79efd2c33aaa4ee7f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a specific provider by ID. <br /></td></tr>
141+
<tr class="separator:a5cd5fb3e33bbbe79efd2c33aaa4ee7f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
136142
<tr class="memitem:adcce04cbe30abcb19f17b9b7390247b5" id="r_adcce04cbe30abcb19f17b9b7390247b5"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessaging.html#adcce04cbe30abcb19f17b9b7390247b5">getSubscriber</a> (const std::string &amp;topicId, const std::string &amp;subscriberId)</td></tr>
137143
<tr class="memdesc:adcce04cbe30abcb19f17b9b7390247b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get details of a subscriber to a topic. <br /></td></tr>
138144
<tr class="separator:adcce04cbe30abcb19f17b9b7390247b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -145,6 +151,9 @@
145151
<tr class="memitem:afa46132a851eeca06d601a0ea889d577" id="r_afa46132a851eeca06d601a0ea889d577"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessaging.html#afa46132a851eeca06d601a0ea889d577">listMessages</a> (<a class="el" href="classQueries.html">Queries</a> &amp;queries)</td></tr>
146152
<tr class="memdesc:afa46132a851eeca06d601a0ea889d577"><td class="mdescLeft">&#160;</td><td class="mdescRight">List all messages with optional filters. <br /></td></tr>
147153
<tr class="separator:afa46132a851eeca06d601a0ea889d577"><td class="memSeparator" colspan="2">&#160;</td></tr>
154+
<tr class="memitem:ae5433ab8389b8f3e2f0816baeef95eae" id="r_ae5433ab8389b8f3e2f0816baeef95eae"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessaging.html#ae5433ab8389b8f3e2f0816baeef95eae">listProviders</a> (<a class="el" href="classQueries.html">Queries</a> &amp;queries)</td></tr>
155+
<tr class="memdesc:ae5433ab8389b8f3e2f0816baeef95eae"><td class="mdescLeft">&#160;</td><td class="mdescRight">List all providers. <br /></td></tr>
156+
<tr class="separator:ae5433ab8389b8f3e2f0816baeef95eae"><td class="memSeparator" colspan="2">&#160;</td></tr>
148157
<tr class="memitem:af9cf658c971cc754e4e560520b94ad8f" id="r_af9cf658c971cc754e4e560520b94ad8f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessaging.html#af9cf658c971cc754e4e560520b94ad8f">listSubscribers</a> (const std::string &amp;topicId, <a class="el" href="classQueries.html">Queries</a> &amp;queries)</td></tr>
149158
<tr class="memdesc:af9cf658c971cc754e4e560520b94ad8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">List all subscribers of a topic. <br /></td></tr>
150159
<tr class="separator:af9cf658c971cc754e4e560520b94ad8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -456,6 +465,33 @@ <h2 class="memtitle"><span class="permalink"><a href="#a39c06798a06c32d23a58f0f9
456465
</dl>
457466
<dl class="section return"><dt>Returns</dt><dd>JSON response. </dd></dl>
458467

468+
</div>
469+
</div>
470+
<a id="a40a9efa92535ca3c745b38ac77021222" name="a40a9efa92535ca3c745b38ac77021222"></a>
471+
<h2 class="memtitle"><span class="permalink"><a href="#a40a9efa92535ca3c745b38ac77021222">&#9670;&#160;</a></span>deleteProvider()</h2>
472+
473+
<div class="memitem">
474+
<div class="memproto">
475+
<table class="memname">
476+
<tr>
477+
<td class="memname">std::string Messaging::deleteProvider </td>
478+
<td>(</td>
479+
<td class="paramtype">const std::string &amp;&#160;</td>
480+
<td class="paramname"><em>providerId</em></td><td>)</td>
481+
<td></td>
482+
</tr>
483+
</table>
484+
</div><div class="memdoc">
485+
486+
<p>Delete a provider. </p>
487+
<dl class="params"><dt>Parameters</dt><dd>
488+
<table class="params">
489+
<tr><td class="paramname">providerId</td><td>ID of the provider </td></tr>
490+
</table>
491+
</dd>
492+
</dl>
493+
<dl class="section return"><dt>Returns</dt><dd>JSON response </dd></dl>
494+
459495
</div>
460496
</div>
461497
<a id="a3d23e0d1f5313c7ef7e05de5f0774818" name="a3d23e0d1f5313c7ef7e05de5f0774818"></a>
@@ -548,6 +584,33 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa596d2b309995e8d3e7196a3
548584
</dl>
549585
<dl class="section return"><dt>Returns</dt><dd>JSON string of the message details </dd></dl>
550586

587+
</div>
588+
</div>
589+
<a id="a5cd5fb3e33bbbe79efd2c33aaa4ee7f1" name="a5cd5fb3e33bbbe79efd2c33aaa4ee7f1"></a>
590+
<h2 class="memtitle"><span class="permalink"><a href="#a5cd5fb3e33bbbe79efd2c33aaa4ee7f1">&#9670;&#160;</a></span>getProvider()</h2>
591+
592+
<div class="memitem">
593+
<div class="memproto">
594+
<table class="memname">
595+
<tr>
596+
<td class="memname">std::string Messaging::getProvider </td>
597+
<td>(</td>
598+
<td class="paramtype">const std::string &amp;&#160;</td>
599+
<td class="paramname"><em>providerId</em></td><td>)</td>
600+
<td></td>
601+
</tr>
602+
</table>
603+
</div><div class="memdoc">
604+
605+
<p>Get a specific provider by ID. </p>
606+
<dl class="params"><dt>Parameters</dt><dd>
607+
<table class="params">
608+
<tr><td class="paramname">providerId</td><td>ID of the provider </td></tr>
609+
</table>
610+
</dd>
611+
</dl>
612+
<dl class="section return"><dt>Returns</dt><dd>JSON string of the provider details </dd></dl>
613+
551614
</div>
552615
</div>
553616
<a id="adcce04cbe30abcb19f17b9b7390247b5" name="adcce04cbe30abcb19f17b9b7390247b5"></a>
@@ -678,6 +741,33 @@ <h2 class="memtitle"><span class="permalink"><a href="#afa46132a851eeca06d601a0e
678741
</dl>
679742
<dl class="section return"><dt>Returns</dt><dd>JSON string of message list </dd></dl>
680743

744+
</div>
745+
</div>
746+
<a id="ae5433ab8389b8f3e2f0816baeef95eae" name="ae5433ab8389b8f3e2f0816baeef95eae"></a>
747+
<h2 class="memtitle"><span class="permalink"><a href="#ae5433ab8389b8f3e2f0816baeef95eae">&#9670;&#160;</a></span>listProviders()</h2>
748+
749+
<div class="memitem">
750+
<div class="memproto">
751+
<table class="memname">
752+
<tr>
753+
<td class="memname">std::string Messaging::listProviders </td>
754+
<td>(</td>
755+
<td class="paramtype"><a class="el" href="classQueries.html">Queries</a> &amp;&#160;</td>
756+
<td class="paramname"><em>queries</em></td><td>)</td>
757+
<td></td>
758+
</tr>
759+
</table>
760+
</div><div class="memdoc">
761+
762+
<p>List all providers. </p>
763+
<dl class="params"><dt>Parameters</dt><dd>
764+
<table class="params">
765+
<tr><td class="paramname">queries</td><td>Optional query filters </td></tr>
766+
</table>
767+
</dd>
768+
</dl>
769+
<dl class="section return"><dt>Returns</dt><dd>JSON string of providers list </dd></dl>
770+
681771
</div>
682772
</div>
683773
<a id="af9cf658c971cc754e4e560520b94ad8f" name="af9cf658c971cc754e4e560520b94ad8f"></a>

classMessaging.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,16 @@ var classMessaging =
66
[ "createSubscribers", "classMessaging.html#a47f9b222b054338040d95f559acb916b", null ],
77
[ "createTopic", "classMessaging.html#a10e4125080cde9483e1d22c3fe4d26be", null ],
88
[ "deleteMessages", "classMessaging.html#a39c06798a06c32d23a58f0f9d619f630", null ],
9+
[ "deleteProvider", "classMessaging.html#a40a9efa92535ca3c745b38ac77021222", null ],
910
[ "deleteSubscribers", "classMessaging.html#a3d23e0d1f5313c7ef7e05de5f0774818", null ],
1011
[ "deleteTopic", "classMessaging.html#a12f8f20f51bd8ec80de6d3f2d6b467ce", null ],
1112
[ "getMessages", "classMessaging.html#aa596d2b309995e8d3e7196a3037f24ff", null ],
13+
[ "getProvider", "classMessaging.html#a5cd5fb3e33bbbe79efd2c33aaa4ee7f1", null ],
1214
[ "getSubscriber", "classMessaging.html#adcce04cbe30abcb19f17b9b7390247b5", null ],
1315
[ "getTopic", "classMessaging.html#ac4206d4f3710b00f0b914f2c8cdf23a5", null ],
1416
[ "listMessageLogs", "classMessaging.html#aab2cfcd2f79171a204ef1780beef1103", null ],
1517
[ "listMessages", "classMessaging.html#afa46132a851eeca06d601a0ea889d577", null ],
18+
[ "listProviders", "classMessaging.html#ae5433ab8389b8f3e2f0816baeef95eae", null ],
1619
[ "listSubscribers", "classMessaging.html#af9cf658c971cc754e4e560520b94ad8f", null ],
1720
[ "listTargets", "classMessaging.html#aed59aaab660e767275e118c3ffc23968", null ],
1821
[ "listTopics", "classMessaging.html#a6a097bd5ad8238b4c91e282fc2f57b68", null ],

classMessaging__coll__graph.md5

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
328589cab74c41954bf9298b2739a318
1+
6030a38bf35df51f0805fcbdf3295900

0 commit comments

Comments
 (0)