UNPKG

114 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Class: ServiceObject</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: ServiceObject</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2>ServiceObject</h2>
32
33
34</header>
35
36<article>
37 <div class="container-overview">
38
39
40
41
42
43 <h4 class="name" id="ServiceObject"><span class="type-signature"></span>new ServiceObject<span class="signature">(obj, container)</span><span class="type-signature"></span></h4>
44
45
46
47
48
49<div class="description">
50 The Service 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">A JSON object with the object definition</td>
103 </tr>
104
105
106
107 <tr>
108
109 <td class="name"><code>container</code></td>
110
111
112 <td class="type">
113
114
115<span class="param-type"><a href="Raptor.html">Raptor</a></span>
116
117
118
119 </td>
120
121
122
123
124
125 <td class="description last">reference to the Raptor sdk wrapper</td>
126 </tr>
127
128
129 </tbody>
130</table>
131
132
133
134
135
136
137<dl class="details">
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164 <dt class="tag-source">Source:</dt>
165 <dd class="tag-source"><ul class="dummy"><li>
166 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line20">line 20</a>
167 </li></ul></dd>
168
169
170
171
172
173
174
175</dl>
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193 </div>
194
195
196 <h3 class="subsection-title">Extends</h3>
197
198
199
200
201 <ul>
202 <li><a href="global.html#Container">Container</a></li>
203 </ul>
204
205
206
207
208
209
210
211
212
213
214
215
216
217 <h3 class="subsection-title">Members</h3>
218
219
220
221<h4 class="name" id="getObject"><span class="type-signature"></span>getObject<span class="type-signature"></span></h4>
222
223
224
225
226
227
228
229
230
231
232<dl class="details">
233
234
235
236
237
238
239
240
241 <dt class="tag-overrides">Overrides:</dt>
242 <dd class="tag-overrides"><ul class="dummy"><li>
243 <a href="global.html#Container#getObject">Container#getObject</a>
244 </li></ul></dd>
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264 <dt class="tag-source">Source:</dt>
265 <dd class="tag-source"><ul class="dummy"><li>
266 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line70">line 70</a>
267 </li></ul></dd>
268
269
270
271
272
273
274
275</dl>
276
277
278
279
280
281
282
283
284
285
286 <h3 class="subsection-title">Methods</h3>
287
288
289
290
291
292
293 <h4 class="name" id="action"><span class="type-signature"></span>action<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Action.html">Action</a>}</span></h4>
294
295
296
297
298
299<div class="description">
300 Return an action reference
301</div>
302
303
304
305
306
307
308
309
310
311 <h5>Parameters:</h5>
312
313
314<table class="params">
315 <thead>
316 <tr>
317
318 <th>Name</th>
319
320
321 <th>Type</th>
322
323
324
325
326
327 <th class="last">Description</th>
328 </tr>
329 </thead>
330
331 <tbody>
332
333
334 <tr>
335
336 <td class="name"><code>name</code></td>
337
338
339 <td class="type">
340
341
342<span class="param-type">String</span>
343
344
345
346 </td>
347
348
349
350
351
352 <td class="description last">action name</td>
353 </tr>
354
355
356 </tbody>
357</table>
358
359
360
361
362
363
364<dl class="details">
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391 <dt class="tag-source">Source:</dt>
392 <dd class="tag-source"><ul class="dummy"><li>
393 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line104">line 104</a>
394 </li></ul></dd>
395
396
397
398
399
400
401
402</dl>
403
404
405
406
407
408
409
410
411
412
413
414
415
416<h5>Returns:</h5>
417
418
419<div class="param-desc">
420 action requested action, if available
421</div>
422
423
424
425<dl>
426 <dt>
427 Type
428 </dt>
429 <dd>
430
431<span class="param-type"><a href="Action.html">Action</a></span>
432
433
434 </dd>
435</dl>
436
437
438
439
440
441
442
443
444
445
446 <h4 class="name" id="action"><span class="type-signature"></span>action<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Action.html">Action</a>}</span></h4>
447
448
449
450
451
452<div class="description">
453 Return an action reference
454</div>
455
456
457
458
459
460
461
462
463
464 <h5>Parameters:</h5>
465
466
467<table class="params">
468 <thead>
469 <tr>
470
471 <th>Name</th>
472
473
474 <th>Type</th>
475
476
477
478
479
480 <th class="last">Description</th>
481 </tr>
482 </thead>
483
484 <tbody>
485
486
487 <tr>
488
489 <td class="name"><code>name</code></td>
490
491
492 <td class="type">
493
494
495<span class="param-type">String</span>
496
497
498
499 </td>
500
501
502
503
504
505 <td class="description last">action name</td>
506 </tr>
507
508
509 </tbody>
510</table>
511
512
513
514
515
516
517<dl class="details">
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544 <dt class="tag-source">Source:</dt>
545 <dd class="tag-source"><ul class="dummy"><li>
546 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line104">line 104</a>
547 </li></ul></dd>
548
549
550
551
552
553
554
555</dl>
556
557
558
559
560
561
562
563
564
565
566
567
568
569<h5>Returns:</h5>
570
571
572<div class="param-desc">
573 action requested action, if available
574</div>
575
576
577
578<dl>
579 <dt>
580 Type
581 </dt>
582 <dd>
583
584<span class="param-type"><a href="Action.html">Action</a></span>
585
586
587 </dd>
588</dl>
589
590
591
592
593
594
595
596
597
598
599 <h4 class="name" id="addChild"><span class="type-signature"></span>addChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
600
601
602
603
604
605<div class="description">
606 Add a child
607</div>
608
609
610
611
612
613
614
615
616
617 <h5>Parameters:</h5>
618
619
620<table class="params">
621 <thead>
622 <tr>
623
624 <th>Name</th>
625
626
627 <th>Type</th>
628
629
630
631
632
633 <th class="last">Description</th>
634 </tr>
635 </thead>
636
637 <tbody>
638
639
640 <tr>
641
642 <td class="name"><code>child</code></td>
643
644
645 <td class="type">
646
647
648<span class="param-type"><a href="ServiceObject.html">ServiceObject</a></span>
649
650
651
652 </td>
653
654
655
656
657
658 <td class="description last">The object instance or id to add</td>
659 </tr>
660
661
662 </tbody>
663</table>
664
665
666
667
668
669
670<dl class="details">
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697 <dt class="tag-source">Source:</dt>
698 <dd class="tag-source"><ul class="dummy"><li>
699 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line317">line 317</a>
700 </li></ul></dd>
701
702
703
704
705
706
707
708</dl>
709
710
711
712
713
714
715
716
717
718
719
720
721
722<h5>Returns:</h5>
723
724
725<div class="param-desc">
726 Promise of the request with a the list of children
727</div>
728
729
730
731<dl>
732 <dt>
733 Type
734 </dt>
735 <dd>
736
737<span class="param-type">Promise</span>
738
739
740 </dd>
741</dl>
742
743
744
745
746
747
748
749
750
751
752 <h4 class="name" id="addChild"><span class="type-signature"></span>addChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
753
754
755
756
757
758<div class="description">
759 Add a child
760</div>
761
762
763
764
765
766
767
768
769
770 <h5>Parameters:</h5>
771
772
773<table class="params">
774 <thead>
775 <tr>
776
777 <th>Name</th>
778
779
780 <th>Type</th>
781
782
783
784
785
786 <th class="last">Description</th>
787 </tr>
788 </thead>
789
790 <tbody>
791
792
793 <tr>
794
795 <td class="name"><code>child</code></td>
796
797
798 <td class="type">
799
800
801<span class="param-type"><a href="ServiceObject.html">ServiceObject</a></span>
802
803
804
805 </td>
806
807
808
809
810
811 <td class="description last">The object instance or id to add</td>
812 </tr>
813
814
815 </tbody>
816</table>
817
818
819
820
821
822
823<dl class="details">
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850 <dt class="tag-source">Source:</dt>
851 <dd class="tag-source"><ul class="dummy"><li>
852 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line317">line 317</a>
853 </li></ul></dd>
854
855
856
857
858
859
860
861</dl>
862
863
864
865
866
867
868
869
870
871
872
873
874
875<h5>Returns:</h5>
876
877
878<div class="param-desc">
879 Promise of the request with a the list of children
880</div>
881
882
883
884<dl>
885 <dt>
886 Type
887 </dt>
888 <dd>
889
890<span class="param-type">Promise</span>
891
892
893 </dd>
894</dl>
895
896
897
898
899
900
901
902
903
904
905 <h4 class="name" id="addStream"><span class="type-signature"></span>addStream<span class="signature">(name, definition)</span><span class="type-signature"></span></h4>
906
907
908
909
910
911<div class="description">
912 Add a stream to the object
913</div>
914
915
916
917
918
919
920
921
922
923 <h5>Parameters:</h5>
924
925
926<table class="params">
927 <thead>
928 <tr>
929
930 <th>Name</th>
931
932
933 <th>Type</th>
934
935
936
937
938
939 <th class="last">Description</th>
940 </tr>
941 </thead>
942
943 <tbody>
944
945
946 <tr>
947
948 <td class="name"><code>name</code></td>
949
950
951 <td class="type">
952
953
954<span class="param-type">String</span>
955
956
957
958 </td>
959
960
961
962
963
964 <td class="description last">The stream name</td>
965 </tr>
966
967
968
969 <tr>
970
971 <td class="name"><code>definition</code></td>
972
973
974 <td class="type">
975
976
977<span class="param-type">Object</span>
978
979
980
981 </td>
982
983
984
985
986
987 <td class="description last">The steam definition</td>
988 </tr>
989
990
991 </tbody>
992</table>
993
994
995
996
997
998
999<dl class="details">
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026 <dt class="tag-source">Source:</dt>
1027 <dd class="tag-source"><ul class="dummy"><li>
1028 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line189">line 189</a>
1029 </li></ul></dd>
1030
1031
1032
1033
1034
1035
1036
1037</dl>
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059 <h4 class="name" id="addStream"><span class="type-signature"></span>addStream<span class="signature">(name, definition)</span><span class="type-signature"></span></h4>
1060
1061
1062
1063
1064
1065<div class="description">
1066 Add a stream to the object
1067</div>
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077 <h5>Parameters:</h5>
1078
1079
1080<table class="params">
1081 <thead>
1082 <tr>
1083
1084 <th>Name</th>
1085
1086
1087 <th>Type</th>
1088
1089
1090
1091
1092
1093 <th class="last">Description</th>
1094 </tr>
1095 </thead>
1096
1097 <tbody>
1098
1099
1100 <tr>
1101
1102 <td class="name"><code>name</code></td>
1103
1104
1105 <td class="type">
1106
1107
1108<span class="param-type">String</span>
1109
1110
1111
1112 </td>
1113
1114
1115
1116
1117
1118 <td class="description last">The stream name</td>
1119 </tr>
1120
1121
1122
1123 <tr>
1124
1125 <td class="name"><code>definition</code></td>
1126
1127
1128 <td class="type">
1129
1130
1131<span class="param-type">Object</span>
1132
1133
1134
1135 </td>
1136
1137
1138
1139
1140
1141 <td class="description last">The steam definition</td>
1142 </tr>
1143
1144
1145 </tbody>
1146</table>
1147
1148
1149
1150
1151
1152
1153<dl class="details">
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180 <dt class="tag-source">Source:</dt>
1181 <dd class="tag-source"><ul class="dummy"><li>
1182 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line189">line 189</a>
1183 </li></ul></dd>
1184
1185
1186
1187
1188
1189
1190
1191</dl>
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213 <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1214
1215
1216
1217
1218
1219<div class="description">
1220 Create a new Object instance
1221</div>
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235<dl class="details">
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262 <dt class="tag-source">Source:</dt>
1263 <dd class="tag-source"><ul class="dummy"><li>
1264 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line226">line 226</a>
1265 </li></ul></dd>
1266
1267
1268
1269
1270
1271
1272
1273</dl>
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287<h5>Returns:</h5>
1288
1289
1290<div class="param-desc">
1291 object the newly created reference
1292</div>
1293
1294
1295
1296<dl>
1297 <dt>
1298 Type
1299 </dt>
1300 <dd>
1301
1302<span class="param-type">Promise</span>
1303
1304
1305 </dd>
1306</dl>
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317 <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1318
1319
1320
1321
1322
1323<div class="description">
1324 Create a new Object instance
1325</div>
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339<dl class="details">
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366 <dt class="tag-source">Source:</dt>
1367 <dd class="tag-source"><ul class="dummy"><li>
1368 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line226">line 226</a>
1369 </li></ul></dd>
1370
1371
1372
1373
1374
1375
1376
1377</dl>
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391<h5>Returns:</h5>
1392
1393
1394<div class="param-desc">
1395 object the newly created reference
1396</div>
1397
1398
1399
1400<dl>
1401 <dt>
1402 Type
1403 </dt>
1404 <dd>
1405
1406<span class="param-type">Promise</span>
1407
1408
1409 </dd>
1410</dl>
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421 <h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(Optional,)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1422
1423
1424
1425
1426
1427<div class="description">
1428 Delete a Service Object
1429</div>
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439 <h5>Parameters:</h5>
1440
1441
1442<table class="params">
1443 <thead>
1444 <tr>
1445
1446 <th>Name</th>
1447
1448
1449 <th>Type</th>
1450
1451
1452
1453
1454
1455 <th class="last">Description</th>
1456 </tr>
1457 </thead>
1458
1459 <tbody>
1460
1461
1462 <tr>
1463
1464 <td class="name"><code>Optional,</code></td>
1465
1466
1467 <td class="type">
1468
1469
1470<span class="param-type">String</span>
1471
1472
1473
1474 </td>
1475
1476
1477
1478
1479
1480 <td class="description last">the objectId to delete</td>
1481 </tr>
1482
1483
1484 </tbody>
1485</table>
1486
1487
1488
1489
1490
1491
1492<dl class="details">
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519 <dt class="tag-source">Source:</dt>
1520 <dd class="tag-source"><ul class="dummy"><li>
1521 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line273">line 273</a>
1522 </li></ul></dd>
1523
1524
1525
1526
1527
1528
1529
1530</dl>
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544<h5>Returns:</h5>
1545
1546
1547<div class="param-desc">
1548 Promise of the request with a new empty so as argument
1549</div>
1550
1551
1552
1553<dl>
1554 <dt>
1555 Type
1556 </dt>
1557 <dd>
1558
1559<span class="param-type">Promise</span>
1560
1561
1562 </dd>
1563</dl>
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574 <h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(Optional,)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1575
1576
1577
1578
1579
1580<div class="description">
1581 Delete a Service Object
1582</div>
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592 <h5>Parameters:</h5>
1593
1594
1595<table class="params">
1596 <thead>
1597 <tr>
1598
1599 <th>Name</th>
1600
1601
1602 <th>Type</th>
1603
1604
1605
1606
1607
1608 <th class="last">Description</th>
1609 </tr>
1610 </thead>
1611
1612 <tbody>
1613
1614
1615 <tr>
1616
1617 <td class="name"><code>Optional,</code></td>
1618
1619
1620 <td class="type">
1621
1622
1623<span class="param-type">String</span>
1624
1625
1626
1627 </td>
1628
1629
1630
1631
1632
1633 <td class="description last">the objectId to delete</td>
1634 </tr>
1635
1636
1637 </tbody>
1638</table>
1639
1640
1641
1642
1643
1644
1645<dl class="details">
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672 <dt class="tag-source">Source:</dt>
1673 <dd class="tag-source"><ul class="dummy"><li>
1674 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line273">line 273</a>
1675 </li></ul></dd>
1676
1677
1678
1679
1680
1681
1682
1683</dl>
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697<h5>Returns:</h5>
1698
1699
1700<div class="param-desc">
1701 Promise of the request with a new empty so as argument
1702</div>
1703
1704
1705
1706<dl>
1707 <dt>
1708 Type
1709 </dt>
1710 <dd>
1711
1712<span class="param-type">Promise</span>
1713
1714
1715 </dd>
1716</dl>
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727 <h4 class="name" id="exportProperties"><span class="type-signature"></span>exportProperties<span class="signature">()</span><span class="type-signature"></span></h4>
1728
1729
1730
1731
1732
1733<div class="description">
1734 Exposes setter and getter for a class from the `data` field
1735</div>
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749<dl class="details">
1750
1751
1752
1753
1754
1755
1756
1757
1758 <dt class="tag-overrides">Overrides:</dt>
1759 <dd class="tag-overrides"><ul class="dummy"><li>
1760 <a href="global.html#Container#exportProperties">Container#exportProperties</a>
1761 </li></ul></dd>
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781 <dt class="tag-source">Source:</dt>
1782 <dd class="tag-source"><ul class="dummy"><li>
1783 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line19">line 19</a>
1784 </li></ul></dd>
1785
1786
1787
1788
1789
1790
1791
1792</dl>
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814 <h4 class="name" id="getChildren"><span class="type-signature"></span>getChildren<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1815
1816
1817
1818
1819
1820<div class="description">
1821 Get children
1822</div>
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836<dl class="details">
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863 <dt class="tag-source">Source:</dt>
1864 <dd class="tag-source"><ul class="dummy"><li>
1865 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line287">line 287</a>
1866 </li></ul></dd>
1867
1868
1869
1870
1871
1872
1873
1874</dl>
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888<h5>Returns:</h5>
1889
1890
1891<div class="param-desc">
1892 Promise of the request with a the list of children
1893</div>
1894
1895
1896
1897<dl>
1898 <dt>
1899 Type
1900 </dt>
1901 <dd>
1902
1903<span class="param-type">Promise</span>
1904
1905
1906 </dd>
1907</dl>
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918 <h4 class="name" id="getChildren"><span class="type-signature"></span>getChildren<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1919
1920
1921
1922
1923
1924<div class="description">
1925 Get children
1926</div>
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940<dl class="details">
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967 <dt class="tag-source">Source:</dt>
1968 <dd class="tag-source"><ul class="dummy"><li>
1969 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line287">line 287</a>
1970 </li></ul></dd>
1971
1972
1973
1974
1975
1976
1977
1978</dl>
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992<h5>Returns:</h5>
1993
1994
1995<div class="param-desc">
1996 Promise of the request with a the list of children
1997</div>
1998
1999
2000
2001<dl>
2002 <dt>
2003 Type
2004 </dt>
2005 <dd>
2006
2007<span class="param-type">Promise</span>
2008
2009
2010 </dd>
2011</dl>
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022 <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>
2023
2024
2025
2026
2027
2028<div class="description">
2029 Return the client reference
2030</div>
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044<dl class="details">
2045
2046
2047
2048
2049
2050
2051
2052
2053 <dt class="tag-overrides">Overrides:</dt>
2054 <dd class="tag-overrides"><ul class="dummy"><li>
2055 <a href="global.html#Container#getClient">Container#getClient</a>
2056 </li></ul></dd>
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076 <dt class="tag-source">Source:</dt>
2077 <dd class="tag-source"><ul class="dummy"><li>
2078 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line37">line 37</a>
2079 </li></ul></dd>
2080
2081
2082
2083
2084
2085
2086
2087</dl>
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101<h5>Returns:</h5>
2102
2103
2104<div class="param-desc">
2105 client
2106</div>
2107
2108
2109
2110<dl>
2111 <dt>
2112 Type
2113 </dt>
2114 <dd>
2115
2116<span class="param-type"><a href="Client.html">Client</a></span>
2117
2118
2119 </dd>
2120</dl>
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131 <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>
2132
2133
2134
2135
2136
2137<div class="description">
2138 Return the Raptor instance wrapper
2139</div>
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153<dl class="details">
2154
2155
2156
2157
2158
2159
2160
2161
2162 <dt class="tag-overrides">Overrides:</dt>
2163 <dd class="tag-overrides"><ul class="dummy"><li>
2164 <a href="global.html#Container#getContainer">Container#getContainer</a>
2165 </li></ul></dd>
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185 <dt class="tag-source">Source:</dt>
2186 <dd class="tag-source"><ul class="dummy"><li>
2187 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line45">line 45</a>
2188 </li></ul></dd>
2189
2190
2191
2192
2193
2194
2195
2196</dl>
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210<h5>Returns:</h5>
2211
2212
2213<div class="param-desc">
2214 container Raptor instance reference
2215</div>
2216
2217
2218
2219<dl>
2220 <dt>
2221 Type
2222 </dt>
2223 <dd>
2224
2225<span class="param-type"><a href="Raptor.html">Raptor</a></span>
2226
2227
2228 </dd>
2229</dl>
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240 <h4 class="name" id="getCreatedAt"><span class="type-signature"></span>getCreatedAt<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></h4>
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258<dl class="details">
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285 <dt class="tag-source">Source:</dt>
2286 <dd class="tag-source"><ul class="dummy"><li>
2287 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line84">line 84</a>
2288 </li></ul></dd>
2289
2290
2291
2292
2293
2294
2295
2296</dl>
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310<h5>Returns:</h5>
2311
2312
2313<div class="param-desc">
2314 createdAt The creation date as unix timestamp
2315</div>
2316
2317
2318
2319<dl>
2320 <dt>
2321 Type
2322 </dt>
2323 <dd>
2324
2325<span class="param-type">Number</span>
2326
2327
2328 </dd>
2329</dl>
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340 <h4 class="name" id="getCreatedAt"><span class="type-signature"></span>getCreatedAt<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></h4>
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358<dl class="details">
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385 <dt class="tag-source">Source:</dt>
2386 <dd class="tag-source"><ul class="dummy"><li>
2387 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line84">line 84</a>
2388 </li></ul></dd>
2389
2390
2391
2392
2393
2394
2395
2396</dl>
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410<h5>Returns:</h5>
2411
2412
2413<div class="param-desc">
2414 createdAt The creation date as unix timestamp
2415</div>
2416
2417
2418
2419<dl>
2420 <dt>
2421 Type
2422 </dt>
2423 <dd>
2424
2425<span class="param-type">Number</span>
2426
2427
2428 </dd>
2429</dl>
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440 <h4 class="name" id="getId"><span class="type-signature"></span>getId<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458<dl class="details">
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485 <dt class="tag-source">Source:</dt>
2486 <dd class="tag-source"><ul class="dummy"><li>
2487 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line77">line 77</a>
2488 </li></ul></dd>
2489
2490
2491
2492
2493
2494
2495
2496</dl>
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510<h5>Returns:</h5>
2511
2512
2513<div class="param-desc">
2514 id The object id
2515</div>
2516
2517
2518
2519<dl>
2520 <dt>
2521 Type
2522 </dt>
2523 <dd>
2524
2525<span class="param-type">String</span>
2526
2527
2528 </dd>
2529</dl>
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540 <h4 class="name" id="getId"><span class="type-signature"></span>getId<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558<dl class="details">
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585 <dt class="tag-source">Source:</dt>
2586 <dd class="tag-source"><ul class="dummy"><li>
2587 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line77">line 77</a>
2588 </li></ul></dd>
2589
2590
2591
2592
2593
2594
2595
2596</dl>
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610<h5>Returns:</h5>
2611
2612
2613<div class="param-desc">
2614 id The object id
2615</div>
2616
2617
2618
2619<dl>
2620 <dt>
2621 Type
2622 </dt>
2623 <dd>
2624
2625<span class="param-type">String</span>
2626
2627
2628 </dd>
2629</dl>
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640 <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">(id)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
2641
2642
2643
2644
2645
2646<div class="description">
2647 Load the Object definition
2648</div>
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658 <h5>Parameters:</h5>
2659
2660
2661<table class="params">
2662 <thead>
2663 <tr>
2664
2665 <th>Name</th>
2666
2667
2668 <th>Type</th>
2669
2670
2671
2672
2673
2674 <th class="last">Description</th>
2675 </tr>
2676 </thead>
2677
2678 <tbody>
2679
2680
2681 <tr>
2682
2683 <td class="name"><code>id</code></td>
2684
2685
2686 <td class="type">
2687
2688
2689<span class="param-type">String</span>
2690
2691
2692
2693 </td>
2694
2695
2696
2697
2698
2699 <td class="description last">The object Id</td>
2700 </tr>
2701
2702
2703 </tbody>
2704</table>
2705
2706
2707
2708
2709
2710
2711<dl class="details">
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738 <dt class="tag-source">Source:</dt>
2739 <dd class="tag-source"><ul class="dummy"><li>
2740 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line244">line 244</a>
2741 </li></ul></dd>
2742
2743
2744
2745
2746
2747
2748
2749</dl>
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763<h5>Returns:</h5>
2764
2765
2766<div class="param-desc">
2767 Promise of the request with the ServiceObject as argument
2768</div>
2769
2770
2771
2772<dl>
2773 <dt>
2774 Type
2775 </dt>
2776 <dd>
2777
2778<span class="param-type">Promise</span>
2779
2780
2781 </dd>
2782</dl>
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793 <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">(id)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
2794
2795
2796
2797
2798
2799<div class="description">
2800 Load the Object definition
2801</div>
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811 <h5>Parameters:</h5>
2812
2813
2814<table class="params">
2815 <thead>
2816 <tr>
2817
2818 <th>Name</th>
2819
2820
2821 <th>Type</th>
2822
2823
2824
2825
2826
2827 <th class="last">Description</th>
2828 </tr>
2829 </thead>
2830
2831 <tbody>
2832
2833
2834 <tr>
2835
2836 <td class="name"><code>id</code></td>
2837
2838
2839 <td class="type">
2840
2841
2842<span class="param-type">String</span>
2843
2844
2845
2846 </td>
2847
2848
2849
2850
2851
2852 <td class="description last">The object Id</td>
2853 </tr>
2854
2855
2856 </tbody>
2857</table>
2858
2859
2860
2861
2862
2863
2864<dl class="details">
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891 <dt class="tag-source">Source:</dt>
2892 <dd class="tag-source"><ul class="dummy"><li>
2893 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line244">line 244</a>
2894 </li></ul></dd>
2895
2896
2897
2898
2899
2900
2901
2902</dl>
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916<h5>Returns:</h5>
2917
2918
2919<div class="param-desc">
2920 Promise of the request with the ServiceObject as argument
2921</div>
2922
2923
2924
2925<dl>
2926 <dt>
2927 Type
2928 </dt>
2929 <dd>
2930
2931<span class="param-type">Promise</span>
2932
2933
2934 </dd>
2935</dl>
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946 <h4 class="name" id="parseJSON"><span class="type-signature"></span>parseJSON<span class="signature">(raw)</span><span class="type-signature"></span></h4>
2947
2948
2949
2950
2951
2952<div class="description">
2953 Parse a plain object and populate the corresponding fields in the current instance
2954</div>
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964 <h5>Parameters:</h5>
2965
2966
2967<table class="params">
2968 <thead>
2969 <tr>
2970
2971 <th>Name</th>
2972
2973
2974 <th>Type</th>
2975
2976
2977
2978
2979
2980 <th class="last">Description</th>
2981 </tr>
2982 </thead>
2983
2984 <tbody>
2985
2986
2987 <tr>
2988
2989 <td class="name"><code>raw</code></td>
2990
2991
2992 <td class="type">
2993
2994
2995<span class="param-type">Object</span>
2996
2997
2998
2999 </td>
3000
3001
3002
3003
3004
3005 <td class="description last">the json object</td>
3006 </tr>
3007
3008
3009 </tbody>
3010</table>
3011
3012
3013
3014
3015
3016
3017<dl class="details">
3018
3019
3020
3021
3022
3023
3024
3025
3026 <dt class="tag-overrides">Overrides:</dt>
3027 <dd class="tag-overrides"><ul class="dummy"><li>
3028 <a href="global.html#Container#parseJSON">Container#parseJSON</a>
3029 </li></ul></dd>
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049 <dt class="tag-source">Source:</dt>
3050 <dd class="tag-source"><ul class="dummy"><li>
3051 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line127">line 127</a>
3052 </li></ul></dd>
3053
3054
3055
3056
3057
3058
3059
3060</dl>
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082 <h4 class="name" id="removeChild"><span class="type-signature"></span>removeChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
3083
3084
3085
3086
3087
3088<div class="description">
3089 Remove a child
3090</div>
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100 <h5>Parameters:</h5>
3101
3102
3103<table class="params">
3104 <thead>
3105 <tr>
3106
3107 <th>Name</th>
3108
3109
3110 <th>Type</th>
3111
3112
3113
3114
3115
3116 <th class="last">Description</th>
3117 </tr>
3118 </thead>
3119
3120 <tbody>
3121
3122
3123 <tr>
3124
3125 <td class="name"><code>child</code></td>
3126
3127
3128 <td class="type">
3129
3130
3131<span class="param-type"><a href="ServiceObject.html">ServiceObject</a></span>
3132
3133
3134
3135 </td>
3136
3137
3138
3139
3140
3141 <td class="description last">The object instance or id to remove</td>
3142 </tr>
3143
3144
3145 </tbody>
3146</table>
3147
3148
3149
3150
3151
3152
3153<dl class="details">
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180 <dt class="tag-source">Source:</dt>
3181 <dd class="tag-source"><ul class="dummy"><li>
3182 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line340">line 340</a>
3183 </li></ul></dd>
3184
3185
3186
3187
3188
3189
3190
3191</dl>
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205<h5>Returns:</h5>
3206
3207
3208<div class="param-desc">
3209 Promise of the request with a the list of children
3210</div>
3211
3212
3213
3214<dl>
3215 <dt>
3216 Type
3217 </dt>
3218 <dd>
3219
3220<span class="param-type">Promise</span>
3221
3222
3223 </dd>
3224</dl>
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235 <h4 class="name" id="removeChild"><span class="type-signature"></span>removeChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
3236
3237
3238
3239
3240
3241<div class="description">
3242 Remove a child
3243</div>
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253 <h5>Parameters:</h5>
3254
3255
3256<table class="params">
3257 <thead>
3258 <tr>
3259
3260 <th>Name</th>
3261
3262
3263 <th>Type</th>
3264
3265
3266
3267
3268
3269 <th class="last">Description</th>
3270 </tr>
3271 </thead>
3272
3273 <tbody>
3274
3275
3276 <tr>
3277
3278 <td class="name"><code>child</code></td>
3279
3280
3281 <td class="type">
3282
3283
3284<span class="param-type"><a href="ServiceObject.html">ServiceObject</a></span>
3285
3286
3287
3288 </td>
3289
3290
3291
3292
3293
3294 <td class="description last">The object instance or id to remove</td>
3295 </tr>
3296
3297
3298 </tbody>
3299</table>
3300
3301
3302
3303
3304
3305
3306<dl class="details">
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333 <dt class="tag-source">Source:</dt>
3334 <dd class="tag-source"><ul class="dummy"><li>
3335 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line340">line 340</a>
3336 </li></ul></dd>
3337
3338
3339
3340
3341
3342
3343
3344</dl>
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358<h5>Returns:</h5>
3359
3360
3361<div class="param-desc">
3362 Promise of the request with a the list of children
3363</div>
3364
3365
3366
3367<dl>
3368 <dt>
3369 Type
3370 </dt>
3371 <dd>
3372
3373<span class="param-type">Promise</span>
3374
3375
3376 </dd>
3377</dl>
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388 <h4 class="name" id="setActions"><span class="type-signature"></span>setActions<span class="signature">(actions)</span><span class="type-signature"></span></h4>
3389
3390
3391
3392
3393
3394<div class="description">
3395 Set actions to the object
3396</div>
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406 <h5>Parameters:</h5>
3407
3408
3409<table class="params">
3410 <thead>
3411 <tr>
3412
3413 <th>Name</th>
3414
3415
3416 <th>Type</th>
3417
3418
3419
3420
3421
3422 <th class="last">Description</th>
3423 </tr>
3424 </thead>
3425
3426 <tbody>
3427
3428
3429 <tr>
3430
3431 <td class="name"><code>actions</code></td>
3432
3433
3434 <td class="type">
3435
3436
3437<span class="param-type">Array</span>
3438
3439
3440
3441 </td>
3442
3443
3444
3445
3446
3447 <td class="description last">The list of actions to set</td>
3448 </tr>
3449
3450
3451 </tbody>
3452</table>
3453
3454
3455
3456
3457
3458
3459<dl class="details">
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486 <dt class="tag-source">Source:</dt>
3487 <dd class="tag-source"><ul class="dummy"><li>
3488 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line160">line 160</a>
3489 </li></ul></dd>
3490
3491
3492
3493
3494
3495
3496
3497</dl>
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519 <h4 class="name" id="setActions"><span class="type-signature"></span>setActions<span class="signature">(actions)</span><span class="type-signature"></span></h4>
3520
3521
3522
3523
3524
3525<div class="description">
3526 Set actions to the object
3527</div>
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537 <h5>Parameters:</h5>
3538
3539
3540<table class="params">
3541 <thead>
3542 <tr>
3543
3544 <th>Name</th>
3545
3546
3547 <th>Type</th>
3548
3549
3550
3551
3552
3553 <th class="last">Description</th>
3554 </tr>
3555 </thead>
3556
3557 <tbody>
3558
3559
3560 <tr>
3561
3562 <td class="name"><code>actions</code></td>
3563
3564
3565 <td class="type">
3566
3567
3568<span class="param-type">Array</span>
3569
3570
3571
3572 </td>
3573
3574
3575
3576
3577
3578 <td class="description last">The list of actions to set</td>
3579 </tr>
3580
3581
3582 </tbody>
3583</table>
3584
3585
3586
3587
3588
3589
3590<dl class="details">
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617 <dt class="tag-source">Source:</dt>
3618 <dd class="tag-source"><ul class="dummy"><li>
3619 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line160">line 160</a>
3620 </li></ul></dd>
3621
3622
3623
3624
3625
3626
3627
3628</dl>
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650 <h4 class="name" id="setChildren"><span class="type-signature"></span>setChildren<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
3651
3652
3653
3654
3655
3656<div class="description">
3657 Set children
3658</div>
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672<dl class="details">
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699 <dt class="tag-source">Source:</dt>
3700 <dd class="tag-source"><ul class="dummy"><li>
3701 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line303">line 303</a>
3702 </li></ul></dd>
3703
3704
3705
3706
3707
3708
3709
3710</dl>
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724<h5>Returns:</h5>
3725
3726
3727<div class="param-desc">
3728 Promise of the request with a the list of children
3729</div>
3730
3731
3732
3733<dl>
3734 <dt>
3735 Type
3736 </dt>
3737 <dd>
3738
3739<span class="param-type">Promise</span>
3740
3741
3742 </dd>
3743</dl>
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754 <h4 class="name" id="setChildren"><span class="type-signature"></span>setChildren<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
3755
3756
3757
3758
3759
3760<div class="description">
3761 Set children
3762</div>
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776<dl class="details">
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803 <dt class="tag-source">Source:</dt>
3804 <dd class="tag-source"><ul class="dummy"><li>
3805 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line303">line 303</a>
3806 </li></ul></dd>
3807
3808
3809
3810
3811
3812
3813
3814</dl>
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828<h5>Returns:</h5>
3829
3830
3831<div class="param-desc">
3832 Promise of the request with a the list of children
3833</div>
3834
3835
3836
3837<dl>
3838 <dt>
3839 Type
3840 </dt>
3841 <dd>
3842
3843<span class="param-type">Promise</span>
3844
3845
3846 </dd>
3847</dl>
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858 <h4 class="name" id="setContainer"><span class="type-signature"></span>setContainer<span class="signature">(container)</span><span class="type-signature"></span></h4>
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872 <h5>Parameters:</h5>
3873
3874
3875<table class="params">
3876 <thead>
3877 <tr>
3878
3879 <th>Name</th>
3880
3881
3882 <th>Type</th>
3883
3884
3885
3886
3887
3888 <th class="last">Description</th>
3889 </tr>
3890 </thead>
3891
3892 <tbody>
3893
3894
3895 <tr>
3896
3897 <td class="name"><code>container</code></td>
3898
3899
3900 <td class="type">
3901
3902
3903<span class="param-type"><a href="Raptor.html">Raptor</a></span>
3904
3905
3906
3907 </td>
3908
3909
3910
3911
3912
3913 <td class="description last">reference to Raptor instance wrapper</td>
3914 </tr>
3915
3916
3917 </tbody>
3918</table>
3919
3920
3921
3922
3923
3924
3925<dl class="details">
3926
3927
3928
3929
3930
3931
3932
3933
3934 <dt class="tag-overrides">Overrides:</dt>
3935 <dd class="tag-overrides"><ul class="dummy"><li>
3936 <a href="global.html#Container#setContainer">Container#setContainer</a>
3937 </li></ul></dd>
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957 <dt class="tag-source">Source:</dt>
3958 <dd class="tag-source"><ul class="dummy"><li>
3959 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line52">line 52</a>
3960 </li></ul></dd>
3961
3962
3963
3964
3965
3966
3967
3968</dl>
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990 <h4 class="name" id="setServiceObject"><span class="type-signature"></span>setServiceObject<span class="signature">(object)</span><span class="type-signature"></span></h4>
3991
3992
3993
3994
3995
3996<div class="description">
3997 Set a reference to the parent object
3998</div>
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008 <h5>Parameters:</h5>
4009
4010
4011<table class="params">
4012 <thead>
4013 <tr>
4014
4015 <th>Name</th>
4016
4017
4018 <th>Type</th>
4019
4020
4021
4022
4023
4024 <th class="last">Description</th>
4025 </tr>
4026 </thead>
4027
4028 <tbody>
4029
4030
4031 <tr>
4032
4033 <td class="name"><code>object</code></td>
4034
4035
4036 <td class="type">
4037
4038
4039<span class="param-type"><a href="ServiceObject.html">ServiceObject</a></span>
4040
4041
4042
4043 </td>
4044
4045
4046
4047
4048
4049 <td class="description last">reference to the parent object</td>
4050 </tr>
4051
4052
4053 </tbody>
4054</table>
4055
4056
4057
4058
4059
4060
4061<dl class="details">
4062
4063
4064
4065
4066
4067
4068
4069
4070 <dt class="tag-overrides">Overrides:</dt>
4071 <dd class="tag-overrides"><ul class="dummy"><li>
4072 <a href="global.html#Container#setServiceObject">Container#setServiceObject</a>
4073 </li></ul></dd>
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093 <dt class="tag-source">Source:</dt>
4094 <dd class="tag-source"><ul class="dummy"><li>
4095 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line60">line 60</a>
4096 </li></ul></dd>
4097
4098
4099
4100
4101
4102
4103
4104</dl>
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126 <h4 class="name" id="setStreams"><span class="type-signature"></span>setStreams<span class="signature">(streams)</span><span class="type-signature"></span></h4>
4127
4128
4129
4130
4131
4132<div class="description">
4133 Set streams to the object
4134</div>
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144 <h5>Parameters:</h5>
4145
4146
4147<table class="params">
4148 <thead>
4149 <tr>
4150
4151 <th>Name</th>
4152
4153
4154 <th>Type</th>
4155
4156
4157
4158
4159
4160 <th class="last">Description</th>
4161 </tr>
4162 </thead>
4163
4164 <tbody>
4165
4166
4167 <tr>
4168
4169 <td class="name"><code>streams</code></td>
4170
4171
4172 <td class="type">
4173
4174
4175<span class="param-type">Array</span>
4176
4177
4178
4179 </td>
4180
4181
4182
4183
4184
4185 <td class="description last">The list of streams to set</td>
4186 </tr>
4187
4188
4189 </tbody>
4190</table>
4191
4192
4193
4194
4195
4196
4197<dl class="details">
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224 <dt class="tag-source">Source:</dt>
4225 <dd class="tag-source"><ul class="dummy"><li>
4226 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line210">line 210</a>
4227 </li></ul></dd>
4228
4229
4230
4231
4232
4233
4234
4235</dl>
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257 <h4 class="name" id="setStreams"><span class="type-signature"></span>setStreams<span class="signature">(streams)</span><span class="type-signature"></span></h4>
4258
4259
4260
4261
4262
4263<div class="description">
4264 Set streams to the object
4265</div>
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275 <h5>Parameters:</h5>
4276
4277
4278<table class="params">
4279 <thead>
4280 <tr>
4281
4282 <th>Name</th>
4283
4284
4285 <th>Type</th>
4286
4287
4288
4289
4290
4291 <th class="last">Description</th>
4292 </tr>
4293 </thead>
4294
4295 <tbody>
4296
4297
4298 <tr>
4299
4300 <td class="name"><code>streams</code></td>
4301
4302
4303 <td class="type">
4304
4305
4306<span class="param-type">Array</span>
4307
4308
4309
4310 </td>
4311
4312
4313
4314
4315
4316 <td class="description last">The list of streams to set</td>
4317 </tr>
4318
4319
4320 </tbody>
4321</table>
4322
4323
4324
4325
4326
4327
4328<dl class="details">
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355 <dt class="tag-source">Source:</dt>
4356 <dd class="tag-source"><ul class="dummy"><li>
4357 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line210">line 210</a>
4358 </li></ul></dd>
4359
4360
4361
4362
4363
4364
4365
4366</dl>
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388 <h4 class="name" id="stream"><span class="type-signature"></span>stream<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Stream.html">Stream</a>}</span></h4>
4389
4390
4391
4392
4393
4394<div class="description">
4395 Return a stream reference
4396</div>
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406 <h5>Parameters:</h5>
4407
4408
4409<table class="params">
4410 <thead>
4411 <tr>
4412
4413 <th>Name</th>
4414
4415
4416 <th>Type</th>
4417
4418
4419
4420
4421
4422 <th class="last">Description</th>
4423 </tr>
4424 </thead>
4425
4426 <tbody>
4427
4428
4429 <tr>
4430
4431 <td class="name"><code>name</code></td>
4432
4433
4434 <td class="type">
4435
4436
4437<span class="param-type">String</span>
4438
4439
4440
4441 </td>
4442
4443
4444
4445
4446
4447 <td class="description last">stream name</td>
4448 </tr>
4449
4450
4451 </tbody>
4452</table>
4453
4454
4455
4456
4457
4458
4459<dl class="details">
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486 <dt class="tag-source">Source:</dt>
4487 <dd class="tag-source"><ul class="dummy"><li>
4488 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line94">line 94</a>
4489 </li></ul></dd>
4490
4491
4492
4493
4494
4495
4496
4497</dl>
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511<h5>Returns:</h5>
4512
4513
4514<div class="param-desc">
4515 stream requested stream, if available
4516</div>
4517
4518
4519
4520<dl>
4521 <dt>
4522 Type
4523 </dt>
4524 <dd>
4525
4526<span class="param-type"><a href="Stream.html">Stream</a></span>
4527
4528
4529 </dd>
4530</dl>
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541 <h4 class="name" id="stream"><span class="type-signature"></span>stream<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Stream.html">Stream</a>}</span></h4>
4542
4543
4544
4545
4546
4547<div class="description">
4548 Return a stream reference
4549</div>
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559 <h5>Parameters:</h5>
4560
4561
4562<table class="params">
4563 <thead>
4564 <tr>
4565
4566 <th>Name</th>
4567
4568
4569 <th>Type</th>
4570
4571
4572
4573
4574
4575 <th class="last">Description</th>
4576 </tr>
4577 </thead>
4578
4579 <tbody>
4580
4581
4582 <tr>
4583
4584 <td class="name"><code>name</code></td>
4585
4586
4587 <td class="type">
4588
4589
4590<span class="param-type">String</span>
4591
4592
4593
4594 </td>
4595
4596
4597
4598
4599
4600 <td class="description last">stream name</td>
4601 </tr>
4602
4603
4604 </tbody>
4605</table>
4606
4607
4608
4609
4610
4611
4612<dl class="details">
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639 <dt class="tag-source">Source:</dt>
4640 <dd class="tag-source"><ul class="dummy"><li>
4641 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line94">line 94</a>
4642 </li></ul></dd>
4643
4644
4645
4646
4647
4648
4649
4650</dl>
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664<h5>Returns:</h5>
4665
4666
4667<div class="param-desc">
4668 stream requested stream, if available
4669</div>
4670
4671
4672
4673<dl>
4674 <dt>
4675 Type
4676 </dt>
4677 <dd>
4678
4679<span class="param-type"><a href="Stream.html">Stream</a></span>
4680
4681
4682 </dd>
4683</dl>
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694 <h4 class="name" id="subscribe"><span class="type-signature"></span>subscribe<span class="signature">(cb)</span><span class="type-signature"> &rarr; {EventEmitter}</span></h4>
4695
4696
4697
4698
4699
4700<div class="description">
4701 Subscribe for Service Object updates
4702</div>
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712 <h5>Parameters:</h5>
4713
4714
4715<table class="params">
4716 <thead>
4717 <tr>
4718
4719 <th>Name</th>
4720
4721
4722 <th>Type</th>
4723
4724
4725
4726
4727
4728 <th class="last">Description</th>
4729 </tr>
4730 </thead>
4731
4732 <tbody>
4733
4734
4735 <tr>
4736
4737 <td class="name"><code>cb</code></td>
4738
4739
4740 <td class="type">
4741
4742
4743<span class="param-type"><a href="global.html#ServiceObjectOnEvent">ServiceObjectOnEvent</a></span>
4744
4745
4746
4747 </td>
4748
4749
4750
4751
4752
4753 <td class="description last">The callback that handles an event notification</td>
4754 </tr>
4755
4756
4757 </tbody>
4758</table>
4759
4760
4761
4762
4763
4764
4765<dl class="details">
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792 <dt class="tag-source">Source:</dt>
4793 <dd class="tag-source"><ul class="dummy"><li>
4794 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line365">line 365</a>
4795 </li></ul></dd>
4796
4797
4798
4799
4800
4801
4802
4803</dl>
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817<h5>Returns:</h5>
4818
4819
4820<div class="param-desc">
4821 An emitter that will notify of updates
4822</div>
4823
4824
4825
4826<dl>
4827 <dt>
4828 Type
4829 </dt>
4830 <dd>
4831
4832<span class="param-type">EventEmitter</span>
4833
4834
4835 </dd>
4836</dl>
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847 <h4 class="name" id="subscribe"><span class="type-signature"></span>subscribe<span class="signature">(cb)</span><span class="type-signature"> &rarr; {EventEmitter}</span></h4>
4848
4849
4850
4851
4852
4853<div class="description">
4854 Subscribe for Service Object updates
4855</div>
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865 <h5>Parameters:</h5>
4866
4867
4868<table class="params">
4869 <thead>
4870 <tr>
4871
4872 <th>Name</th>
4873
4874
4875 <th>Type</th>
4876
4877
4878
4879
4880
4881 <th class="last">Description</th>
4882 </tr>
4883 </thead>
4884
4885 <tbody>
4886
4887
4888 <tr>
4889
4890 <td class="name"><code>cb</code></td>
4891
4892
4893 <td class="type">
4894
4895
4896<span class="param-type"><a href="global.html#ServiceObjectOnEvent">ServiceObjectOnEvent</a></span>
4897
4898
4899
4900 </td>
4901
4902
4903
4904
4905
4906 <td class="description last">The callback that handles an event notification</td>
4907 </tr>
4908
4909
4910 </tbody>
4911</table>
4912
4913
4914
4915
4916
4917
4918<dl class="details">
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945 <dt class="tag-source">Source:</dt>
4946 <dd class="tag-source"><ul class="dummy"><li>
4947 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line365">line 365</a>
4948 </li></ul></dd>
4949
4950
4951
4952
4953
4954
4955
4956</dl>
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970<h5>Returns:</h5>
4971
4972
4973<div class="param-desc">
4974 An emitter that will notify of updates
4975</div>
4976
4977
4978
4979<dl>
4980 <dt>
4981 Type
4982 </dt>
4983 <dd>
4984
4985<span class="param-type">EventEmitter</span>
4986
4987
4988 </dd>
4989</dl>
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000 <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
5001
5002
5003
5004
5005
5006<div class="description">
5007 Convert the instance to a js object
5008</div>
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022<dl class="details">
5023
5024
5025
5026
5027
5028
5029
5030
5031 <dt class="tag-overrides">Overrides:</dt>
5032 <dd class="tag-overrides"><ul class="dummy"><li>
5033 <a href="global.html#Container#toJSON">Container#toJSON</a>
5034 </li></ul></dd>
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054 <dt class="tag-source">Source:</dt>
5055 <dd class="tag-source"><ul class="dummy"><li>
5056 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line86">line 86</a>
5057 </li></ul></dd>
5058
5059
5060
5061
5062
5063
5064
5065</dl>
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079<h5>Returns:</h5>
5080
5081
5082<div class="param-desc">
5083 Plain js object
5084</div>
5085
5086
5087
5088<dl>
5089 <dt>
5090 Type
5091 </dt>
5092 <dd>
5093
5094<span class="param-type">Object</span>
5095
5096
5097 </dd>
5098</dl>
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109 <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
5110
5111
5112
5113
5114
5115<div class="description">
5116 Return a JSON string of this object
5117</div>
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131<dl class="details">
5132
5133
5134
5135
5136
5137
5138
5139
5140 <dt class="tag-overrides">Overrides:</dt>
5141 <dd class="tag-overrides"><ul class="dummy"><li>
5142 <a href="global.html#Container#toString">Container#toString</a>
5143 </li></ul></dd>
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163 <dt class="tag-source">Source:</dt>
5164 <dd class="tag-source"><ul class="dummy"><li>
5165 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line119">line 119</a>
5166 </li></ul></dd>
5167
5168
5169
5170
5171
5172
5173
5174</dl>
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188<h5>Returns:</h5>
5189
5190
5191<div class="param-desc">
5192 json stringified JSON
5193</div>
5194
5195
5196
5197<dl>
5198 <dt>
5199 Type
5200 </dt>
5201 <dd>
5202
5203<span class="param-type">String</span>
5204
5205
5206 </dd>
5207</dl>
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218 <h4 class="name" id="unsubscribe"><span class="type-signature"></span>unsubscribe<span class="signature">()</span><span class="type-signature"></span></h4>
5219
5220
5221
5222
5223
5224<div class="description">
5225 Unsubscribe from Service Object updates
5226</div>
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240<dl class="details">
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267 <dt class="tag-source">Source:</dt>
5268 <dd class="tag-source"><ul class="dummy"><li>
5269 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line377">line 377</a>
5270 </li></ul></dd>
5271
5272
5273
5274
5275
5276
5277
5278</dl>
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300 <h4 class="name" id="unsubscribe"><span class="type-signature"></span>unsubscribe<span class="signature">()</span><span class="type-signature"></span></h4>
5301
5302
5303
5304
5305
5306<div class="description">
5307 Unsubscribe from Service Object updates
5308</div>
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322<dl class="details">
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349 <dt class="tag-source">Source:</dt>
5350 <dd class="tag-source"><ul class="dummy"><li>
5351 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line377">line 377</a>
5352 </li></ul></dd>
5353
5354
5355
5356
5357
5358
5359
5360</dl>
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382 <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
5383
5384
5385
5386
5387
5388<div class="description">
5389 Update an Object
5390</div>
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404<dl class="details">
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431 <dt class="tag-source">Source:</dt>
5432 <dd class="tag-source"><ul class="dummy"><li>
5433 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line258">line 258</a>
5434 </li></ul></dd>
5435
5436
5437
5438
5439
5440
5441
5442</dl>
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456<h5>Returns:</h5>
5457
5458
5459<div class="param-desc">
5460 Promise of the request with the ServiceObject as argument
5461</div>
5462
5463
5464
5465<dl>
5466 <dt>
5467 Type
5468 </dt>
5469 <dd>
5470
5471<span class="param-type">Promise</span>
5472
5473
5474 </dd>
5475</dl>
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486 <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
5487
5488
5489
5490
5491
5492<div class="description">
5493 Update an Object
5494</div>
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508<dl class="details">
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535 <dt class="tag-source">Source:</dt>
5536 <dd class="tag-source"><ul class="dummy"><li>
5537 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line258">line 258</a>
5538 </li></ul></dd>
5539
5540
5541
5542
5543
5544
5545
5546</dl>
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560<h5>Returns:</h5>
5561
5562
5563<div class="param-desc">
5564 Promise of the request with the ServiceObject as argument
5565</div>
5566
5567
5568
5569<dl>
5570 <dt>
5571 Type
5572 </dt>
5573 <dd>
5574
5575<span class="param-type">Promise</span>
5576
5577
5578 </dd>
5579</dl>
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590 <h4 class="name" id="validate"><span class="type-signature"></span>validate<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span></h4>
5591
5592
5593
5594
5595
5596<div class="description">
5597 Validate the object and throw an exception if fails
5598</div>
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612<dl class="details">
5613
5614
5615
5616
5617
5618
5619
5620
5621 <dt class="tag-overrides">Overrides:</dt>
5622 <dd class="tag-overrides"><ul class="dummy"><li>
5623 <a href="global.html#Container#validate">Container#validate</a>
5624 </li></ul></dd>
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644 <dt class="tag-source">Source:</dt>
5645 <dd class="tag-source"><ul class="dummy"><li>
5646 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line78">line 78</a>
5647 </li></ul></dd>
5648
5649
5650
5651
5652
5653
5654
5655</dl>
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669<h5>Returns:</h5>
5670
5671
5672
5673
5674<dl>
5675 <dt>
5676 Type
5677 </dt>
5678 <dd>
5679
5680<span class="param-type">void</span>
5681
5682
5683 </dd>
5684</dl>
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696</article>
5697
5698</section>
5699
5700
5701
5702
5703
5704
5705
5706<section>
5707
5708<header>
5709
5710 <h2>ServiceObject</h2>
5711
5712
5713</header>
5714
5715<article>
5716 <div class="container-overview">
5717
5718
5719
5720
5721
5722 <h4 class="name" id="ServiceObject"><span class="type-signature"></span>new ServiceObject<span class="signature">(obj, container)</span><span class="type-signature"></span></h4>
5723
5724
5725
5726
5727
5728<div class="description">
5729 The Service Object
5730</div>
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740 <h5>Parameters:</h5>
5741
5742
5743<table class="params">
5744 <thead>
5745 <tr>
5746
5747 <th>Name</th>
5748
5749
5750 <th>Type</th>
5751
5752
5753
5754
5755
5756 <th class="last">Description</th>
5757 </tr>
5758 </thead>
5759
5760 <tbody>
5761
5762
5763 <tr>
5764
5765 <td class="name"><code>obj</code></td>
5766
5767
5768 <td class="type">
5769
5770
5771<span class="param-type">Object</span>
5772
5773
5774
5775 </td>
5776
5777
5778
5779
5780
5781 <td class="description last">A JSON object with the object definition</td>
5782 </tr>
5783
5784
5785
5786 <tr>
5787
5788 <td class="name"><code>container</code></td>
5789
5790
5791 <td class="type">
5792
5793
5794<span class="param-type"><a href="Raptor.html">Raptor</a></span>
5795
5796
5797
5798 </td>
5799
5800
5801
5802
5803
5804 <td class="description last">reference to the Raptor sdk wrapper</td>
5805 </tr>
5806
5807
5808 </tbody>
5809</table>
5810
5811
5812
5813
5814
5815
5816<dl class="details">
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843 <dt class="tag-source">Source:</dt>
5844 <dd class="tag-source"><ul class="dummy"><li>
5845 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line20">line 20</a>
5846 </li></ul></dd>
5847
5848
5849
5850
5851
5852
5853
5854</dl>
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872 </div>
5873
5874
5875 <h3 class="subsection-title">Extends</h3>
5876
5877
5878
5879
5880 <ul>
5881 <li><a href="global.html#Container">Container</a></li>
5882 </ul>
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896 <h3 class="subsection-title">Members</h3>
5897
5898
5899
5900<h4 class="name" id="getObject"><span class="type-signature"></span>getObject<span class="type-signature"></span></h4>
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911<dl class="details">
5912
5913
5914
5915
5916
5917
5918
5919
5920 <dt class="tag-overrides">Overrides:</dt>
5921 <dd class="tag-overrides"><ul class="dummy"><li>
5922 <a href="global.html#Container#getObject">Container#getObject</a>
5923 </li></ul></dd>
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943 <dt class="tag-source">Source:</dt>
5944 <dd class="tag-source"><ul class="dummy"><li>
5945 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line70">line 70</a>
5946 </li></ul></dd>
5947
5948
5949
5950
5951
5952
5953
5954</dl>
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965 <h3 class="subsection-title">Methods</h3>
5966
5967
5968
5969
5970
5971
5972 <h4 class="name" id="action"><span class="type-signature"></span>action<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Action.html">Action</a>}</span></h4>
5973
5974
5975
5976
5977
5978<div class="description">
5979 Return an action reference
5980</div>
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990 <h5>Parameters:</h5>
5991
5992
5993<table class="params">
5994 <thead>
5995 <tr>
5996
5997 <th>Name</th>
5998
5999
6000 <th>Type</th>
6001
6002
6003
6004
6005
6006 <th class="last">Description</th>
6007 </tr>
6008 </thead>
6009
6010 <tbody>
6011
6012
6013 <tr>
6014
6015 <td class="name"><code>name</code></td>
6016
6017
6018 <td class="type">
6019
6020
6021<span class="param-type">String</span>
6022
6023
6024
6025 </td>
6026
6027
6028
6029
6030
6031 <td class="description last">action name</td>
6032 </tr>
6033
6034
6035 </tbody>
6036</table>
6037
6038
6039
6040
6041
6042
6043<dl class="details">
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070 <dt class="tag-source">Source:</dt>
6071 <dd class="tag-source"><ul class="dummy"><li>
6072 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line104">line 104</a>
6073 </li></ul></dd>
6074
6075
6076
6077
6078
6079
6080
6081</dl>
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095<h5>Returns:</h5>
6096
6097
6098<div class="param-desc">
6099 action requested action, if available
6100</div>
6101
6102
6103
6104<dl>
6105 <dt>
6106 Type
6107 </dt>
6108 <dd>
6109
6110<span class="param-type"><a href="Action.html">Action</a></span>
6111
6112
6113 </dd>
6114</dl>
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125 <h4 class="name" id="action"><span class="type-signature"></span>action<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Action.html">Action</a>}</span></h4>
6126
6127
6128
6129
6130
6131<div class="description">
6132 Return an action reference
6133</div>
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143 <h5>Parameters:</h5>
6144
6145
6146<table class="params">
6147 <thead>
6148 <tr>
6149
6150 <th>Name</th>
6151
6152
6153 <th>Type</th>
6154
6155
6156
6157
6158
6159 <th class="last">Description</th>
6160 </tr>
6161 </thead>
6162
6163 <tbody>
6164
6165
6166 <tr>
6167
6168 <td class="name"><code>name</code></td>
6169
6170
6171 <td class="type">
6172
6173
6174<span class="param-type">String</span>
6175
6176
6177
6178 </td>
6179
6180
6181
6182
6183
6184 <td class="description last">action name</td>
6185 </tr>
6186
6187
6188 </tbody>
6189</table>
6190
6191
6192
6193
6194
6195
6196<dl class="details">
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223 <dt class="tag-source">Source:</dt>
6224 <dd class="tag-source"><ul class="dummy"><li>
6225 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line104">line 104</a>
6226 </li></ul></dd>
6227
6228
6229
6230
6231
6232
6233
6234</dl>
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248<h5>Returns:</h5>
6249
6250
6251<div class="param-desc">
6252 action requested action, if available
6253</div>
6254
6255
6256
6257<dl>
6258 <dt>
6259 Type
6260 </dt>
6261 <dd>
6262
6263<span class="param-type"><a href="Action.html">Action</a></span>
6264
6265
6266 </dd>
6267</dl>
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278 <h4 class="name" id="addChild"><span class="type-signature"></span>addChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
6279
6280
6281
6282
6283
6284<div class="description">
6285 Add a child
6286</div>
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296 <h5>Parameters:</h5>
6297
6298
6299<table class="params">
6300 <thead>
6301 <tr>
6302
6303 <th>Name</th>
6304
6305
6306 <th>Type</th>
6307
6308
6309
6310
6311
6312 <th class="last">Description</th>
6313 </tr>
6314 </thead>
6315
6316 <tbody>
6317
6318
6319 <tr>
6320
6321 <td class="name"><code>child</code></td>
6322
6323
6324 <td class="type">
6325
6326
6327<span class="param-type"><a href="ServiceObject.html">ServiceObject</a></span>
6328
6329
6330
6331 </td>
6332
6333
6334
6335
6336
6337 <td class="description last">The object instance or id to add</td>
6338 </tr>
6339
6340
6341 </tbody>
6342</table>
6343
6344
6345
6346
6347
6348
6349<dl class="details">
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376 <dt class="tag-source">Source:</dt>
6377 <dd class="tag-source"><ul class="dummy"><li>
6378 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line317">line 317</a>
6379 </li></ul></dd>
6380
6381
6382
6383
6384
6385
6386
6387</dl>
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401<h5>Returns:</h5>
6402
6403
6404<div class="param-desc">
6405 Promise of the request with a the list of children
6406</div>
6407
6408
6409
6410<dl>
6411 <dt>
6412 Type
6413 </dt>
6414 <dd>
6415
6416<span class="param-type">Promise</span>
6417
6418
6419 </dd>
6420</dl>
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431 <h4 class="name" id="addChild"><span class="type-signature"></span>addChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
6432
6433
6434
6435
6436
6437<div class="description">
6438 Add a child
6439</div>
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449 <h5>Parameters:</h5>
6450
6451
6452<table class="params">
6453 <thead>
6454 <tr>
6455
6456 <th>Name</th>
6457
6458
6459 <th>Type</th>
6460
6461
6462
6463
6464
6465 <th class="last">Description</th>
6466 </tr>
6467 </thead>
6468
6469 <tbody>
6470
6471
6472 <tr>
6473
6474 <td class="name"><code>child</code></td>
6475
6476
6477 <td class="type">
6478
6479
6480<span class="param-type"><a href="ServiceObject.html">ServiceObject</a></span>
6481
6482
6483
6484 </td>
6485
6486
6487
6488
6489
6490 <td class="description last">The object instance or id to add</td>
6491 </tr>
6492
6493
6494 </tbody>
6495</table>
6496
6497
6498
6499
6500
6501
6502<dl class="details">
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529 <dt class="tag-source">Source:</dt>
6530 <dd class="tag-source"><ul class="dummy"><li>
6531 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line317">line 317</a>
6532 </li></ul></dd>
6533
6534
6535
6536
6537
6538
6539
6540</dl>
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554<h5>Returns:</h5>
6555
6556
6557<div class="param-desc">
6558 Promise of the request with a the list of children
6559</div>
6560
6561
6562
6563<dl>
6564 <dt>
6565 Type
6566 </dt>
6567 <dd>
6568
6569<span class="param-type">Promise</span>
6570
6571
6572 </dd>
6573</dl>
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584 <h4 class="name" id="addStream"><span class="type-signature"></span>addStream<span class="signature">(name, definition)</span><span class="type-signature"></span></h4>
6585
6586
6587
6588
6589
6590<div class="description">
6591 Add a stream to the object
6592</div>
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602 <h5>Parameters:</h5>
6603
6604
6605<table class="params">
6606 <thead>
6607 <tr>
6608
6609 <th>Name</th>
6610
6611
6612 <th>Type</th>
6613
6614
6615
6616
6617
6618 <th class="last">Description</th>
6619 </tr>
6620 </thead>
6621
6622 <tbody>
6623
6624
6625 <tr>
6626
6627 <td class="name"><code>name</code></td>
6628
6629
6630 <td class="type">
6631
6632
6633<span class="param-type">String</span>
6634
6635
6636
6637 </td>
6638
6639
6640
6641
6642
6643 <td class="description last">The stream name</td>
6644 </tr>
6645
6646
6647
6648 <tr>
6649
6650 <td class="name"><code>definition</code></td>
6651
6652
6653 <td class="type">
6654
6655
6656<span class="param-type">Object</span>
6657
6658
6659
6660 </td>
6661
6662
6663
6664
6665
6666 <td class="description last">The steam definition</td>
6667 </tr>
6668
6669
6670 </tbody>
6671</table>
6672
6673
6674
6675
6676
6677
6678<dl class="details">
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705 <dt class="tag-source">Source:</dt>
6706 <dd class="tag-source"><ul class="dummy"><li>
6707 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line189">line 189</a>
6708 </li></ul></dd>
6709
6710
6711
6712
6713
6714
6715
6716</dl>
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738 <h4 class="name" id="addStream"><span class="type-signature"></span>addStream<span class="signature">(name, definition)</span><span class="type-signature"></span></h4>
6739
6740
6741
6742
6743
6744<div class="description">
6745 Add a stream to the object
6746</div>
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756 <h5>Parameters:</h5>
6757
6758
6759<table class="params">
6760 <thead>
6761 <tr>
6762
6763 <th>Name</th>
6764
6765
6766 <th>Type</th>
6767
6768
6769
6770
6771
6772 <th class="last">Description</th>
6773 </tr>
6774 </thead>
6775
6776 <tbody>
6777
6778
6779 <tr>
6780
6781 <td class="name"><code>name</code></td>
6782
6783
6784 <td class="type">
6785
6786
6787<span class="param-type">String</span>
6788
6789
6790
6791 </td>
6792
6793
6794
6795
6796
6797 <td class="description last">The stream name</td>
6798 </tr>
6799
6800
6801
6802 <tr>
6803
6804 <td class="name"><code>definition</code></td>
6805
6806
6807 <td class="type">
6808
6809
6810<span class="param-type">Object</span>
6811
6812
6813
6814 </td>
6815
6816
6817
6818
6819
6820 <td class="description last">The steam definition</td>
6821 </tr>
6822
6823
6824 </tbody>
6825</table>
6826
6827
6828
6829
6830
6831
6832<dl class="details">
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859 <dt class="tag-source">Source:</dt>
6860 <dd class="tag-source"><ul class="dummy"><li>
6861 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line189">line 189</a>
6862 </li></ul></dd>
6863
6864
6865
6866
6867
6868
6869
6870</dl>
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892 <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
6893
6894
6895
6896
6897
6898<div class="description">
6899 Create a new Object instance
6900</div>
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914<dl class="details">
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941 <dt class="tag-source">Source:</dt>
6942 <dd class="tag-source"><ul class="dummy"><li>
6943 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line226">line 226</a>
6944 </li></ul></dd>
6945
6946
6947
6948
6949
6950
6951
6952</dl>
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966<h5>Returns:</h5>
6967
6968
6969<div class="param-desc">
6970 object the newly created reference
6971</div>
6972
6973
6974
6975<dl>
6976 <dt>
6977 Type
6978 </dt>
6979 <dd>
6980
6981<span class="param-type">Promise</span>
6982
6983
6984 </dd>
6985</dl>
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996 <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
6997
6998
6999
7000
7001
7002<div class="description">
7003 Create a new Object instance
7004</div>
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018<dl class="details">
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045 <dt class="tag-source">Source:</dt>
7046 <dd class="tag-source"><ul class="dummy"><li>
7047 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line226">line 226</a>
7048 </li></ul></dd>
7049
7050
7051
7052
7053
7054
7055
7056</dl>
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070<h5>Returns:</h5>
7071
7072
7073<div class="param-desc">
7074 object the newly created reference
7075</div>
7076
7077
7078
7079<dl>
7080 <dt>
7081 Type
7082 </dt>
7083 <dd>
7084
7085<span class="param-type">Promise</span>
7086
7087
7088 </dd>
7089</dl>
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100 <h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(Optional,)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
7101
7102
7103
7104
7105
7106<div class="description">
7107 Delete a Service Object
7108</div>
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118 <h5>Parameters:</h5>
7119
7120
7121<table class="params">
7122 <thead>
7123 <tr>
7124
7125 <th>Name</th>
7126
7127
7128 <th>Type</th>
7129
7130
7131
7132
7133
7134 <th class="last">Description</th>
7135 </tr>
7136 </thead>
7137
7138 <tbody>
7139
7140
7141 <tr>
7142
7143 <td class="name"><code>Optional,</code></td>
7144
7145
7146 <td class="type">
7147
7148
7149<span class="param-type">String</span>
7150
7151
7152
7153 </td>
7154
7155
7156
7157
7158
7159 <td class="description last">the objectId to delete</td>
7160 </tr>
7161
7162
7163 </tbody>
7164</table>
7165
7166
7167
7168
7169
7170
7171<dl class="details">
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198 <dt class="tag-source">Source:</dt>
7199 <dd class="tag-source"><ul class="dummy"><li>
7200 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line273">line 273</a>
7201 </li></ul></dd>
7202
7203
7204
7205
7206
7207
7208
7209</dl>
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223<h5>Returns:</h5>
7224
7225
7226<div class="param-desc">
7227 Promise of the request with a new empty so as argument
7228</div>
7229
7230
7231
7232<dl>
7233 <dt>
7234 Type
7235 </dt>
7236 <dd>
7237
7238<span class="param-type">Promise</span>
7239
7240
7241 </dd>
7242</dl>
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253 <h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(Optional,)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
7254
7255
7256
7257
7258
7259<div class="description">
7260 Delete a Service Object
7261</div>
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271 <h5>Parameters:</h5>
7272
7273
7274<table class="params">
7275 <thead>
7276 <tr>
7277
7278 <th>Name</th>
7279
7280
7281 <th>Type</th>
7282
7283
7284
7285
7286
7287 <th class="last">Description</th>
7288 </tr>
7289 </thead>
7290
7291 <tbody>
7292
7293
7294 <tr>
7295
7296 <td class="name"><code>Optional,</code></td>
7297
7298
7299 <td class="type">
7300
7301
7302<span class="param-type">String</span>
7303
7304
7305
7306 </td>
7307
7308
7309
7310
7311
7312 <td class="description last">the objectId to delete</td>
7313 </tr>
7314
7315
7316 </tbody>
7317</table>
7318
7319
7320
7321
7322
7323
7324<dl class="details">
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351 <dt class="tag-source">Source:</dt>
7352 <dd class="tag-source"><ul class="dummy"><li>
7353 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line273">line 273</a>
7354 </li></ul></dd>
7355
7356
7357
7358
7359
7360
7361
7362</dl>
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376<h5>Returns:</h5>
7377
7378
7379<div class="param-desc">
7380 Promise of the request with a new empty so as argument
7381</div>
7382
7383
7384
7385<dl>
7386 <dt>
7387 Type
7388 </dt>
7389 <dd>
7390
7391<span class="param-type">Promise</span>
7392
7393
7394 </dd>
7395</dl>
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406 <h4 class="name" id="exportProperties"><span class="type-signature"></span>exportProperties<span class="signature">()</span><span class="type-signature"></span></h4>
7407
7408
7409
7410
7411
7412<div class="description">
7413 Exposes setter and getter for a class from the `data` field
7414</div>
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428<dl class="details">
7429
7430
7431
7432
7433
7434
7435
7436
7437 <dt class="tag-overrides">Overrides:</dt>
7438 <dd class="tag-overrides"><ul class="dummy"><li>
7439 <a href="global.html#Container#exportProperties">Container#exportProperties</a>
7440 </li></ul></dd>
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460 <dt class="tag-source">Source:</dt>
7461 <dd class="tag-source"><ul class="dummy"><li>
7462 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line19">line 19</a>
7463 </li></ul></dd>
7464
7465
7466
7467
7468
7469
7470
7471</dl>
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493 <h4 class="name" id="getChildren"><span class="type-signature"></span>getChildren<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
7494
7495
7496
7497
7498
7499<div class="description">
7500 Get children
7501</div>
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515<dl class="details">
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542 <dt class="tag-source">Source:</dt>
7543 <dd class="tag-source"><ul class="dummy"><li>
7544 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line287">line 287</a>
7545 </li></ul></dd>
7546
7547
7548
7549
7550
7551
7552
7553</dl>
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567<h5>Returns:</h5>
7568
7569
7570<div class="param-desc">
7571 Promise of the request with a the list of children
7572</div>
7573
7574
7575
7576<dl>
7577 <dt>
7578 Type
7579 </dt>
7580 <dd>
7581
7582<span class="param-type">Promise</span>
7583
7584
7585 </dd>
7586</dl>
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597 <h4 class="name" id="getChildren"><span class="type-signature"></span>getChildren<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
7598
7599
7600
7601
7602
7603<div class="description">
7604 Get children
7605</div>
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619<dl class="details">
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646 <dt class="tag-source">Source:</dt>
7647 <dd class="tag-source"><ul class="dummy"><li>
7648 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line287">line 287</a>
7649 </li></ul></dd>
7650
7651
7652
7653
7654
7655
7656
7657</dl>
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671<h5>Returns:</h5>
7672
7673
7674<div class="param-desc">
7675 Promise of the request with a the list of children
7676</div>
7677
7678
7679
7680<dl>
7681 <dt>
7682 Type
7683 </dt>
7684 <dd>
7685
7686<span class="param-type">Promise</span>
7687
7688
7689 </dd>
7690</dl>
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701 <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>
7702
7703
7704
7705
7706
7707<div class="description">
7708 Return the client reference
7709</div>
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723<dl class="details">
7724
7725
7726
7727
7728
7729
7730
7731
7732 <dt class="tag-overrides">Overrides:</dt>
7733 <dd class="tag-overrides"><ul class="dummy"><li>
7734 <a href="global.html#Container#getClient">Container#getClient</a>
7735 </li></ul></dd>
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755 <dt class="tag-source">Source:</dt>
7756 <dd class="tag-source"><ul class="dummy"><li>
7757 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line37">line 37</a>
7758 </li></ul></dd>
7759
7760
7761
7762
7763
7764
7765
7766</dl>
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780<h5>Returns:</h5>
7781
7782
7783<div class="param-desc">
7784 client
7785</div>
7786
7787
7788
7789<dl>
7790 <dt>
7791 Type
7792 </dt>
7793 <dd>
7794
7795<span class="param-type"><a href="Client.html">Client</a></span>
7796
7797
7798 </dd>
7799</dl>
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810 <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>
7811
7812
7813
7814
7815
7816<div class="description">
7817 Return the Raptor instance wrapper
7818</div>
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832<dl class="details">
7833
7834
7835
7836
7837
7838
7839
7840
7841 <dt class="tag-overrides">Overrides:</dt>
7842 <dd class="tag-overrides"><ul class="dummy"><li>
7843 <a href="global.html#Container#getContainer">Container#getContainer</a>
7844 </li></ul></dd>
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864 <dt class="tag-source">Source:</dt>
7865 <dd class="tag-source"><ul class="dummy"><li>
7866 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line45">line 45</a>
7867 </li></ul></dd>
7868
7869
7870
7871
7872
7873
7874
7875</dl>
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889<h5>Returns:</h5>
7890
7891
7892<div class="param-desc">
7893 container Raptor instance reference
7894</div>
7895
7896
7897
7898<dl>
7899 <dt>
7900 Type
7901 </dt>
7902 <dd>
7903
7904<span class="param-type"><a href="Raptor.html">Raptor</a></span>
7905
7906
7907 </dd>
7908</dl>
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919 <h4 class="name" id="getCreatedAt"><span class="type-signature"></span>getCreatedAt<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></h4>
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937<dl class="details">
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964 <dt class="tag-source">Source:</dt>
7965 <dd class="tag-source"><ul class="dummy"><li>
7966 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line84">line 84</a>
7967 </li></ul></dd>
7968
7969
7970
7971
7972
7973
7974
7975</dl>
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989<h5>Returns:</h5>
7990
7991
7992<div class="param-desc">
7993 createdAt The creation date as unix timestamp
7994</div>
7995
7996
7997
7998<dl>
7999 <dt>
8000 Type
8001 </dt>
8002 <dd>
8003
8004<span class="param-type">Number</span>
8005
8006
8007 </dd>
8008</dl>
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019 <h4 class="name" id="getCreatedAt"><span class="type-signature"></span>getCreatedAt<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></h4>
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037<dl class="details">
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064 <dt class="tag-source">Source:</dt>
8065 <dd class="tag-source"><ul class="dummy"><li>
8066 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line84">line 84</a>
8067 </li></ul></dd>
8068
8069
8070
8071
8072
8073
8074
8075</dl>
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089<h5>Returns:</h5>
8090
8091
8092<div class="param-desc">
8093 createdAt The creation date as unix timestamp
8094</div>
8095
8096
8097
8098<dl>
8099 <dt>
8100 Type
8101 </dt>
8102 <dd>
8103
8104<span class="param-type">Number</span>
8105
8106
8107 </dd>
8108</dl>
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119 <h4 class="name" id="getId"><span class="type-signature"></span>getId<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137<dl class="details">
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164 <dt class="tag-source">Source:</dt>
8165 <dd class="tag-source"><ul class="dummy"><li>
8166 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line77">line 77</a>
8167 </li></ul></dd>
8168
8169
8170
8171
8172
8173
8174
8175</dl>
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189<h5>Returns:</h5>
8190
8191
8192<div class="param-desc">
8193 id The object id
8194</div>
8195
8196
8197
8198<dl>
8199 <dt>
8200 Type
8201 </dt>
8202 <dd>
8203
8204<span class="param-type">String</span>
8205
8206
8207 </dd>
8208</dl>
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219 <h4 class="name" id="getId"><span class="type-signature"></span>getId<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237<dl class="details">
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264 <dt class="tag-source">Source:</dt>
8265 <dd class="tag-source"><ul class="dummy"><li>
8266 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line77">line 77</a>
8267 </li></ul></dd>
8268
8269
8270
8271
8272
8273
8274
8275</dl>
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289<h5>Returns:</h5>
8290
8291
8292<div class="param-desc">
8293 id The object id
8294</div>
8295
8296
8297
8298<dl>
8299 <dt>
8300 Type
8301 </dt>
8302 <dd>
8303
8304<span class="param-type">String</span>
8305
8306
8307 </dd>
8308</dl>
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319 <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">(id)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
8320
8321
8322
8323
8324
8325<div class="description">
8326 Load the Object definition
8327</div>
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337 <h5>Parameters:</h5>
8338
8339
8340<table class="params">
8341 <thead>
8342 <tr>
8343
8344 <th>Name</th>
8345
8346
8347 <th>Type</th>
8348
8349
8350
8351
8352
8353 <th class="last">Description</th>
8354 </tr>
8355 </thead>
8356
8357 <tbody>
8358
8359
8360 <tr>
8361
8362 <td class="name"><code>id</code></td>
8363
8364
8365 <td class="type">
8366
8367
8368<span class="param-type">String</span>
8369
8370
8371
8372 </td>
8373
8374
8375
8376
8377
8378 <td class="description last">The object Id</td>
8379 </tr>
8380
8381
8382 </tbody>
8383</table>
8384
8385
8386
8387
8388
8389
8390<dl class="details">
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417 <dt class="tag-source">Source:</dt>
8418 <dd class="tag-source"><ul class="dummy"><li>
8419 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line244">line 244</a>
8420 </li></ul></dd>
8421
8422
8423
8424
8425
8426
8427
8428</dl>
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442<h5>Returns:</h5>
8443
8444
8445<div class="param-desc">
8446 Promise of the request with the ServiceObject as argument
8447</div>
8448
8449
8450
8451<dl>
8452 <dt>
8453 Type
8454 </dt>
8455 <dd>
8456
8457<span class="param-type">Promise</span>
8458
8459
8460 </dd>
8461</dl>
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472 <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">(id)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
8473
8474
8475
8476
8477
8478<div class="description">
8479 Load the Object definition
8480</div>
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490 <h5>Parameters:</h5>
8491
8492
8493<table class="params">
8494 <thead>
8495 <tr>
8496
8497 <th>Name</th>
8498
8499
8500 <th>Type</th>
8501
8502
8503
8504
8505
8506 <th class="last">Description</th>
8507 </tr>
8508 </thead>
8509
8510 <tbody>
8511
8512
8513 <tr>
8514
8515 <td class="name"><code>id</code></td>
8516
8517
8518 <td class="type">
8519
8520
8521<span class="param-type">String</span>
8522
8523
8524
8525 </td>
8526
8527
8528
8529
8530
8531 <td class="description last">The object Id</td>
8532 </tr>
8533
8534
8535 </tbody>
8536</table>
8537
8538
8539
8540
8541
8542
8543<dl class="details">
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570 <dt class="tag-source">Source:</dt>
8571 <dd class="tag-source"><ul class="dummy"><li>
8572 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line244">line 244</a>
8573 </li></ul></dd>
8574
8575
8576
8577
8578
8579
8580
8581</dl>
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595<h5>Returns:</h5>
8596
8597
8598<div class="param-desc">
8599 Promise of the request with the ServiceObject as argument
8600</div>
8601
8602
8603
8604<dl>
8605 <dt>
8606 Type
8607 </dt>
8608 <dd>
8609
8610<span class="param-type">Promise</span>
8611
8612
8613 </dd>
8614</dl>
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625 <h4 class="name" id="parseJSON"><span class="type-signature"></span>parseJSON<span class="signature">(raw)</span><span class="type-signature"></span></h4>
8626
8627
8628
8629
8630
8631<div class="description">
8632 Parse a plain object and populate the corresponding fields in the current instance
8633</div>
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643 <h5>Parameters:</h5>
8644
8645
8646<table class="params">
8647 <thead>
8648 <tr>
8649
8650 <th>Name</th>
8651
8652
8653 <th>Type</th>
8654
8655
8656
8657
8658
8659 <th class="last">Description</th>
8660 </tr>
8661 </thead>
8662
8663 <tbody>
8664
8665
8666 <tr>
8667
8668 <td class="name"><code>raw</code></td>
8669
8670
8671 <td class="type">
8672
8673
8674<span class="param-type">Object</span>
8675
8676
8677
8678 </td>
8679
8680
8681
8682
8683
8684 <td class="description last">the json object</td>
8685 </tr>
8686
8687
8688 </tbody>
8689</table>
8690
8691
8692
8693
8694
8695
8696<dl class="details">
8697
8698
8699
8700
8701
8702
8703
8704
8705 <dt class="tag-overrides">Overrides:</dt>
8706 <dd class="tag-overrides"><ul class="dummy"><li>
8707 <a href="global.html#Container#parseJSON">Container#parseJSON</a>
8708 </li></ul></dd>
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728 <dt class="tag-source">Source:</dt>
8729 <dd class="tag-source"><ul class="dummy"><li>
8730 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line127">line 127</a>
8731 </li></ul></dd>
8732
8733
8734
8735
8736
8737
8738
8739</dl>
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761 <h4 class="name" id="removeChild"><span class="type-signature"></span>removeChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
8762
8763
8764
8765
8766
8767<div class="description">
8768 Remove a child
8769</div>
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779 <h5>Parameters:</h5>
8780
8781
8782<table class="params">
8783 <thead>
8784 <tr>
8785
8786 <th>Name</th>
8787
8788
8789 <th>Type</th>
8790
8791
8792
8793
8794
8795 <th class="last">Description</th>
8796 </tr>
8797 </thead>
8798
8799 <tbody>
8800
8801
8802 <tr>
8803
8804 <td class="name"><code>child</code></td>
8805
8806
8807 <td class="type">
8808
8809
8810<span class="param-type"><a href="ServiceObject.html">ServiceObject</a></span>
8811
8812
8813
8814 </td>
8815
8816
8817
8818
8819
8820 <td class="description last">The object instance or id to remove</td>
8821 </tr>
8822
8823
8824 </tbody>
8825</table>
8826
8827
8828
8829
8830
8831
8832<dl class="details">
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859 <dt class="tag-source">Source:</dt>
8860 <dd class="tag-source"><ul class="dummy"><li>
8861 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line340">line 340</a>
8862 </li></ul></dd>
8863
8864
8865
8866
8867
8868
8869
8870</dl>
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884<h5>Returns:</h5>
8885
8886
8887<div class="param-desc">
8888 Promise of the request with a the list of children
8889</div>
8890
8891
8892
8893<dl>
8894 <dt>
8895 Type
8896 </dt>
8897 <dd>
8898
8899<span class="param-type">Promise</span>
8900
8901
8902 </dd>
8903</dl>
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914 <h4 class="name" id="removeChild"><span class="type-signature"></span>removeChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
8915
8916
8917
8918
8919
8920<div class="description">
8921 Remove a child
8922</div>
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932 <h5>Parameters:</h5>
8933
8934
8935<table class="params">
8936 <thead>
8937 <tr>
8938
8939 <th>Name</th>
8940
8941
8942 <th>Type</th>
8943
8944
8945
8946
8947
8948 <th class="last">Description</th>
8949 </tr>
8950 </thead>
8951
8952 <tbody>
8953
8954
8955 <tr>
8956
8957 <td class="name"><code>child</code></td>
8958
8959
8960 <td class="type">
8961
8962
8963<span class="param-type"><a href="ServiceObject.html">ServiceObject</a></span>
8964
8965
8966
8967 </td>
8968
8969
8970
8971
8972
8973 <td class="description last">The object instance or id to remove</td>
8974 </tr>
8975
8976
8977 </tbody>
8978</table>
8979
8980
8981
8982
8983
8984
8985<dl class="details">
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012 <dt class="tag-source">Source:</dt>
9013 <dd class="tag-source"><ul class="dummy"><li>
9014 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line340">line 340</a>
9015 </li></ul></dd>
9016
9017
9018
9019
9020
9021
9022
9023</dl>
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037<h5>Returns:</h5>
9038
9039
9040<div class="param-desc">
9041 Promise of the request with a the list of children
9042</div>
9043
9044
9045
9046<dl>
9047 <dt>
9048 Type
9049 </dt>
9050 <dd>
9051
9052<span class="param-type">Promise</span>
9053
9054
9055 </dd>
9056</dl>
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067 <h4 class="name" id="setActions"><span class="type-signature"></span>setActions<span class="signature">(actions)</span><span class="type-signature"></span></h4>
9068
9069
9070
9071
9072
9073<div class="description">
9074 Set actions to the object
9075</div>
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085 <h5>Parameters:</h5>
9086
9087
9088<table class="params">
9089 <thead>
9090 <tr>
9091
9092 <th>Name</th>
9093
9094
9095 <th>Type</th>
9096
9097
9098
9099
9100
9101 <th class="last">Description</th>
9102 </tr>
9103 </thead>
9104
9105 <tbody>
9106
9107
9108 <tr>
9109
9110 <td class="name"><code>actions</code></td>
9111
9112
9113 <td class="type">
9114
9115
9116<span class="param-type">Array</span>
9117
9118
9119
9120 </td>
9121
9122
9123
9124
9125
9126 <td class="description last">The list of actions to set</td>
9127 </tr>
9128
9129
9130 </tbody>
9131</table>
9132
9133
9134
9135
9136
9137
9138<dl class="details">
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165 <dt class="tag-source">Source:</dt>
9166 <dd class="tag-source"><ul class="dummy"><li>
9167 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line160">line 160</a>
9168 </li></ul></dd>
9169
9170
9171
9172
9173
9174
9175
9176</dl>
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198 <h4 class="name" id="setActions"><span class="type-signature"></span>setActions<span class="signature">(actions)</span><span class="type-signature"></span></h4>
9199
9200
9201
9202
9203
9204<div class="description">
9205 Set actions to the object
9206</div>
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216 <h5>Parameters:</h5>
9217
9218
9219<table class="params">
9220 <thead>
9221 <tr>
9222
9223 <th>Name</th>
9224
9225
9226 <th>Type</th>
9227
9228
9229
9230
9231
9232 <th class="last">Description</th>
9233 </tr>
9234 </thead>
9235
9236 <tbody>
9237
9238
9239 <tr>
9240
9241 <td class="name"><code>actions</code></td>
9242
9243
9244 <td class="type">
9245
9246
9247<span class="param-type">Array</span>
9248
9249
9250
9251 </td>
9252
9253
9254
9255
9256
9257 <td class="description last">The list of actions to set</td>
9258 </tr>
9259
9260
9261 </tbody>
9262</table>
9263
9264
9265
9266
9267
9268
9269<dl class="details">
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296 <dt class="tag-source">Source:</dt>
9297 <dd class="tag-source"><ul class="dummy"><li>
9298 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line160">line 160</a>
9299 </li></ul></dd>
9300
9301
9302
9303
9304
9305
9306
9307</dl>
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329 <h4 class="name" id="setChildren"><span class="type-signature"></span>setChildren<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
9330
9331
9332
9333
9334
9335<div class="description">
9336 Set children
9337</div>
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351<dl class="details">
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378 <dt class="tag-source">Source:</dt>
9379 <dd class="tag-source"><ul class="dummy"><li>
9380 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line303">line 303</a>
9381 </li></ul></dd>
9382
9383
9384
9385
9386
9387
9388
9389</dl>
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403<h5>Returns:</h5>
9404
9405
9406<div class="param-desc">
9407 Promise of the request with a the list of children
9408</div>
9409
9410
9411
9412<dl>
9413 <dt>
9414 Type
9415 </dt>
9416 <dd>
9417
9418<span class="param-type">Promise</span>
9419
9420
9421 </dd>
9422</dl>
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433 <h4 class="name" id="setChildren"><span class="type-signature"></span>setChildren<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
9434
9435
9436
9437
9438
9439<div class="description">
9440 Set children
9441</div>
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455<dl class="details">
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482 <dt class="tag-source">Source:</dt>
9483 <dd class="tag-source"><ul class="dummy"><li>
9484 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line303">line 303</a>
9485 </li></ul></dd>
9486
9487
9488
9489
9490
9491
9492
9493</dl>
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507<h5>Returns:</h5>
9508
9509
9510<div class="param-desc">
9511 Promise of the request with a the list of children
9512</div>
9513
9514
9515
9516<dl>
9517 <dt>
9518 Type
9519 </dt>
9520 <dd>
9521
9522<span class="param-type">Promise</span>
9523
9524
9525 </dd>
9526</dl>
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537 <h4 class="name" id="setContainer"><span class="type-signature"></span>setContainer<span class="signature">(container)</span><span class="type-signature"></span></h4>
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551 <h5>Parameters:</h5>
9552
9553
9554<table class="params">
9555 <thead>
9556 <tr>
9557
9558 <th>Name</th>
9559
9560
9561 <th>Type</th>
9562
9563
9564
9565
9566
9567 <th class="last">Description</th>
9568 </tr>
9569 </thead>
9570
9571 <tbody>
9572
9573
9574 <tr>
9575
9576 <td class="name"><code>container</code></td>
9577
9578
9579 <td class="type">
9580
9581
9582<span class="param-type"><a href="Raptor.html">Raptor</a></span>
9583
9584
9585
9586 </td>
9587
9588
9589
9590
9591
9592 <td class="description last">reference to Raptor instance wrapper</td>
9593 </tr>
9594
9595
9596 </tbody>
9597</table>
9598
9599
9600
9601
9602
9603
9604<dl class="details">
9605
9606
9607
9608
9609
9610
9611
9612
9613 <dt class="tag-overrides">Overrides:</dt>
9614 <dd class="tag-overrides"><ul class="dummy"><li>
9615 <a href="global.html#Container#setContainer">Container#setContainer</a>
9616 </li></ul></dd>
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636 <dt class="tag-source">Source:</dt>
9637 <dd class="tag-source"><ul class="dummy"><li>
9638 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line52">line 52</a>
9639 </li></ul></dd>
9640
9641
9642
9643
9644
9645
9646
9647</dl>
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669 <h4 class="name" id="setServiceObject"><span class="type-signature"></span>setServiceObject<span class="signature">(object)</span><span class="type-signature"></span></h4>
9670
9671
9672
9673
9674
9675<div class="description">
9676 Set a reference to the parent object
9677</div>
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687 <h5>Parameters:</h5>
9688
9689
9690<table class="params">
9691 <thead>
9692 <tr>
9693
9694 <th>Name</th>
9695
9696
9697 <th>Type</th>
9698
9699
9700
9701
9702
9703 <th class="last">Description</th>
9704 </tr>
9705 </thead>
9706
9707 <tbody>
9708
9709
9710 <tr>
9711
9712 <td class="name"><code>object</code></td>
9713
9714
9715 <td class="type">
9716
9717
9718<span class="param-type"><a href="ServiceObject.html">ServiceObject</a></span>
9719
9720
9721
9722 </td>
9723
9724
9725
9726
9727
9728 <td class="description last">reference to the parent object</td>
9729 </tr>
9730
9731
9732 </tbody>
9733</table>
9734
9735
9736
9737
9738
9739
9740<dl class="details">
9741
9742
9743
9744
9745
9746
9747
9748
9749 <dt class="tag-overrides">Overrides:</dt>
9750 <dd class="tag-overrides"><ul class="dummy"><li>
9751 <a href="global.html#Container#setServiceObject">Container#setServiceObject</a>
9752 </li></ul></dd>
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772 <dt class="tag-source">Source:</dt>
9773 <dd class="tag-source"><ul class="dummy"><li>
9774 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line60">line 60</a>
9775 </li></ul></dd>
9776
9777
9778
9779
9780
9781
9782
9783</dl>
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805 <h4 class="name" id="setStreams"><span class="type-signature"></span>setStreams<span class="signature">(streams)</span><span class="type-signature"></span></h4>
9806
9807
9808
9809
9810
9811<div class="description">
9812 Set streams to the object
9813</div>
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823 <h5>Parameters:</h5>
9824
9825
9826<table class="params">
9827 <thead>
9828 <tr>
9829
9830 <th>Name</th>
9831
9832
9833 <th>Type</th>
9834
9835
9836
9837
9838
9839 <th class="last">Description</th>
9840 </tr>
9841 </thead>
9842
9843 <tbody>
9844
9845
9846 <tr>
9847
9848 <td class="name"><code>streams</code></td>
9849
9850
9851 <td class="type">
9852
9853
9854<span class="param-type">Array</span>
9855
9856
9857
9858 </td>
9859
9860
9861
9862
9863
9864 <td class="description last">The list of streams to set</td>
9865 </tr>
9866
9867
9868 </tbody>
9869</table>
9870
9871
9872
9873
9874
9875
9876<dl class="details">
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903 <dt class="tag-source">Source:</dt>
9904 <dd class="tag-source"><ul class="dummy"><li>
9905 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line210">line 210</a>
9906 </li></ul></dd>
9907
9908
9909
9910
9911
9912
9913
9914</dl>
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936 <h4 class="name" id="setStreams"><span class="type-signature"></span>setStreams<span class="signature">(streams)</span><span class="type-signature"></span></h4>
9937
9938
9939
9940
9941
9942<div class="description">
9943 Set streams to the object
9944</div>
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954 <h5>Parameters:</h5>
9955
9956
9957<table class="params">
9958 <thead>
9959 <tr>
9960
9961 <th>Name</th>
9962
9963
9964 <th>Type</th>
9965
9966
9967
9968
9969
9970 <th class="last">Description</th>
9971 </tr>
9972 </thead>
9973
9974 <tbody>
9975
9976
9977 <tr>
9978
9979 <td class="name"><code>streams</code></td>
9980
9981
9982 <td class="type">
9983
9984
9985<span class="param-type">Array</span>
9986
9987
9988
9989 </td>
9990
9991
9992
9993
9994
9995 <td class="description last">The list of streams to set</td>
9996 </tr>
9997
9998
9999 </tbody>
10000</table>
10001
10002
10003
10004
10005
10006
10007<dl class="details">
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034 <dt class="tag-source">Source:</dt>
10035 <dd class="tag-source"><ul class="dummy"><li>
10036 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line210">line 210</a>
10037 </li></ul></dd>
10038
10039
10040
10041
10042
10043
10044
10045</dl>
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067 <h4 class="name" id="stream"><span class="type-signature"></span>stream<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Stream.html">Stream</a>}</span></h4>
10068
10069
10070
10071
10072
10073<div class="description">
10074 Return a stream reference
10075</div>
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085 <h5>Parameters:</h5>
10086
10087
10088<table class="params">
10089 <thead>
10090 <tr>
10091
10092 <th>Name</th>
10093
10094
10095 <th>Type</th>
10096
10097
10098
10099
10100
10101 <th class="last">Description</th>
10102 </tr>
10103 </thead>
10104
10105 <tbody>
10106
10107
10108 <tr>
10109
10110 <td class="name"><code>name</code></td>
10111
10112
10113 <td class="type">
10114
10115
10116<span class="param-type">String</span>
10117
10118
10119
10120 </td>
10121
10122
10123
10124
10125
10126 <td class="description last">stream name</td>
10127 </tr>
10128
10129
10130 </tbody>
10131</table>
10132
10133
10134
10135
10136
10137
10138<dl class="details">
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165 <dt class="tag-source">Source:</dt>
10166 <dd class="tag-source"><ul class="dummy"><li>
10167 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line94">line 94</a>
10168 </li></ul></dd>
10169
10170
10171
10172
10173
10174
10175
10176</dl>
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190<h5>Returns:</h5>
10191
10192
10193<div class="param-desc">
10194 stream requested stream, if available
10195</div>
10196
10197
10198
10199<dl>
10200 <dt>
10201 Type
10202 </dt>
10203 <dd>
10204
10205<span class="param-type"><a href="Stream.html">Stream</a></span>
10206
10207
10208 </dd>
10209</dl>
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220 <h4 class="name" id="stream"><span class="type-signature"></span>stream<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Stream.html">Stream</a>}</span></h4>
10221
10222
10223
10224
10225
10226<div class="description">
10227 Return a stream reference
10228</div>
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238 <h5>Parameters:</h5>
10239
10240
10241<table class="params">
10242 <thead>
10243 <tr>
10244
10245 <th>Name</th>
10246
10247
10248 <th>Type</th>
10249
10250
10251
10252
10253
10254 <th class="last">Description</th>
10255 </tr>
10256 </thead>
10257
10258 <tbody>
10259
10260
10261 <tr>
10262
10263 <td class="name"><code>name</code></td>
10264
10265
10266 <td class="type">
10267
10268
10269<span class="param-type">String</span>
10270
10271
10272
10273 </td>
10274
10275
10276
10277
10278
10279 <td class="description last">stream name</td>
10280 </tr>
10281
10282
10283 </tbody>
10284</table>
10285
10286
10287
10288
10289
10290
10291<dl class="details">
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318 <dt class="tag-source">Source:</dt>
10319 <dd class="tag-source"><ul class="dummy"><li>
10320 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line94">line 94</a>
10321 </li></ul></dd>
10322
10323
10324
10325
10326
10327
10328
10329</dl>
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343<h5>Returns:</h5>
10344
10345
10346<div class="param-desc">
10347 stream requested stream, if available
10348</div>
10349
10350
10351
10352<dl>
10353 <dt>
10354 Type
10355 </dt>
10356 <dd>
10357
10358<span class="param-type"><a href="Stream.html">Stream</a></span>
10359
10360
10361 </dd>
10362</dl>
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373 <h4 class="name" id="subscribe"><span class="type-signature"></span>subscribe<span class="signature">(cb)</span><span class="type-signature"> &rarr; {EventEmitter}</span></h4>
10374
10375
10376
10377
10378
10379<div class="description">
10380 Subscribe for Service Object updates
10381</div>
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391 <h5>Parameters:</h5>
10392
10393
10394<table class="params">
10395 <thead>
10396 <tr>
10397
10398 <th>Name</th>
10399
10400
10401 <th>Type</th>
10402
10403
10404
10405
10406
10407 <th class="last">Description</th>
10408 </tr>
10409 </thead>
10410
10411 <tbody>
10412
10413
10414 <tr>
10415
10416 <td class="name"><code>cb</code></td>
10417
10418
10419 <td class="type">
10420
10421
10422<span class="param-type"><a href="global.html#ServiceObjectOnEvent">ServiceObjectOnEvent</a></span>
10423
10424
10425
10426 </td>
10427
10428
10429
10430
10431
10432 <td class="description last">The callback that handles an event notification</td>
10433 </tr>
10434
10435
10436 </tbody>
10437</table>
10438
10439
10440
10441
10442
10443
10444<dl class="details">
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471 <dt class="tag-source">Source:</dt>
10472 <dd class="tag-source"><ul class="dummy"><li>
10473 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line365">line 365</a>
10474 </li></ul></dd>
10475
10476
10477
10478
10479
10480
10481
10482</dl>
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496<h5>Returns:</h5>
10497
10498
10499<div class="param-desc">
10500 An emitter that will notify of updates
10501</div>
10502
10503
10504
10505<dl>
10506 <dt>
10507 Type
10508 </dt>
10509 <dd>
10510
10511<span class="param-type">EventEmitter</span>
10512
10513
10514 </dd>
10515</dl>
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526 <h4 class="name" id="subscribe"><span class="type-signature"></span>subscribe<span class="signature">(cb)</span><span class="type-signature"> &rarr; {EventEmitter}</span></h4>
10527
10528
10529
10530
10531
10532<div class="description">
10533 Subscribe for Service Object updates
10534</div>
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544 <h5>Parameters:</h5>
10545
10546
10547<table class="params">
10548 <thead>
10549 <tr>
10550
10551 <th>Name</th>
10552
10553
10554 <th>Type</th>
10555
10556
10557
10558
10559
10560 <th class="last">Description</th>
10561 </tr>
10562 </thead>
10563
10564 <tbody>
10565
10566
10567 <tr>
10568
10569 <td class="name"><code>cb</code></td>
10570
10571
10572 <td class="type">
10573
10574
10575<span class="param-type"><a href="global.html#ServiceObjectOnEvent">ServiceObjectOnEvent</a></span>
10576
10577
10578
10579 </td>
10580
10581
10582
10583
10584
10585 <td class="description last">The callback that handles an event notification</td>
10586 </tr>
10587
10588
10589 </tbody>
10590</table>
10591
10592
10593
10594
10595
10596
10597<dl class="details">
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624 <dt class="tag-source">Source:</dt>
10625 <dd class="tag-source"><ul class="dummy"><li>
10626 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line365">line 365</a>
10627 </li></ul></dd>
10628
10629
10630
10631
10632
10633
10634
10635</dl>
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649<h5>Returns:</h5>
10650
10651
10652<div class="param-desc">
10653 An emitter that will notify of updates
10654</div>
10655
10656
10657
10658<dl>
10659 <dt>
10660 Type
10661 </dt>
10662 <dd>
10663
10664<span class="param-type">EventEmitter</span>
10665
10666
10667 </dd>
10668</dl>
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679 <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
10680
10681
10682
10683
10684
10685<div class="description">
10686 Convert the instance to a js object
10687</div>
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701<dl class="details">
10702
10703
10704
10705
10706
10707
10708
10709
10710 <dt class="tag-overrides">Overrides:</dt>
10711 <dd class="tag-overrides"><ul class="dummy"><li>
10712 <a href="global.html#Container#toJSON">Container#toJSON</a>
10713 </li></ul></dd>
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733 <dt class="tag-source">Source:</dt>
10734 <dd class="tag-source"><ul class="dummy"><li>
10735 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line86">line 86</a>
10736 </li></ul></dd>
10737
10738
10739
10740
10741
10742
10743
10744</dl>
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758<h5>Returns:</h5>
10759
10760
10761<div class="param-desc">
10762 Plain js object
10763</div>
10764
10765
10766
10767<dl>
10768 <dt>
10769 Type
10770 </dt>
10771 <dd>
10772
10773<span class="param-type">Object</span>
10774
10775
10776 </dd>
10777</dl>
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788 <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
10789
10790
10791
10792
10793
10794<div class="description">
10795 Return a JSON string of this object
10796</div>
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810<dl class="details">
10811
10812
10813
10814
10815
10816
10817
10818
10819 <dt class="tag-overrides">Overrides:</dt>
10820 <dd class="tag-overrides"><ul class="dummy"><li>
10821 <a href="global.html#Container#toString">Container#toString</a>
10822 </li></ul></dd>
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842 <dt class="tag-source">Source:</dt>
10843 <dd class="tag-source"><ul class="dummy"><li>
10844 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line119">line 119</a>
10845 </li></ul></dd>
10846
10847
10848
10849
10850
10851
10852
10853</dl>
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867<h5>Returns:</h5>
10868
10869
10870<div class="param-desc">
10871 json stringified JSON
10872</div>
10873
10874
10875
10876<dl>
10877 <dt>
10878 Type
10879 </dt>
10880 <dd>
10881
10882<span class="param-type">String</span>
10883
10884
10885 </dd>
10886</dl>
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897 <h4 class="name" id="unsubscribe"><span class="type-signature"></span>unsubscribe<span class="signature">()</span><span class="type-signature"></span></h4>
10898
10899
10900
10901
10902
10903<div class="description">
10904 Unsubscribe from Service Object updates
10905</div>
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919<dl class="details">
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946 <dt class="tag-source">Source:</dt>
10947 <dd class="tag-source"><ul class="dummy"><li>
10948 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line377">line 377</a>
10949 </li></ul></dd>
10950
10951
10952
10953
10954
10955
10956
10957</dl>
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979 <h4 class="name" id="unsubscribe"><span class="type-signature"></span>unsubscribe<span class="signature">()</span><span class="type-signature"></span></h4>
10980
10981
10982
10983
10984
10985<div class="description">
10986 Unsubscribe from Service Object updates
10987</div>
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001<dl class="details">
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028 <dt class="tag-source">Source:</dt>
11029 <dd class="tag-source"><ul class="dummy"><li>
11030 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line377">line 377</a>
11031 </li></ul></dd>
11032
11033
11034
11035
11036
11037
11038
11039</dl>
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061 <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
11062
11063
11064
11065
11066
11067<div class="description">
11068 Update an Object
11069</div>
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083<dl class="details">
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110 <dt class="tag-source">Source:</dt>
11111 <dd class="tag-source"><ul class="dummy"><li>
11112 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line258">line 258</a>
11113 </li></ul></dd>
11114
11115
11116
11117
11118
11119
11120
11121</dl>
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135<h5>Returns:</h5>
11136
11137
11138<div class="param-desc">
11139 Promise of the request with the ServiceObject as argument
11140</div>
11141
11142
11143
11144<dl>
11145 <dt>
11146 Type
11147 </dt>
11148 <dd>
11149
11150<span class="param-type">Promise</span>
11151
11152
11153 </dd>
11154</dl>
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165 <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
11166
11167
11168
11169
11170
11171<div class="description">
11172 Update an Object
11173</div>
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187<dl class="details">
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214 <dt class="tag-source">Source:</dt>
11215 <dd class="tag-source"><ul class="dummy"><li>
11216 <a href="lib_model_ServiceObject.js.html">lib/model/ServiceObject.js</a>, <a href="lib_model_ServiceObject.js.html#line258">line 258</a>
11217 </li></ul></dd>
11218
11219
11220
11221
11222
11223
11224
11225</dl>
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239<h5>Returns:</h5>
11240
11241
11242<div class="param-desc">
11243 Promise of the request with the ServiceObject as argument
11244</div>
11245
11246
11247
11248<dl>
11249 <dt>
11250 Type
11251 </dt>
11252 <dd>
11253
11254<span class="param-type">Promise</span>
11255
11256
11257 </dd>
11258</dl>
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269 <h4 class="name" id="validate"><span class="type-signature"></span>validate<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span></h4>
11270
11271
11272
11273
11274
11275<div class="description">
11276 Validate the object and throw an exception if fails
11277</div>
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291<dl class="details">
11292
11293
11294
11295
11296
11297
11298
11299
11300 <dt class="tag-overrides">Overrides:</dt>
11301 <dd class="tag-overrides"><ul class="dummy"><li>
11302 <a href="global.html#Container#validate">Container#validate</a>
11303 </li></ul></dd>
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323 <dt class="tag-source">Source:</dt>
11324 <dd class="tag-source"><ul class="dummy"><li>
11325 <a href="lib_model_Container.js.html">lib/model/Container.js</a>, <a href="lib_model_Container.js.html#line78">line 78</a>
11326 </li></ul></dd>
11327
11328
11329
11330
11331
11332
11333
11334</dl>
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348<h5>Returns:</h5>
11349
11350
11351
11352
11353<dl>
11354 <dt>
11355 Type
11356 </dt>
11357 <dd>
11358
11359<span class="param-type">void</span>
11360
11361
11362 </dd>
11363</dl>
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375</article>
11376
11377</section>
11378
11379
11380
11381
11382</div>
11383
11384<nav>
11385 <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>
11386</nav>
11387
11388<br class="clear">
11389
11390<footer>
11391 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)
11392</footer>
11393
11394<script> prettyPrint(); </script>
11395<script src="scripts/linenumber.js"> </script>
11396</body>
11397</html>
\No newline at end of file