Skip to content

Commit c776fa6

Browse files
Regenerate Doxygen docs from 6ba2b75
1 parent a88de55 commit c776fa6

12 files changed

Lines changed: 215 additions & 140 deletions

Messaging_8hpp_source.html

Lines changed: 57 additions & 44 deletions
Large diffs are not rendered by default.

classMessaging-members.html

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -96,27 +96,28 @@
9696

9797
<p>This is the complete list of members for <a class="el" href="classMessaging.html">Messaging</a>, including all inherited members.</p>
9898
<table class="directory">
99-
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#a1d8efed770871df527c361e121bb59a4">createMessage</a>(const std::string &amp;messageId, const std::string &amp;subject, const std::string &amp;content, const std::vector&lt; std::string &gt; &amp;topics={}, const std::vector&lt; std::string &gt; &amp;targets={})</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
100-
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#ab8e8cb4df3f5c106da6bab81e7eb67f2">createPush</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={}, bool draft=false)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
101-
<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>
102-
<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>
103-
<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#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>
109-
<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>
110-
<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>
111-
<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>
112-
<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>
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>
99+
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#a7ed0aafac67cf508c73ce7b9ae08b154">createFcmProvider</a>(std::string &amp;providerId, std::string name, std::string service_account_json, bool enabled)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
100+
<tr class="odd"><td class="entry"><a class="el" href="classMessaging.html#a1d8efed770871df527c361e121bb59a4">createMessage</a>(const std::string &amp;messageId, const std::string &amp;subject, const std::string &amp;content, const std::vector&lt; std::string &gt; &amp;topics={}, const std::vector&lt; std::string &gt; &amp;targets={})</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
101+
<tr class="even"><td class="entry"><a class="el" href="classMessaging.html#ab8e8cb4df3f5c106da6bab81e7eb67f2">createPush</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={}, bool draft=false)</td><td class="entry"><a class="el" href="classMessaging.html">Messaging</a></td><td class="entry"></td></tr>
102+
<tr class="odd"><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>
103+
<tr class="even"><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>
104+
<tr class="odd"><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>
105+
<tr class="even"><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>
106+
<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>
107+
<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>
108+
<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>
109+
<tr class="even"><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>
110+
<tr class="odd"><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>
111+
<tr class="even"><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>
112+
<tr class="odd"><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>
113+
<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>
114+
<tr class="odd"><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>
115+
<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>
116+
<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>
117+
<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>
118+
<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>
119+
<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>
120+
<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>
120121
</table></div><!-- contents -->
121122
</div><!-- doc-content -->
122123
<!-- start footer part -->

classMessaging.html

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,11 +104,14 @@
104104
<div class="dynheader">
105105
Collaboration diagram for Messaging:</div>
106106
<div class="dyncontent">
107-
<div class="center"><iframe scrolling="no" frameborder="0" src="classMessaging__coll__graph.svg" width="166" height="276"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
107+
<div class="center"><iframe scrolling="no" frameborder="0" src="classMessaging__coll__graph.svg" width="172" height="276"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
108108
</div>
109109
<table class="memberdecls">
110110
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
111111
Public Member Functions</h2></td></tr>
112+
<tr class="memitem:a7ed0aafac67cf508c73ce7b9ae08b154" id="r_a7ed0aafac67cf508c73ce7b9ae08b154"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessaging.html#a7ed0aafac67cf508c73ce7b9ae08b154">createFcmProvider</a> (std::string &amp;providerId, std::string name, std::string service_account_json, bool enabled)</td></tr>
113+
<tr class="memdesc:a7ed0aafac67cf508c73ce7b9ae08b154"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new Firebase Cloud <a class="el" href="classMessaging.html" title="Provides APIs to manage messaging: messages, topics, subscribers.">Messaging</a> provider. <br /></td></tr>
114+
<tr class="separator:a7ed0aafac67cf508c73ce7b9ae08b154"><td class="memSeparator" colspan="2">&#160;</td></tr>
112115
<tr class="memitem:a1d8efed770871df527c361e121bb59a4" id="r_a1d8efed770871df527c361e121bb59a4"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessaging.html#a1d8efed770871df527c361e121bb59a4">createMessage</a> (const std::string &amp;messageId, const std::string &amp;subject, const std::string &amp;content, const std::vector&lt; std::string &gt; &amp;topics={}, const std::vector&lt; std::string &gt; &amp;targets={})</td></tr>
113116
<tr class="memdesc:a1d8efed770871df527c361e121bb59a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new email message. <br /></td></tr>
114117
<tr class="separator:a1d8efed770871df527c361e121bb59a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -216,6 +219,58 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad6775b6b42ba1f5892b46643
216219
</div>
217220
</div>
218221
<h2 class="groupheader">Member Function Documentation</h2>
222+
<a id="a7ed0aafac67cf508c73ce7b9ae08b154" name="a7ed0aafac67cf508c73ce7b9ae08b154"></a>
223+
<h2 class="memtitle"><span class="permalink"><a href="#a7ed0aafac67cf508c73ce7b9ae08b154">&#9670;&#160;</a></span>createFcmProvider()</h2>
224+
225+
<div class="memitem">
226+
<div class="memproto">
227+
<table class="memname">
228+
<tr>
229+
<td class="memname">std::string Messaging::createFcmProvider </td>
230+
<td>(</td>
231+
<td class="paramtype">std::string &amp;&#160;</td>
232+
<td class="paramname"><em>providerId</em>, </td>
233+
</tr>
234+
<tr>
235+
<td class="paramkey"></td>
236+
<td></td>
237+
<td class="paramtype">std::string&#160;</td>
238+
<td class="paramname"><em>name</em>, </td>
239+
</tr>
240+
<tr>
241+
<td class="paramkey"></td>
242+
<td></td>
243+
<td class="paramtype">std::string&#160;</td>
244+
<td class="paramname"><em>service_account_json</em>, </td>
245+
</tr>
246+
<tr>
247+
<td class="paramkey"></td>
248+
<td></td>
249+
<td class="paramtype">bool&#160;</td>
250+
<td class="paramname"><em>enabled</em>&#160;</td>
251+
</tr>
252+
<tr>
253+
<td></td>
254+
<td>)</td>
255+
<td></td><td></td>
256+
</tr>
257+
</table>
258+
</div><div class="memdoc">
259+
260+
<p>Create a new Firebase Cloud <a class="el" href="classMessaging.html" title="Provides APIs to manage messaging: messages, topics, subscribers.">Messaging</a> provider. </p>
261+
<dl class="params"><dt>Parameters</dt><dd>
262+
<table class="params">
263+
<tr><td class="paramname">providerId</td><td>A unique Id for the provider. </td></tr>
264+
<tr><td class="paramname">name</td><td>provider name. </td></tr>
265+
<tr><td class="paramname">service_account_json</td><td>FCM service account JSON.. </td></tr>
266+
<tr><td class="paramname">enabled</td><td>Whether the provider should be active immediately after creation. </td></tr>
267+
</table>
268+
</dd>
269+
</dl>
270+
<dl class="section return"><dt>Returns</dt><dd>JSON response. </dd></dl>
271+
272+
</div>
273+
</div>
219274
<a id="a1d8efed770871df527c361e121bb59a4" name="a1d8efed770871df527c361e121bb59a4"></a>
220275
<h2 class="memtitle"><span class="permalink"><a href="#a1d8efed770871df527c361e121bb59a4">&#9670;&#160;</a></span>createMessage()</h2>
221276

classMessaging.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
var classMessaging =
22
[
33
[ "Messaging", "classMessaging.html#ad6775b6b42ba1f5892b46643a548aa85", null ],
4+
[ "createFcmProvider", "classMessaging.html#a7ed0aafac67cf508c73ce7b9ae08b154", null ],
45
[ "createMessage", "classMessaging.html#a1d8efed770871df527c361e121bb59a4", null ],
56
[ "createPush", "classMessaging.html#ab8e8cb4df3f5c106da6bab81e7eb67f2", null ],
67
[ "createSubscribers", "classMessaging.html#a47f9b222b054338040d95f559acb916b", null ],

classMessaging__coll__graph.map

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<map id="Messaging" name="Messaging">
2-
<area shape="rect" id="Node000001" title="Provides APIs to manage messaging: messages, topics, subscribers." alt="" coords="5,5,160,271"/>
2+
<area shape="rect" id="Node000001" title="Provides APIs to manage messaging: messages, topics, subscribers." alt="" coords="5,5,167,271"/>
33
</map>

classMessaging__coll__graph.md5

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

0 commit comments

Comments
 (0)