Skip to content

Commit 2a0c405

Browse files
motwinghmotwingh
committed
update sdk and documentation
1 parent cf27eb7 commit 2a0c405

File tree

10 files changed

+103
-98
lines changed

10 files changed

+103
-98
lines changed

‎doc/Streamdata.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@ <h5>Returns:</h5>
400400

401401
<span class="jsdoc-message">
402402
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a>
403-
on Tue Jun 16 2015 12:08:29 GMT+0200 (CEST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
403+
on Wed Jun 17 2015 11:08:43 GMT+0200 (CEST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
404404
</span>
405405
</footer>
406406
</div>

‎doc/StreamdataError.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -710,7 +710,7 @@ <h5>Returns:</h5>
710710

711711
<span class="jsdoc-message">
712712
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a>
713-
on Tue Jun 16 2015 12:08:29 GMT+0200 (CEST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
713+
on Wed Jun 17 2015 11:08:43 GMT+0200 (CEST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
714714
</span>
715715
</footer>
716716
</div>

‎doc/StreamdataEventSource.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1379,7 +1379,7 @@ <h5>Returns:</h5>
13791379

13801380
<span class="jsdoc-message">
13811381
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a>
1382-
on Tue Jun 16 2015 12:08:29 GMT+0200 (CEST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
1382+
on Wed Jun 17 2015 11:08:43 GMT+0200 (CEST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
13831383
</span>
13841384
</footer>
13851385
</div>

‎doc/api.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ <h1 class="page-title">Source: /var/lib/jenkins/jobs/JavascriptSDK_Compile/works
312312

313313
<span class="jsdoc-message">
314314
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a>
315-
on Tue Jun 16 2015 12:08:29 GMT+0200 (CEST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
315+
on Wed Jun 17 2015 11:08:43 GMT+0200 (CEST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
316316
</span>
317317
</footer>
318318
</div>

‎doc/classes.list.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ <h3 class="subsection-title">Classes</h3>
163163

164164
<span class="jsdoc-message">
165165
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a>
166-
on Tue Jun 16 2015 12:08:29 GMT+0200 (CEST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
166+
on Wed Jun 17 2015 11:08:43 GMT+0200 (CEST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
167167
</span>
168168
</footer>
169169
</div>

‎doc/index.html

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -105,12 +105,12 @@ <h2 id="2-use-streamdata-io-to-connect-to-your-api">2. Use streamdata.io to conn
105105
<p>Create a <code>StreamDataEventSource</code> object into your JavaScript code.</p>
106106
<pre><code class="lang-javascript"> var myEventSource = streamdataio.createEventSource(&quot;http://mysite.com/myJsonRestService&quot;,&lt;app_token&gt;);
107107
</code></pre>
108-
<p>The <code>StreamDataEventSource</code> is the entry point for establishing a data stream connection to the given URL. </p>
108+
<p>The <code>StreamDataEventSource</code> is the entry point for establishing a data stream connection to the given URL.</p>
109109
<p>It uses an application <strong>token</strong> to identify and authorize the stream connection to be established.</p>
110110
<p>To get a valid <strong>token</strong>, please visit <a href="http://streamdata.io" target="_blank">streamdata.io web site</a> to register and create an application.</p>
111111
<p>It uses standard HTTP Server-Sent Events to get the data you required through streamdata.io proxy.</p>
112112
<p>If your API requires specific headers, simply pass them as an array on the event source creation, and streamdata.io will forward them to your Information System.</p>
113-
<p>An optional <code>headers</code> parameter can be passed to the <code>createEventSource</code> method. </p>
113+
<p>An optional <code>headers</code> parameter can be passed to the <code>createEventSource</code> method.</p>
114114
<p>It must be an array with the following structure:</p>
115115
<pre><code>[&#39;header1: headervalue1&#39;, &#39;header2: headervalue2&#39;]
116116
</code></pre><p>Here is an example to add a Basic authorization header to your target API call:</p>
@@ -143,7 +143,7 @@ <h2 id="4-start-receiving-data">4. Start receiving data</h2>
143143
</code></pre>
144144
<h1 id="examples">Examples</h1>
145145
<h2 id="1-simple-javascript-source-code-integration">1. Simple Javascript source code integration</h2>
146-
<p>Here is a complete example of how to use the different callbacks of the streamdata.io SDK. </p>
146+
<p>Here is a complete example of how to use the different callbacks of the streamdata.io SDK.</p>
147147
<p>You can copy/paste this piece of code in a HTML page and test it.</p>
148148
<p>Each callback will be described in further details in the Public API JavaScript doc section.</p>
149149
<pre><code class="lang-javascript">&lt;!-- include streamdataio library --&gt;
@@ -204,14 +204,11 @@ <h3 id="2-1-jquery-example">2.1 jQuery example</h3>
204204
<p>A simple jQuery integration of market data with streamdata.io SDK.</p>
205205
<p><a href="https://github.com/streamdataio/streamdataio-js/tree/master/stockmarket-jquery" target="_blank">Stock Market jQuery</a></p>
206206
<h3 id="2-2-angular-js-example">2.2 Angular.js example</h3>
207-
<p>The same market data example using Angular.js </p>
207+
<p>The same market data example using Angular.js</p>
208208
<p><a href="https://github.com/streamdataio/streamdataio-js/tree/master/stockmarket-angular" target="_blank">Stock Market Angular</a></p>
209-
<h3 id="2-3-twitter-example">2.3 Twitter example</h3>
210-
<p>A sample to demonstrate how to integrate a twitter time line with streamdata.io SDK.</p>
211-
<p><a href="https://github.com/streamdataio/streamdataio-js/tree/master/twitter" target="_blank">Twitter</a></p>
212209
<h1 id="security">Security</h1>
213210
<h2 id="1-tls-encryption">1. TLS Encryption</h2>
214-
<p>streamdata.io proxy uses Transport Layer Security (TLS) as a default to encrypt messages while in transport across the Internet. </p>
211+
<p>streamdata.io proxy uses Transport Layer Security (TLS) as a default to encrypt messages while in transport across the Internet.</p>
215212
<p><strong>Recommendation</strong>:</p>
216213
<p>Even if streamdata.io proxy can be used without TLS encryption, we strongly recommend to always use https (thus TLS) with applications using streamdata.io.</p>
217214
<p>Using TLS ensures that client messages are protected when being sent to and from streamdata.io. This prevents intercepted messages from being viewed by unauthorized parties.</p>
@@ -361,7 +358,7 @@ <h2>
361358

362359
<span class="jsdoc-message">
363360
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a>
364-
on Tue Jun 16 2015 12:08:29 GMT+0200 (CEST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
361+
on Wed Jun 17 2015 11:08:43 GMT+0200 (CEST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
365362
</span>
366363
</footer>
367364
</div>

0 commit comments

Comments
 (0)