UNPKG

5.93 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Global</title>
6
7 <script src="scripts/prettify/prettify.js"> </script>
8 <script src="scripts/prettify/lang-css.js"> </script>
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14</head>
15
16<body>
17
18<div id="main">
19
20 <h1 class="page-title">Global</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2></h2>
32
33
34</header>
35
36<article>
37 <div class="container-overview">
38
39
40
41
42
43
44<dl class="details">
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77</dl>
78
79
80
81
82 </div>
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97 <h3 class="subsection-title">Methods</h3>
98
99
100
101
102
103
104 <h4 class="name" id="Container"><span class="type-signature">(abstract) </span>Container<span class="signature">()</span><span class="type-signature"></span></h4>
105
106
107
108
109
110<div class="description">
111 Abstract parent class with common methods
112</div>
113
114
115
116
117
118
119
120
121
122
123
124
125
126<dl class="details">
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153 <dt class="tag-source">Source:</dt>
154 <dd class="tag-source"><ul class="dummy"><li>
155 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line7">line 7</a>
156 </li></ul></dd>
157
158
159
160
161
162
163
164</dl>
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186 <h4 class="name" id="Container"><span class="type-signature">(abstract) </span>Container<span class="signature">()</span><span class="type-signature"></span></h4>
187
188
189
190
191
192<div class="description">
193 Abstract parent class with common methods
194</div>
195
196
197
198
199
200
201
202
203
204
205
206
207
208<dl class="details">
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235 <dt class="tag-source">Source:</dt>
236 <dd class="tag-source"><ul class="dummy"><li>
237 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line7">line 7</a>
238 </li></ul></dd>
239
240
241
242
243
244
245
246</dl>
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267 <h3 class="subsection-title">Type Definitions</h3>
268
269
270
271
272
273
274 <h4 class="name" id="ServiceObjectOnEvent"><span class="type-signature"></span>ServiceObjectOnEvent<span class="signature">(event)</span><span class="type-signature"></span></h4>
275
276
277
278
279
280<div class="description">
281 Callback called on an event notification
282</div>
283
284
285
286
287
288
289
290
291
292 <h5>Parameters:</h5>
293
294
295<table class="params">
296 <thead>
297 <tr>
298
299 <th>Name</th>
300
301
302 <th>Type</th>
303
304
305
306
307
308 <th class="last">Description</th>
309 </tr>
310 </thead>
311
312 <tbody>
313
314
315 <tr>
316
317 <td class="name"><code>event</code></td>
318
319
320 <td class="type">
321
322
323<span class="param-type">Object</span>
324
325
326
327 </td>
328
329
330
331
332
333 <td class="description last">event information</td>
334 </tr>
335
336
337 </tbody>
338</table>
339
340
341
342
343
344
345<dl class="details">
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372 <dt class="tag-source">Source:</dt>
373 <dd class="tag-source"><ul class="dummy"><li>
374 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line352">line 352</a>
375 </li></ul></dd>
376
377
378
379
380
381
382
383</dl>
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405 <h4 class="name" id="ServiceObjectOnEvent"><span class="type-signature"></span>ServiceObjectOnEvent<span class="signature">(event)</span><span class="type-signature"></span></h4>
406
407
408
409
410
411<div class="description">
412 Callback called on an event notification
413</div>
414
415
416
417
418
419
420
421
422
423 <h5>Parameters:</h5>
424
425
426<table class="params">
427 <thead>
428 <tr>
429
430 <th>Name</th>
431
432
433 <th>Type</th>
434
435
436
437
438
439 <th class="last">Description</th>
440 </tr>
441 </thead>
442
443 <tbody>
444
445
446 <tr>
447
448 <td class="name"><code>event</code></td>
449
450
451 <td class="type">
452
453
454<span class="param-type">Object</span>
455
456
457
458 </td>
459
460
461
462
463
464 <td class="description last">event information</td>
465 </tr>
466
467
468 </tbody>
469</table>
470
471
472
473
474
475
476<dl class="details">
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503 <dt class="tag-source">Source:</dt>
504 <dd class="tag-source"><ul class="dummy"><li>
505 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line352">line 352</a>
506 </li></ul></dd>
507
508
509
510
511
512
513
514</dl>
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535</article>
536
537</section>
538
539
540
541
542</div>
543
544<nav>
545 <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Action.html">Action</a></li><li><a href="Channel.html">Channel</a></li><li><a href="Client.html">Client</a></li><li><a href="Raptor.html">Raptor</a></li><li><a href="RecordSet.html">RecordSet</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="ServiceObject.html">ServiceObject</a></li><li><a href="Stream.html">Stream</a></li><li><a href="User.html">User</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Container">Container</a></li></ul>
546</nav>
547
548<br class="clear">
549
550<footer>
551 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.2</a> on Wed Nov 02 2016 11:15:06 GMT+0100 (CET)
552</footer>
553
554<script> prettyPrint(); </script>
555<script src="scripts/linenumber.js"> </script>
556</body>
557</html>
\No newline at end of file