CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-06-24 21:08:25 +08:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

api-docs: Fix JavaScript code sample.

Browse Source
This commit is contained in:
Rohitt Vashishtha 2017-04-03 10:36:36 +05:30 committed by Tim Abbott
parent 35bb02ead6
commit f27b0231f1
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
templates/zerver/api.html
View File

@ -48,6 +48,13 @@
These code snippets are generated using our very own Zulip tool, by
sending them to myself in a code block, and then using the inspector
to pull out the resulting HTML :)
Sample steps to do:
1. Write code in Zulip message box.
2. Put it in a multiline codeblock and specify a language.
3. Click on 'preview'.
4. Inspect and copy the HTML.
#}
<h4>Stream message</h4>
@ -162,12 +169,12 @@ to pull out the resulting HTML :)
<span class="p">});</span>
<span class="c1">// Register queue to receive messages for user</span>
<span class="nx">zulip</span><span class="p">.</span><span class="nx">queues</span><span class="p">.</span><span class="nx">register</span><span class="p">({</span>
<span class="nx">client</span><span class="p">.</span><span class="nx">queues</span><span class="p">.</span><span class="nx">register</span><span class="p">({</span>
<span class="nx">event_types</span><span class="o">:</span> <span class="p">[</span><span class="s1">'message'</span><span class="p">]</span>
<span class="p">}).</span><span class="nx">then</span><span class="p">((</span><span class="nx">res</span><span class="p">)</span> <span class="o">=&gt;</span> <span class="p">{</span>
<span class="c1">// Retrieve events from a queue</span>
<span class="c1">// Blocking until there is an event (or the request times out)</span>
<span class="nx">zulip</span><span class="p">.</span><span class="nx">events</span><span class="p">.</span><span class="nx">retrieve</span><span class="p">({</span>
<span class="nx">client</span><span class="p">.</span><span class="nx">events</span><span class="p">.</span><span class="nx">retrieve</span><span class="p">({</span>
<span class="nx">queue_id</span><span class="o">:</span> <span class="nx">res</span><span class="p">.</span><span class="nx">queue_id</span><span class="p">,</span>
<span class="nx">last_event_id</span><span class="o">:</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span>
<span class="nx">dont_block</span><span class="o">:</span> <span class="kc">false</span>