UNPKG

28.2 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Class: Channel</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">Class: Channel</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2>Channel</h2>
32
33
34</header>
35
36<article>
37 <div class="container-overview">
38
39
40
41
42
43 <h4 class="name" id="Channel"><span class="type-signature"></span>new Channel<span class="signature">(obj)</span><span class="type-signature"></span></h4>
44
45
46
47
48
49<div class="description">
50 A Stream object
51</div>
52
53
54
55
56
57
58
59
60
61 <h5>Parameters:</h5>
62
63
64<table class="params">
65 <thead>
66 <tr>
67
68 <th>Name</th>
69
70
71 <th>Type</th>
72
73
74
75
76
77 <th class="last">Description</th>
78 </tr>
79 </thead>
80
81 <tbody>
82
83
84 <tr>
85
86 <td class="name"><code>obj</code></td>
87
88
89 <td class="type">
90
91
92<span class="param-type">Object</span>
93
94
95
96 </td>
97
98
99
100
101
102 <td class="description last">An object with the Stream properties</td>
103 </tr>
104
105
106 </tbody>
107</table>
108
109
110
111
112
113
114<dl class="details">
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141 <dt class="tag-source">Source:</dt>
142 <dd class="tag-source"><ul class="dummy"><li>
143 <a href="lib_model_Channel.js.html">lib/model/Channel.js</a>, <a href="lib_model_Channel.js.html#line10">line 10</a>
144 </li></ul></dd>
145
146
147
148
149
150
151
152</dl>
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170 </div>
171
172
173 <h3 class="subsection-title">Extends</h3>
174
175
176
177
178 <ul>
179 <li><a href="global.html#Container">Container</a></li>
180 </ul>
181
182
183
184
185
186
187
188
189
190
191
192
193
194 <h3 class="subsection-title">Members</h3>
195
196
197
198<h4 class="name" id="getObject"><span class="type-signature"></span>getObject<span class="type-signature"></span></h4>
199
200
201
202
203
204
205
206
207
208
209<dl class="details">
210
211
212
213
214
215
216
217
218 <dt class="tag-overrides">Overrides:</dt>
219 <dd class="tag-overrides"><ul class="dummy"><li>
220 <a href="global.html#Container#getObject">Container#getObject</a>
221 </li></ul></dd>
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241 <dt class="tag-source">Source:</dt>
242 <dd class="tag-source"><ul class="dummy"><li>
243 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line70">line 70</a>
244 </li></ul></dd>
245
246
247
248
249
250
251
252</dl>
253
254
255
256
257
258
259
260
261
262
263 <h3 class="subsection-title">Methods</h3>
264
265
266
267
268
269
270 <h4 class="name" id="exportProperties"><span class="type-signature"></span>exportProperties<span class="signature">()</span><span class="type-signature"></span></h4>
271
272
273
274
275
276<div class="description">
277 Exposes setter and getter for a class from the `data` field
278</div>
279
280
281
282
283
284
285
286
287
288
289
290
291
292<dl class="details">
293
294
295
296
297
298
299
300
301 <dt class="tag-overrides">Overrides:</dt>
302 <dd class="tag-overrides"><ul class="dummy"><li>
303 <a href="global.html#Container#exportProperties">Container#exportProperties</a>
304 </li></ul></dd>
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324 <dt class="tag-source">Source:</dt>
325 <dd class="tag-source"><ul class="dummy"><li>
326 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line19">line 19</a>
327 </li></ul></dd>
328
329
330
331
332
333
334
335</dl>
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357 <h4 class="name" id="getClient"><span class="type-signature"></span>getClient<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Client.html">Client</a>}</span></h4>
358
359
360
361
362
363<div class="description">
364 Return the client reference
365</div>
366
367
368
369
370
371
372
373
374
375
376
377
378
379<dl class="details">
380
381
382
383
384
385
386
387
388 <dt class="tag-overrides">Overrides:</dt>
389 <dd class="tag-overrides"><ul class="dummy"><li>
390 <a href="global.html#Container#getClient">Container#getClient</a>
391 </li></ul></dd>
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411 <dt class="tag-source">Source:</dt>
412 <dd class="tag-source"><ul class="dummy"><li>
413 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line37">line 37</a>
414 </li></ul></dd>
415
416
417
418
419
420
421
422</dl>
423
424
425
426
427
428
429
430
431
432
433
434
435
436<h5>Returns:</h5>
437
438
439<div class="param-desc">
440 client
441</div>
442
443
444
445<dl>
446 <dt>
447 Type
448 </dt>
449 <dd>
450
451<span class="param-type"><a href="Client.html">Client</a></span>
452
453
454 </dd>
455</dl>
456
457
458
459
460
461
462
463
464
465
466 <h4 class="name" id="getContainer"><span class="type-signature"></span>getContainer<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Raptor.html">Raptor</a>}</span></h4>
467
468
469
470
471
472<div class="description">
473 Return the Raptor instance wrapper
474</div>
475
476
477
478
479
480
481
482
483
484
485
486
487
488<dl class="details">
489
490
491
492
493
494
495
496
497 <dt class="tag-overrides">Overrides:</dt>
498 <dd class="tag-overrides"><ul class="dummy"><li>
499 <a href="global.html#Container#getContainer">Container#getContainer</a>
500 </li></ul></dd>
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520 <dt class="tag-source">Source:</dt>
521 <dd class="tag-source"><ul class="dummy"><li>
522 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line45">line 45</a>
523 </li></ul></dd>
524
525
526
527
528
529
530
531</dl>
532
533
534
535
536
537
538
539
540
541
542
543
544
545<h5>Returns:</h5>
546
547
548<div class="param-desc">
549 container Raptor instance reference
550</div>
551
552
553
554<dl>
555 <dt>
556 Type
557 </dt>
558 <dd>
559
560<span class="param-type"><a href="Raptor.html">Raptor</a></span>
561
562
563 </dd>
564</dl>
565
566
567
568
569
570
571
572
573
574
575 <h4 class="name" id="parseJSON"><span class="type-signature"></span>parseJSON<span class="signature">(raw)</span><span class="type-signature"></span></h4>
576
577
578
579
580
581<div class="description">
582 Parse a plain object and populate the corresponding fields in the current instance
583</div>
584
585
586
587
588
589
590
591
592
593 <h5>Parameters:</h5>
594
595
596<table class="params">
597 <thead>
598 <tr>
599
600 <th>Name</th>
601
602
603 <th>Type</th>
604
605
606
607
608
609 <th class="last">Description</th>
610 </tr>
611 </thead>
612
613 <tbody>
614
615
616 <tr>
617
618 <td class="name"><code>raw</code></td>
619
620
621 <td class="type">
622
623
624<span class="param-type">Object</span>
625
626
627
628 </td>
629
630
631
632
633
634 <td class="description last">the json object</td>
635 </tr>
636
637
638 </tbody>
639</table>
640
641
642
643
644
645
646<dl class="details">
647
648
649
650
651
652
653
654
655 <dt class="tag-overrides">Overrides:</dt>
656 <dd class="tag-overrides"><ul class="dummy"><li>
657 <a href="global.html#Container#parseJSON">Container#parseJSON</a>
658 </li></ul></dd>
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678 <dt class="tag-source">Source:</dt>
679 <dd class="tag-source"><ul class="dummy"><li>
680 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line127">line 127</a>
681 </li></ul></dd>
682
683
684
685
686
687
688
689</dl>
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711 <h4 class="name" id="setContainer"><span class="type-signature"></span>setContainer<span class="signature">(container)</span><span class="type-signature"></span></h4>
712
713
714
715
716
717
718
719
720
721
722
723
724
725 <h5>Parameters:</h5>
726
727
728<table class="params">
729 <thead>
730 <tr>
731
732 <th>Name</th>
733
734
735 <th>Type</th>
736
737
738
739
740
741 <th class="last">Description</th>
742 </tr>
743 </thead>
744
745 <tbody>
746
747
748 <tr>
749
750 <td class="name"><code>container</code></td>
751
752
753 <td class="type">
754
755
756<span class="param-type"><a href="Raptor.html">Raptor</a></span>
757
758
759
760 </td>
761
762
763
764
765
766 <td class="description last">reference to Raptor instance wrapper</td>
767 </tr>
768
769
770 </tbody>
771</table>
772
773
774
775
776
777
778<dl class="details">
779
780
781
782
783
784
785
786
787 <dt class="tag-overrides">Overrides:</dt>
788 <dd class="tag-overrides"><ul class="dummy"><li>
789 <a href="global.html#Container#setContainer">Container#setContainer</a>
790 </li></ul></dd>
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810 <dt class="tag-source">Source:</dt>
811 <dd class="tag-source"><ul class="dummy"><li>
812 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line52">line 52</a>
813 </li></ul></dd>
814
815
816
817
818
819
820
821</dl>
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843 <h4 class="name" id="setServiceObject"><span class="type-signature"></span>setServiceObject<span class="signature">(object)</span><span class="type-signature"></span></h4>
844
845
846
847
848
849<div class="description">
850 Set a reference to the parent object
851</div>
852
853
854
855
856
857
858
859
860
861 <h5>Parameters:</h5>
862
863
864<table class="params">
865 <thead>
866 <tr>
867
868 <th>Name</th>
869
870
871 <th>Type</th>
872
873
874
875
876
877 <th class="last">Description</th>
878 </tr>
879 </thead>
880
881 <tbody>
882
883
884 <tr>
885
886 <td class="name"><code>object</code></td>
887
888
889 <td class="type">
890
891
892<span class="param-type"><a href="ServiceObject.html">ServiceObject</a></span>
893
894
895
896 </td>
897
898
899
900
901
902 <td class="description last">reference to the parent object</td>
903 </tr>
904
905
906 </tbody>
907</table>
908
909
910
911
912
913
914<dl class="details">
915
916
917
918
919
920
921
922
923 <dt class="tag-overrides">Overrides:</dt>
924 <dd class="tag-overrides"><ul class="dummy"><li>
925 <a href="global.html#Container#setServiceObject">Container#setServiceObject</a>
926 </li></ul></dd>
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946 <dt class="tag-source">Source:</dt>
947 <dd class="tag-source"><ul class="dummy"><li>
948 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line60">line 60</a>
949 </li></ul></dd>
950
951
952
953
954
955
956
957</dl>
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979 <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
980
981
982
983
984
985<div class="description">
986 Convert the instance to a js object
987</div>
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001<dl class="details">
1002
1003
1004
1005
1006
1007
1008
1009
1010 <dt class="tag-overrides">Overrides:</dt>
1011 <dd class="tag-overrides"><ul class="dummy"><li>
1012 <a href="global.html#Container#toJSON">Container#toJSON</a>
1013 </li></ul></dd>
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033 <dt class="tag-source">Source:</dt>
1034 <dd class="tag-source"><ul class="dummy"><li>
1035 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line86">line 86</a>
1036 </li></ul></dd>
1037
1038
1039
1040
1041
1042
1043
1044</dl>
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058<h5>Returns:</h5>
1059
1060
1061<div class="param-desc">
1062 Plain js object
1063</div>
1064
1065
1066
1067<dl>
1068 <dt>
1069 Type
1070 </dt>
1071 <dd>
1072
1073<span class="param-type">Object</span>
1074
1075
1076 </dd>
1077</dl>
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088 <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
1089
1090
1091
1092
1093
1094<div class="description">
1095 Return a JSON string of this object
1096</div>
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110<dl class="details">
1111
1112
1113
1114
1115
1116
1117
1118
1119 <dt class="tag-overrides">Overrides:</dt>
1120 <dd class="tag-overrides"><ul class="dummy"><li>
1121 <a href="global.html#Container#toString">Container#toString</a>
1122 </li></ul></dd>
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142 <dt class="tag-source">Source:</dt>
1143 <dd class="tag-source"><ul class="dummy"><li>
1144 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line119">line 119</a>
1145 </li></ul></dd>
1146
1147
1148
1149
1150
1151
1152
1153</dl>
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167<h5>Returns:</h5>
1168
1169
1170<div class="param-desc">
1171 json stringified JSON
1172</div>
1173
1174
1175
1176<dl>
1177 <dt>
1178 Type
1179 </dt>
1180 <dd>
1181
1182<span class="param-type">String</span>
1183
1184
1185 </dd>
1186</dl>
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197 <h4 class="name" id="validate"><span class="type-signature"></span>validate<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span></h4>
1198
1199
1200
1201
1202
1203<div class="description">
1204 Validate the object and throw an exception if fails
1205</div>
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219<dl class="details">
1220
1221
1222
1223
1224
1225
1226
1227
1228 <dt class="tag-overrides">Overrides:</dt>
1229 <dd class="tag-overrides"><ul class="dummy"><li>
1230 <a href="global.html#Container#validate">Container#validate</a>
1231 </li></ul></dd>
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251 <dt class="tag-source">Source:</dt>
1252 <dd class="tag-source"><ul class="dummy"><li>
1253 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line78">line 78</a>
1254 </li></ul></dd>
1255
1256
1257
1258
1259
1260
1261
1262</dl>
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276<h5>Returns:</h5>
1277
1278
1279
1280
1281<dl>
1282 <dt>
1283 Type
1284 </dt>
1285 <dd>
1286
1287<span class="param-type">void</span>
1288
1289
1290 </dd>
1291</dl>
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303</article>
1304
1305</section>
1306
1307
1308
1309
1310
1311
1312
1313<section>
1314
1315<header>
1316
1317 <h2>Channel</h2>
1318
1319
1320</header>
1321
1322<article>
1323 <div class="container-overview">
1324
1325
1326
1327
1328
1329 <h4 class="name" id="Channel"><span class="type-signature"></span>new Channel<span class="signature">(obj)</span><span class="type-signature"></span></h4>
1330
1331
1332
1333
1334
1335<div class="description">
1336 A Stream object
1337</div>
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347 <h5>Parameters:</h5>
1348
1349
1350<table class="params">
1351 <thead>
1352 <tr>
1353
1354 <th>Name</th>
1355
1356
1357 <th>Type</th>
1358
1359
1360
1361
1362
1363 <th class="last">Description</th>
1364 </tr>
1365 </thead>
1366
1367 <tbody>
1368
1369
1370 <tr>
1371
1372 <td class="name"><code>obj</code></td>
1373
1374
1375 <td class="type">
1376
1377
1378<span class="param-type">Object</span>
1379
1380
1381
1382 </td>
1383
1384
1385
1386
1387
1388 <td class="description last">An object with the Stream properties</td>
1389 </tr>
1390
1391
1392 </tbody>
1393</table>
1394
1395
1396
1397
1398
1399
1400<dl class="details">
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427 <dt class="tag-source">Source:</dt>
1428 <dd class="tag-source"><ul class="dummy"><li>
1429 <a href="lib_model_Channel.js.html">lib/model/Channel.js</a>, <a href="lib_model_Channel.js.html#line10">line 10</a>
1430 </li></ul></dd>
1431
1432
1433
1434
1435
1436
1437
1438</dl>
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456 </div>
1457
1458
1459 <h3 class="subsection-title">Extends</h3>
1460
1461
1462
1463
1464 <ul>
1465 <li><a href="global.html#Container">Container</a></li>
1466 </ul>
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480 <h3 class="subsection-title">Members</h3>
1481
1482
1483
1484<h4 class="name" id="getObject"><span class="type-signature"></span>getObject<span class="type-signature"></span></h4>
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495<dl class="details">
1496
1497
1498
1499
1500
1501
1502
1503
1504 <dt class="tag-overrides">Overrides:</dt>
1505 <dd class="tag-overrides"><ul class="dummy"><li>
1506 <a href="global.html#Container#getObject">Container#getObject</a>
1507 </li></ul></dd>
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527 <dt class="tag-source">Source:</dt>
1528 <dd class="tag-source"><ul class="dummy"><li>
1529 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line70">line 70</a>
1530 </li></ul></dd>
1531
1532
1533
1534
1535
1536
1537
1538</dl>
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549 <h3 class="subsection-title">Methods</h3>
1550
1551
1552
1553
1554
1555
1556 <h4 class="name" id="exportProperties"><span class="type-signature"></span>exportProperties<span class="signature">()</span><span class="type-signature"></span></h4>
1557
1558
1559
1560
1561
1562<div class="description">
1563 Exposes setter and getter for a class from the `data` field
1564</div>
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578<dl class="details">
1579
1580
1581
1582
1583
1584
1585
1586
1587 <dt class="tag-overrides">Overrides:</dt>
1588 <dd class="tag-overrides"><ul class="dummy"><li>
1589 <a href="global.html#Container#exportProperties">Container#exportProperties</a>
1590 </li></ul></dd>
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610 <dt class="tag-source">Source:</dt>
1611 <dd class="tag-source"><ul class="dummy"><li>
1612 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line19">line 19</a>
1613 </li></ul></dd>
1614
1615
1616
1617
1618
1619
1620
1621</dl>
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643 <h4 class="name" id="getClient"><span class="type-signature"></span>getClient<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Client.html">Client</a>}</span></h4>
1644
1645
1646
1647
1648
1649<div class="description">
1650 Return the client reference
1651</div>
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665<dl class="details">
1666
1667
1668
1669
1670
1671
1672
1673
1674 <dt class="tag-overrides">Overrides:</dt>
1675 <dd class="tag-overrides"><ul class="dummy"><li>
1676 <a href="global.html#Container#getClient">Container#getClient</a>
1677 </li></ul></dd>
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697 <dt class="tag-source">Source:</dt>
1698 <dd class="tag-source"><ul class="dummy"><li>
1699 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line37">line 37</a>
1700 </li></ul></dd>
1701
1702
1703
1704
1705
1706
1707
1708</dl>
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722<h5>Returns:</h5>
1723
1724
1725<div class="param-desc">
1726 client
1727</div>
1728
1729
1730
1731<dl>
1732 <dt>
1733 Type
1734 </dt>
1735 <dd>
1736
1737<span class="param-type"><a href="Client.html">Client</a></span>
1738
1739
1740 </dd>
1741</dl>
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752 <h4 class="name" id="getContainer"><span class="type-signature"></span>getContainer<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Raptor.html">Raptor</a>}</span></h4>
1753
1754
1755
1756
1757
1758<div class="description">
1759 Return the Raptor instance wrapper
1760</div>
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774<dl class="details">
1775
1776
1777
1778
1779
1780
1781
1782
1783 <dt class="tag-overrides">Overrides:</dt>
1784 <dd class="tag-overrides"><ul class="dummy"><li>
1785 <a href="global.html#Container#getContainer">Container#getContainer</a>
1786 </li></ul></dd>
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806 <dt class="tag-source">Source:</dt>
1807 <dd class="tag-source"><ul class="dummy"><li>
1808 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line45">line 45</a>
1809 </li></ul></dd>
1810
1811
1812
1813
1814
1815
1816
1817</dl>
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831<h5>Returns:</h5>
1832
1833
1834<div class="param-desc">
1835 container Raptor instance reference
1836</div>
1837
1838
1839
1840<dl>
1841 <dt>
1842 Type
1843 </dt>
1844 <dd>
1845
1846<span class="param-type"><a href="Raptor.html">Raptor</a></span>
1847
1848
1849 </dd>
1850</dl>
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861 <h4 class="name" id="parseJSON"><span class="type-signature"></span>parseJSON<span class="signature">(raw)</span><span class="type-signature"></span></h4>
1862
1863
1864
1865
1866
1867<div class="description">
1868 Parse a plain object and populate the corresponding fields in the current instance
1869</div>
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879 <h5>Parameters:</h5>
1880
1881
1882<table class="params">
1883 <thead>
1884 <tr>
1885
1886 <th>Name</th>
1887
1888
1889 <th>Type</th>
1890
1891
1892
1893
1894
1895 <th class="last">Description</th>
1896 </tr>
1897 </thead>
1898
1899 <tbody>
1900
1901
1902 <tr>
1903
1904 <td class="name"><code>raw</code></td>
1905
1906
1907 <td class="type">
1908
1909
1910<span class="param-type">Object</span>
1911
1912
1913
1914 </td>
1915
1916
1917
1918
1919
1920 <td class="description last">the json object</td>
1921 </tr>
1922
1923
1924 </tbody>
1925</table>
1926
1927
1928
1929
1930
1931
1932<dl class="details">
1933
1934
1935
1936
1937
1938
1939
1940
1941 <dt class="tag-overrides">Overrides:</dt>
1942 <dd class="tag-overrides"><ul class="dummy"><li>
1943 <a href="global.html#Container#parseJSON">Container#parseJSON</a>
1944 </li></ul></dd>
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964 <dt class="tag-source">Source:</dt>
1965 <dd class="tag-source"><ul class="dummy"><li>
1966 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line127">line 127</a>
1967 </li></ul></dd>
1968
1969
1970
1971
1972
1973
1974
1975</dl>
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997 <h4 class="name" id="setContainer"><span class="type-signature"></span>setContainer<span class="signature">(container)</span><span class="type-signature"></span></h4>
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011 <h5>Parameters:</h5>
2012
2013
2014<table class="params">
2015 <thead>
2016 <tr>
2017
2018 <th>Name</th>
2019
2020
2021 <th>Type</th>
2022
2023
2024
2025
2026
2027 <th class="last">Description</th>
2028 </tr>
2029 </thead>
2030
2031 <tbody>
2032
2033
2034 <tr>
2035
2036 <td class="name"><code>container</code></td>
2037
2038
2039 <td class="type">
2040
2041
2042<span class="param-type"><a href="Raptor.html">Raptor</a></span>
2043
2044
2045
2046 </td>
2047
2048
2049
2050
2051
2052 <td class="description last">reference to Raptor instance wrapper</td>
2053 </tr>
2054
2055
2056 </tbody>
2057</table>
2058
2059
2060
2061
2062
2063
2064<dl class="details">
2065
2066
2067
2068
2069
2070
2071
2072
2073 <dt class="tag-overrides">Overrides:</dt>
2074 <dd class="tag-overrides"><ul class="dummy"><li>
2075 <a href="global.html#Container#setContainer">Container#setContainer</a>
2076 </li></ul></dd>
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096 <dt class="tag-source">Source:</dt>
2097 <dd class="tag-source"><ul class="dummy"><li>
2098 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line52">line 52</a>
2099 </li></ul></dd>
2100
2101
2102
2103
2104
2105
2106
2107</dl>
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129 <h4 class="name" id="setServiceObject"><span class="type-signature"></span>setServiceObject<span class="signature">(object)</span><span class="type-signature"></span></h4>
2130
2131
2132
2133
2134
2135<div class="description">
2136 Set a reference to the parent object
2137</div>
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147 <h5>Parameters:</h5>
2148
2149
2150<table class="params">
2151 <thead>
2152 <tr>
2153
2154 <th>Name</th>
2155
2156
2157 <th>Type</th>
2158
2159
2160
2161
2162
2163 <th class="last">Description</th>
2164 </tr>
2165 </thead>
2166
2167 <tbody>
2168
2169
2170 <tr>
2171
2172 <td class="name"><code>object</code></td>
2173
2174
2175 <td class="type">
2176
2177
2178<span class="param-type"><a href="ServiceObject.html">ServiceObject</a></span>
2179
2180
2181
2182 </td>
2183
2184
2185
2186
2187
2188 <td class="description last">reference to the parent object</td>
2189 </tr>
2190
2191
2192 </tbody>
2193</table>
2194
2195
2196
2197
2198
2199
2200<dl class="details">
2201
2202
2203
2204
2205
2206
2207
2208
2209 <dt class="tag-overrides">Overrides:</dt>
2210 <dd class="tag-overrides"><ul class="dummy"><li>
2211 <a href="global.html#Container#setServiceObject">Container#setServiceObject</a>
2212 </li></ul></dd>
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232 <dt class="tag-source">Source:</dt>
2233 <dd class="tag-source"><ul class="dummy"><li>
2234 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line60">line 60</a>
2235 </li></ul></dd>
2236
2237
2238
2239
2240
2241
2242
2243</dl>
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265 <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
2266
2267
2268
2269
2270
2271<div class="description">
2272 Convert the instance to a js object
2273</div>
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287<dl class="details">
2288
2289
2290
2291
2292
2293
2294
2295
2296 <dt class="tag-overrides">Overrides:</dt>
2297 <dd class="tag-overrides"><ul class="dummy"><li>
2298 <a href="global.html#Container#toJSON">Container#toJSON</a>
2299 </li></ul></dd>
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319 <dt class="tag-source">Source:</dt>
2320 <dd class="tag-source"><ul class="dummy"><li>
2321 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line86">line 86</a>
2322 </li></ul></dd>
2323
2324
2325
2326
2327
2328
2329
2330</dl>
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344<h5>Returns:</h5>
2345
2346
2347<div class="param-desc">
2348 Plain js object
2349</div>
2350
2351
2352
2353<dl>
2354 <dt>
2355 Type
2356 </dt>
2357 <dd>
2358
2359<span class="param-type">Object</span>
2360
2361
2362 </dd>
2363</dl>
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374 <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
2375
2376
2377
2378
2379
2380<div class="description">
2381 Return a JSON string of this object
2382</div>
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396<dl class="details">
2397
2398
2399
2400
2401
2402
2403
2404
2405 <dt class="tag-overrides">Overrides:</dt>
2406 <dd class="tag-overrides"><ul class="dummy"><li>
2407 <a href="global.html#Container#toString">Container#toString</a>
2408 </li></ul></dd>
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428 <dt class="tag-source">Source:</dt>
2429 <dd class="tag-source"><ul class="dummy"><li>
2430 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line119">line 119</a>
2431 </li></ul></dd>
2432
2433
2434
2435
2436
2437
2438
2439</dl>
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453<h5>Returns:</h5>
2454
2455
2456<div class="param-desc">
2457 json stringified JSON
2458</div>
2459
2460
2461
2462<dl>
2463 <dt>
2464 Type
2465 </dt>
2466 <dd>
2467
2468<span class="param-type">String</span>
2469
2470
2471 </dd>
2472</dl>
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483 <h4 class="name" id="validate"><span class="type-signature"></span>validate<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span></h4>
2484
2485
2486
2487
2488
2489<div class="description">
2490 Validate the object and throw an exception if fails
2491</div>
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505<dl class="details">
2506
2507
2508
2509
2510
2511
2512
2513
2514 <dt class="tag-overrides">Overrides:</dt>
2515 <dd class="tag-overrides"><ul class="dummy"><li>
2516 <a href="global.html#Container#validate">Container#validate</a>
2517 </li></ul></dd>
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537 <dt class="tag-source">Source:</dt>
2538 <dd class="tag-source"><ul class="dummy"><li>
2539 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line78">line 78</a>
2540 </li></ul></dd>
2541
2542
2543
2544
2545
2546
2547
2548</dl>
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562<h5>Returns:</h5>
2563
2564
2565
2566
2567<dl>
2568 <dt>
2569 Type
2570 </dt>
2571 <dd>
2572
2573<span class="param-type">void</span>
2574
2575
2576 </dd>
2577</dl>
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589</article>
2590
2591</section>
2592
2593
2594
2595
2596</div>
2597
2598<nav>
2599 <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>
2600</nav>
2601
2602<br class="clear">
2603
2604<footer>
2605 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)
2606</footer>
2607
2608<script> prettyPrint(); </script>
2609<script src="scripts/linenumber.js"> </script>
2610</body>
2611</html>
\No newline at end of file