| 1 | <!DOCTYPE html>
|
| 2 | <html lang="en">
|
| 3 | <head>
|
| 4 | <meta charset="utf-8">
|
| 5 | <title>JSDoc: Class: Raptor</title>
|
| 6 |
|
| 7 | <script src="scripts/prettify/prettify.js"> </script>
|
| 8 | <script src="scripts/prettify/lang-css.js"> </script>
|
| 9 | |
| 10 | |
| 11 |
|
| 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: Raptor</h1>
|
| 21 |
|
| 22 |
|
| 23 |
|
| 24 |
|
| 25 |
|
| 26 |
|
| 27 | <section>
|
| 28 |
|
| 29 | <header>
|
| 30 |
|
| 31 | <h2>Raptor</h2>
|
| 32 |
|
| 33 |
|
| 34 | </header>
|
| 35 |
|
| 36 | <article>
|
| 37 | <div class="container-overview">
|
| 38 |
|
| 39 |
|
| 40 |
|
| 41 |
|
| 42 |
|
| 43 | <h4 class="name" id="Raptor"><span class="type-signature"></span>new Raptor<span class="signature">(config)</span><span class="type-signature"></span></h4>
|
| 44 |
|
| 45 |
|
| 46 |
|
| 47 |
|
| 48 |
|
| 49 | <div class="description">
|
| 50 | Raptor SDK wrapper
|
| 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>config</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">configuration object</td>
|
| 103 | </tr>
|
| 104 |
|
| 105 |
|
| 106 | </tbody>
|
| 107 | </table>
|
| 108 |
|
| 109 |
|
| 110 |
|
| 111 |
|
| 112 |
|
| 113 |
|
| 114 | <dl class="details">
|
| 115 |
|
| 116 |
|
| 117 |
|
| 118 |
|
| 119 |
|
| 120 |
|
| 121 |
|
| 122 |
|
| 123 |
|
| 124 |
|
| 125 |
|
| 126 |
|
| 127 |
|
| 128 |
|
| 129 |
|
| 130 |
|
| 131 |
|
| 132 |
|
| 133 | <dt class="tag-author">Author:</dt>
|
| 134 | <dd class="tag-author">
|
| 135 | <ul>
|
| 136 | <li><a href="mailto:lcapra@fbk.eu">Luca Capra</a></li>
|
| 137 | </ul>
|
| 138 | </dd>
|
| 139 |
|
| 140 |
|
| 141 |
|
| 142 | <dt class="tag-copyright">Copyright:</dt>
|
| 143 | <dd class="tag-copyright"><ul class="dummy"><li>CREATE-NET</li></ul></dd>
|
| 144 |
|
| 145 |
|
| 146 |
|
| 147 | <dt class="tag-license">License:</dt>
|
| 148 | <dd class="tag-license"><ul class="dummy"><li>Apache-2.0</li></ul></dd>
|
| 149 |
|
| 150 |
|
| 151 |
|
| 152 |
|
| 153 |
|
| 154 | <dt class="tag-source">Source:</dt>
|
| 155 | <dd class="tag-source"><ul class="dummy"><li>
|
| 156 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line34">line 34</a>
|
| 157 | </li></ul></dd>
|
| 158 |
|
| 159 |
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 |
|
| 165 | </dl>
|
| 166 |
|
| 167 |
|
| 168 |
|
| 169 |
|
| 170 |
|
| 171 |
|
| 172 |
|
| 173 |
|
| 174 |
|
| 175 |
|
| 176 |
|
| 177 |
|
| 178 |
|
| 179 |
|
| 180 |
|
| 181 |
|
| 182 |
|
| 183 | </div>
|
| 184 |
|
| 185 |
|
| 186 |
|
| 187 |
|
| 188 |
|
| 189 |
|
| 190 |
|
| 191 |
|
| 192 |
|
| 193 |
|
| 194 |
|
| 195 |
|
| 196 | <h3 class="subsection-title">Members</h3>
|
| 197 |
|
| 198 |
|
| 199 |
|
| 200 | <h4 class="name" id="client"><span class="type-signature"></span>client<span class="type-signature"></span></h4>
|
| 201 |
|
| 202 |
|
| 203 |
|
| 204 |
|
| 205 | <div class="description">
|
| 206 | Return a API client instance
|
| 207 | </div>
|
| 208 |
|
| 209 |
|
| 210 |
|
| 211 |
|
| 212 |
|
| 213 |
|
| 214 |
|
| 215 | <dl class="details">
|
| 216 |
|
| 217 |
|
| 218 |
|
| 219 |
|
| 220 |
|
| 221 |
|
| 222 |
|
| 223 |
|
| 224 |
|
| 225 |
|
| 226 |
|
| 227 |
|
| 228 |
|
| 229 |
|
| 230 |
|
| 231 |
|
| 232 |
|
| 233 |
|
| 234 |
|
| 235 |
|
| 236 |
|
| 237 |
|
| 238 |
|
| 239 |
|
| 240 |
|
| 241 |
|
| 242 | <dt class="tag-source">Source:</dt>
|
| 243 | <dd class="tag-source"><ul class="dummy"><li>
|
| 244 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line82">line 82</a>
|
| 245 | </li></ul></dd>
|
| 246 |
|
| 247 |
|
| 248 |
|
| 249 |
|
| 250 |
|
| 251 |
|
| 252 |
|
| 253 | </dl>
|
| 254 |
|
| 255 |
|
| 256 |
|
| 257 |
|
| 258 |
|
| 259 |
|
| 260 |
|
| 261 |
|
| 262 | <h4 class="name" id="client"><span class="type-signature"></span>client<span class="type-signature"></span></h4>
|
| 263 |
|
| 264 |
|
| 265 |
|
| 266 |
|
| 267 | <div class="description">
|
| 268 | Return a API client instance
|
| 269 | </div>
|
| 270 |
|
| 271 |
|
| 272 |
|
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
|
| 277 | <dl class="details">
|
| 278 |
|
| 279 |
|
| 280 |
|
| 281 |
|
| 282 |
|
| 283 |
|
| 284 |
|
| 285 |
|
| 286 |
|
| 287 |
|
| 288 |
|
| 289 |
|
| 290 |
|
| 291 |
|
| 292 |
|
| 293 |
|
| 294 |
|
| 295 |
|
| 296 |
|
| 297 |
|
| 298 |
|
| 299 |
|
| 300 |
|
| 301 |
|
| 302 |
|
| 303 |
|
| 304 | <dt class="tag-source">Source:</dt>
|
| 305 | <dd class="tag-source"><ul class="dummy"><li>
|
| 306 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line82">line 82</a>
|
| 307 | </li></ul></dd>
|
| 308 |
|
| 309 |
|
| 310 |
|
| 311 |
|
| 312 |
|
| 313 |
|
| 314 |
|
| 315 | </dl>
|
| 316 |
|
| 317 |
|
| 318 |
|
| 319 |
|
| 320 |
|
| 321 |
|
| 322 |
|
| 323 |
|
| 324 | <h4 class="name" id="find"><span class="type-signature"></span>find<span class="type-signature"></span></h4>
|
| 325 |
|
| 326 |
|
| 327 |
|
| 328 |
|
| 329 | <div class="description">
|
| 330 | Search for Service Objects.
|
| 331 | Example parameters:
|
| 332 | 1) free-form query: { query: "some params" }
|
| 333 | 2) field params:
|
| 334 | {
|
| 335 | name: "Object Name",
|
| 336 | description: "optional description"
|
| 337 | customFields: {
|
| 338 | param1: "value"
|
| 339 | }
|
| 340 | }
|
| 341 | </div>
|
| 342 |
|
| 343 |
|
| 344 |
|
| 345 |
|
| 346 |
|
| 347 |
|
| 348 |
|
| 349 | <dl class="details">
|
| 350 |
|
| 351 |
|
| 352 |
|
| 353 |
|
| 354 |
|
| 355 |
|
| 356 |
|
| 357 |
|
| 358 |
|
| 359 |
|
| 360 |
|
| 361 |
|
| 362 |
|
| 363 |
|
| 364 |
|
| 365 |
|
| 366 |
|
| 367 |
|
| 368 |
|
| 369 |
|
| 370 |
|
| 371 |
|
| 372 |
|
| 373 |
|
| 374 |
|
| 375 |
|
| 376 | <dt class="tag-source">Source:</dt>
|
| 377 | <dd class="tag-source"><ul class="dummy"><li>
|
| 378 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line160">line 160</a>
|
| 379 | </li></ul></dd>
|
| 380 |
|
| 381 |
|
| 382 |
|
| 383 |
|
| 384 |
|
| 385 |
|
| 386 |
|
| 387 | </dl>
|
| 388 |
|
| 389 |
|
| 390 |
|
| 391 |
|
| 392 |
|
| 393 |
|
| 394 |
|
| 395 |
|
| 396 | <h4 class="name" id="find"><span class="type-signature"></span>find<span class="type-signature"></span></h4>
|
| 397 |
|
| 398 |
|
| 399 |
|
| 400 |
|
| 401 | <div class="description">
|
| 402 | Search for Service Objects.
|
| 403 | Example parameters:
|
| 404 | 1) free-form query: { query: "some params" }
|
| 405 | 2) field params:
|
| 406 | {
|
| 407 | name: "Object Name",
|
| 408 | description: "optional description"
|
| 409 | customFields: {
|
| 410 | param1: "value"
|
| 411 | }
|
| 412 | }
|
| 413 | </div>
|
| 414 |
|
| 415 |
|
| 416 |
|
| 417 |
|
| 418 |
|
| 419 |
|
| 420 |
|
| 421 | <dl class="details">
|
| 422 |
|
| 423 |
|
| 424 |
|
| 425 |
|
| 426 |
|
| 427 |
|
| 428 |
|
| 429 |
|
| 430 |
|
| 431 |
|
| 432 |
|
| 433 |
|
| 434 |
|
| 435 |
|
| 436 |
|
| 437 |
|
| 438 |
|
| 439 |
|
| 440 |
|
| 441 |
|
| 442 |
|
| 443 |
|
| 444 |
|
| 445 |
|
| 446 |
|
| 447 |
|
| 448 | <dt class="tag-source">Source:</dt>
|
| 449 | <dd class="tag-source"><ul class="dummy"><li>
|
| 450 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line160">line 160</a>
|
| 451 | </li></ul></dd>
|
| 452 |
|
| 453 |
|
| 454 |
|
| 455 |
|
| 456 |
|
| 457 |
|
| 458 |
|
| 459 | </dl>
|
| 460 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 464 |
|
| 465 |
|
| 466 |
|
| 467 |
|
| 468 |
|
| 469 |
|
| 470 | <h3 class="subsection-title">Methods</h3>
|
| 471 |
|
| 472 |
|
| 473 |
|
| 474 |
|
| 475 |
|
| 476 |
|
| 477 | <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(wo)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 478 |
|
| 479 |
|
| 480 |
|
| 481 |
|
| 482 |
|
| 483 | <div class="description">
|
| 484 | Create a Service Object from an object or a WebObject
|
| 485 | </div>
|
| 486 |
|
| 487 |
|
| 488 |
|
| 489 |
|
| 490 |
|
| 491 |
|
| 492 |
|
| 493 |
|
| 494 |
|
| 495 | <h5>Parameters:</h5>
|
| 496 |
|
| 497 |
|
| 498 | <table class="params">
|
| 499 | <thead>
|
| 500 | <tr>
|
| 501 |
|
| 502 | <th>Name</th>
|
| 503 |
|
| 504 |
|
| 505 | <th>Type</th>
|
| 506 |
|
| 507 |
|
| 508 |
|
| 509 |
|
| 510 |
|
| 511 | <th class="last">Description</th>
|
| 512 | </tr>
|
| 513 | </thead>
|
| 514 |
|
| 515 | <tbody>
|
| 516 |
|
| 517 |
|
| 518 | <tr>
|
| 519 |
|
| 520 | <td class="name"><code>wo</code></td>
|
| 521 |
|
| 522 |
|
| 523 | <td class="type">
|
| 524 |
|
| 525 |
|
| 526 | <span class="param-type">Object</span>
|
| 527 |
|
| 528 |
|
| 529 |
|
| 530 | </td>
|
| 531 |
|
| 532 |
|
| 533 |
|
| 534 |
|
| 535 |
|
| 536 | <td class="description last">ServiceObject compatible definition object or WebObject</td>
|
| 537 | </tr>
|
| 538 |
|
| 539 |
|
| 540 | </tbody>
|
| 541 | </table>
|
| 542 |
|
| 543 |
|
| 544 |
|
| 545 |
|
| 546 |
|
| 547 |
|
| 548 | <dl class="details">
|
| 549 |
|
| 550 |
|
| 551 |
|
| 552 |
|
| 553 |
|
| 554 |
|
| 555 |
|
| 556 |
|
| 557 |
|
| 558 |
|
| 559 |
|
| 560 |
|
| 561 |
|
| 562 |
|
| 563 |
|
| 564 |
|
| 565 |
|
| 566 |
|
| 567 |
|
| 568 |
|
| 569 |
|
| 570 |
|
| 571 |
|
| 572 |
|
| 573 |
|
| 574 |
|
| 575 | <dt class="tag-source">Source:</dt>
|
| 576 | <dd class="tag-source"><ul class="dummy"><li>
|
| 577 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line99">line 99</a>
|
| 578 | </li></ul></dd>
|
| 579 |
|
| 580 |
|
| 581 |
|
| 582 |
|
| 583 |
|
| 584 |
|
| 585 |
|
| 586 | </dl>
|
| 587 |
|
| 588 |
|
| 589 |
|
| 590 |
|
| 591 |
|
| 592 |
|
| 593 |
|
| 594 |
|
| 595 |
|
| 596 |
|
| 597 |
|
| 598 |
|
| 599 |
|
| 600 | <h5>Returns:</h5>
|
| 601 |
|
| 602 |
|
| 603 | <div class="param-desc">
|
| 604 | Promise for the future ServiceObject created
|
| 605 | </div>
|
| 606 |
|
| 607 |
|
| 608 |
|
| 609 | <dl>
|
| 610 | <dt>
|
| 611 | Type
|
| 612 | </dt>
|
| 613 | <dd>
|
| 614 |
|
| 615 | <span class="param-type">Promise</span>
|
| 616 |
|
| 617 |
|
| 618 | </dd>
|
| 619 | </dl>
|
| 620 |
|
| 621 |
|
| 622 |
|
| 623 |
|
| 624 |
|
| 625 |
|
| 626 |
|
| 627 |
|
| 628 |
|
| 629 |
|
| 630 | <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(wo)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 631 |
|
| 632 |
|
| 633 |
|
| 634 |
|
| 635 |
|
| 636 | <div class="description">
|
| 637 | Create a Service Object from an object or a WebObject
|
| 638 | </div>
|
| 639 |
|
| 640 |
|
| 641 |
|
| 642 |
|
| 643 |
|
| 644 |
|
| 645 |
|
| 646 |
|
| 647 |
|
| 648 | <h5>Parameters:</h5>
|
| 649 |
|
| 650 |
|
| 651 | <table class="params">
|
| 652 | <thead>
|
| 653 | <tr>
|
| 654 |
|
| 655 | <th>Name</th>
|
| 656 |
|
| 657 |
|
| 658 | <th>Type</th>
|
| 659 |
|
| 660 |
|
| 661 |
|
| 662 |
|
| 663 |
|
| 664 | <th class="last">Description</th>
|
| 665 | </tr>
|
| 666 | </thead>
|
| 667 |
|
| 668 | <tbody>
|
| 669 |
|
| 670 |
|
| 671 | <tr>
|
| 672 |
|
| 673 | <td class="name"><code>wo</code></td>
|
| 674 |
|
| 675 |
|
| 676 | <td class="type">
|
| 677 |
|
| 678 |
|
| 679 | <span class="param-type">Object</span>
|
| 680 |
|
| 681 |
|
| 682 |
|
| 683 | </td>
|
| 684 |
|
| 685 |
|
| 686 |
|
| 687 |
|
| 688 |
|
| 689 | <td class="description last">ServiceObject compatible definition object or WebObject</td>
|
| 690 | </tr>
|
| 691 |
|
| 692 |
|
| 693 | </tbody>
|
| 694 | </table>
|
| 695 |
|
| 696 |
|
| 697 |
|
| 698 |
|
| 699 |
|
| 700 |
|
| 701 | <dl class="details">
|
| 702 |
|
| 703 |
|
| 704 |
|
| 705 |
|
| 706 |
|
| 707 |
|
| 708 |
|
| 709 |
|
| 710 |
|
| 711 |
|
| 712 |
|
| 713 |
|
| 714 |
|
| 715 |
|
| 716 |
|
| 717 |
|
| 718 |
|
| 719 |
|
| 720 |
|
| 721 |
|
| 722 |
|
| 723 |
|
| 724 |
|
| 725 |
|
| 726 |
|
| 727 |
|
| 728 | <dt class="tag-source">Source:</dt>
|
| 729 | <dd class="tag-source"><ul class="dummy"><li>
|
| 730 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line99">line 99</a>
|
| 731 | </li></ul></dd>
|
| 732 |
|
| 733 |
|
| 734 |
|
| 735 |
|
| 736 |
|
| 737 |
|
| 738 |
|
| 739 | </dl>
|
| 740 |
|
| 741 |
|
| 742 |
|
| 743 |
|
| 744 |
|
| 745 |
|
| 746 |
|
| 747 |
|
| 748 |
|
| 749 |
|
| 750 |
|
| 751 |
|
| 752 |
|
| 753 | <h5>Returns:</h5>
|
| 754 |
|
| 755 |
|
| 756 | <div class="param-desc">
|
| 757 | Promise for the future ServiceObject created
|
| 758 | </div>
|
| 759 |
|
| 760 |
|
| 761 |
|
| 762 | <dl>
|
| 763 | <dt>
|
| 764 | Type
|
| 765 | </dt>
|
| 766 | <dd>
|
| 767 |
|
| 768 | <span class="param-type">Promise</span>
|
| 769 |
|
| 770 |
|
| 771 | </dd>
|
| 772 | </dl>
|
| 773 |
|
| 774 |
|
| 775 |
|
| 776 |
|
| 777 |
|
| 778 |
|
| 779 |
|
| 780 |
|
| 781 |
|
| 782 |
|
| 783 | <h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(objectId)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 784 |
|
| 785 |
|
| 786 |
|
| 787 |
|
| 788 |
|
| 789 | <div class="description">
|
| 790 | Delete a Service Object by id
|
| 791 | </div>
|
| 792 |
|
| 793 |
|
| 794 |
|
| 795 |
|
| 796 |
|
| 797 |
|
| 798 |
|
| 799 |
|
| 800 |
|
| 801 | <h5>Parameters:</h5>
|
| 802 |
|
| 803 |
|
| 804 | <table class="params">
|
| 805 | <thead>
|
| 806 | <tr>
|
| 807 |
|
| 808 | <th>Name</th>
|
| 809 |
|
| 810 |
|
| 811 | <th>Type</th>
|
| 812 |
|
| 813 |
|
| 814 |
|
| 815 |
|
| 816 |
|
| 817 | <th class="last">Description</th>
|
| 818 | </tr>
|
| 819 | </thead>
|
| 820 |
|
| 821 | <tbody>
|
| 822 |
|
| 823 |
|
| 824 | <tr>
|
| 825 |
|
| 826 | <td class="name"><code>objectId</code></td>
|
| 827 |
|
| 828 |
|
| 829 | <td class="type">
|
| 830 |
|
| 831 |
|
| 832 | <span class="param-type">String</span>
|
| 833 |
|
| 834 |
|
| 835 |
|
| 836 | </td>
|
| 837 |
|
| 838 |
|
| 839 |
|
| 840 |
|
| 841 |
|
| 842 | <td class="description last">ServiceObject id</td>
|
| 843 | </tr>
|
| 844 |
|
| 845 |
|
| 846 | </tbody>
|
| 847 | </table>
|
| 848 |
|
| 849 |
|
| 850 |
|
| 851 |
|
| 852 |
|
| 853 |
|
| 854 | <dl class="details">
|
| 855 |
|
| 856 |
|
| 857 |
|
| 858 |
|
| 859 |
|
| 860 |
|
| 861 |
|
| 862 |
|
| 863 |
|
| 864 |
|
| 865 |
|
| 866 |
|
| 867 |
|
| 868 |
|
| 869 |
|
| 870 |
|
| 871 |
|
| 872 |
|
| 873 |
|
| 874 |
|
| 875 |
|
| 876 |
|
| 877 |
|
| 878 |
|
| 879 |
|
| 880 |
|
| 881 | <dt class="tag-source">Source:</dt>
|
| 882 | <dd class="tag-source"><ul class="dummy"><li>
|
| 883 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line111">line 111</a>
|
| 884 | </li></ul></dd>
|
| 885 |
|
| 886 |
|
| 887 |
|
| 888 |
|
| 889 |
|
| 890 |
|
| 891 |
|
| 892 | </dl>
|
| 893 |
|
| 894 |
|
| 895 |
|
| 896 |
|
| 897 |
|
| 898 |
|
| 899 |
|
| 900 |
|
| 901 |
|
| 902 |
|
| 903 |
|
| 904 |
|
| 905 |
|
| 906 | <h5>Returns:</h5>
|
| 907 |
|
| 908 |
|
| 909 | <div class="param-desc">
|
| 910 | Promise for the future result of the operation
|
| 911 | </div>
|
| 912 |
|
| 913 |
|
| 914 |
|
| 915 | <dl>
|
| 916 | <dt>
|
| 917 | Type
|
| 918 | </dt>
|
| 919 | <dd>
|
| 920 |
|
| 921 | <span class="param-type">Promise</span>
|
| 922 |
|
| 923 |
|
| 924 | </dd>
|
| 925 | </dl>
|
| 926 |
|
| 927 |
|
| 928 |
|
| 929 |
|
| 930 |
|
| 931 |
|
| 932 |
|
| 933 |
|
| 934 |
|
| 935 |
|
| 936 | <h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(objectId)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 937 |
|
| 938 |
|
| 939 |
|
| 940 |
|
| 941 |
|
| 942 | <div class="description">
|
| 943 | Delete a Service Object by id
|
| 944 | </div>
|
| 945 |
|
| 946 |
|
| 947 |
|
| 948 |
|
| 949 |
|
| 950 |
|
| 951 |
|
| 952 |
|
| 953 |
|
| 954 | <h5>Parameters:</h5>
|
| 955 |
|
| 956 |
|
| 957 | <table class="params">
|
| 958 | <thead>
|
| 959 | <tr>
|
| 960 |
|
| 961 | <th>Name</th>
|
| 962 |
|
| 963 |
|
| 964 | <th>Type</th>
|
| 965 |
|
| 966 |
|
| 967 |
|
| 968 |
|
| 969 |
|
| 970 | <th class="last">Description</th>
|
| 971 | </tr>
|
| 972 | </thead>
|
| 973 |
|
| 974 | <tbody>
|
| 975 |
|
| 976 |
|
| 977 | <tr>
|
| 978 |
|
| 979 | <td class="name"><code>objectId</code></td>
|
| 980 |
|
| 981 |
|
| 982 | <td class="type">
|
| 983 |
|
| 984 |
|
| 985 | <span class="param-type">String</span>
|
| 986 |
|
| 987 |
|
| 988 |
|
| 989 | </td>
|
| 990 |
|
| 991 |
|
| 992 |
|
| 993 |
|
| 994 |
|
| 995 | <td class="description last">ServiceObject id</td>
|
| 996 | </tr>
|
| 997 |
|
| 998 |
|
| 999 | </tbody>
|
| 1000 | </table>
|
| 1001 |
|
| 1002 |
|
| 1003 |
|
| 1004 |
|
| 1005 |
|
| 1006 |
|
| 1007 | <dl class="details">
|
| 1008 |
|
| 1009 |
|
| 1010 |
|
| 1011 |
|
| 1012 |
|
| 1013 |
|
| 1014 |
|
| 1015 |
|
| 1016 |
|
| 1017 |
|
| 1018 |
|
| 1019 |
|
| 1020 |
|
| 1021 |
|
| 1022 |
|
| 1023 |
|
| 1024 |
|
| 1025 |
|
| 1026 |
|
| 1027 |
|
| 1028 |
|
| 1029 |
|
| 1030 |
|
| 1031 |
|
| 1032 |
|
| 1033 |
|
| 1034 | <dt class="tag-source">Source:</dt>
|
| 1035 | <dd class="tag-source"><ul class="dummy"><li>
|
| 1036 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line111">line 111</a>
|
| 1037 | </li></ul></dd>
|
| 1038 |
|
| 1039 |
|
| 1040 |
|
| 1041 |
|
| 1042 |
|
| 1043 |
|
| 1044 |
|
| 1045 | </dl>
|
| 1046 |
|
| 1047 |
|
| 1048 |
|
| 1049 |
|
| 1050 |
|
| 1051 |
|
| 1052 |
|
| 1053 |
|
| 1054 |
|
| 1055 |
|
| 1056 |
|
| 1057 |
|
| 1058 |
|
| 1059 | <h5>Returns:</h5>
|
| 1060 |
|
| 1061 |
|
| 1062 | <div class="param-desc">
|
| 1063 | Promise for the future result of the operation
|
| 1064 | </div>
|
| 1065 |
|
| 1066 |
|
| 1067 |
|
| 1068 | <dl>
|
| 1069 | <dt>
|
| 1070 | Type
|
| 1071 | </dt>
|
| 1072 | <dd>
|
| 1073 |
|
| 1074 | <span class="param-type">Promise</span>
|
| 1075 |
|
| 1076 |
|
| 1077 | </dd>
|
| 1078 | </dl>
|
| 1079 |
|
| 1080 |
|
| 1081 |
|
| 1082 |
|
| 1083 |
|
| 1084 |
|
| 1085 |
|
| 1086 |
|
| 1087 |
|
| 1088 |
|
| 1089 | <h4 class="name" id="list"><span class="type-signature"></span>list<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
| 1090 |
|
| 1091 |
|
| 1092 |
|
| 1093 |
|
| 1094 |
|
| 1095 | <div class="description">
|
| 1096 | Retrieve all the Service Objects from a given user (identified by the Authorization header).
|
| 1097 | </div>
|
| 1098 |
|
| 1099 |
|
| 1100 |
|
| 1101 |
|
| 1102 |
|
| 1103 |
|
| 1104 |
|
| 1105 |
|
| 1106 |
|
| 1107 |
|
| 1108 |
|
| 1109 |
|
| 1110 |
|
| 1111 | <dl class="details">
|
| 1112 |
|
| 1113 |
|
| 1114 |
|
| 1115 |
|
| 1116 |
|
| 1117 |
|
| 1118 |
|
| 1119 |
|
| 1120 |
|
| 1121 |
|
| 1122 |
|
| 1123 |
|
| 1124 |
|
| 1125 |
|
| 1126 |
|
| 1127 |
|
| 1128 |
|
| 1129 |
|
| 1130 |
|
| 1131 |
|
| 1132 |
|
| 1133 |
|
| 1134 |
|
| 1135 |
|
| 1136 |
|
| 1137 |
|
| 1138 | <dt class="tag-source">Source:</dt>
|
| 1139 | <dd class="tag-source"><ul class="dummy"><li>
|
| 1140 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line136">line 136</a>
|
| 1141 | </li></ul></dd>
|
| 1142 |
|
| 1143 |
|
| 1144 |
|
| 1145 |
|
| 1146 |
|
| 1147 |
|
| 1148 |
|
| 1149 | </dl>
|
| 1150 |
|
| 1151 |
|
| 1152 |
|
| 1153 |
|
| 1154 |
|
| 1155 |
|
| 1156 |
|
| 1157 |
|
| 1158 |
|
| 1159 |
|
| 1160 |
|
| 1161 |
|
| 1162 |
|
| 1163 | <h5>Returns:</h5>
|
| 1164 |
|
| 1165 |
|
| 1166 |
|
| 1167 |
|
| 1168 | <dl>
|
| 1169 | <dt>
|
| 1170 | Type
|
| 1171 | </dt>
|
| 1172 | <dd>
|
| 1173 |
|
| 1174 | <span class="param-type">Promise</span>
|
| 1175 |
|
| 1176 |
|
| 1177 | </dd>
|
| 1178 | </dl>
|
| 1179 |
|
| 1180 |
|
| 1181 |
|
| 1182 |
|
| 1183 |
|
| 1184 |
|
| 1185 |
|
| 1186 |
|
| 1187 |
|
| 1188 |
|
| 1189 | <h4 class="name" id="list"><span class="type-signature"></span>list<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
| 1190 |
|
| 1191 |
|
| 1192 |
|
| 1193 |
|
| 1194 |
|
| 1195 | <div class="description">
|
| 1196 | Retrieve all the Service Objects from a given user (identified by the Authorization header).
|
| 1197 | </div>
|
| 1198 |
|
| 1199 |
|
| 1200 |
|
| 1201 |
|
| 1202 |
|
| 1203 |
|
| 1204 |
|
| 1205 |
|
| 1206 |
|
| 1207 |
|
| 1208 |
|
| 1209 |
|
| 1210 |
|
| 1211 | <dl class="details">
|
| 1212 |
|
| 1213 |
|
| 1214 |
|
| 1215 |
|
| 1216 |
|
| 1217 |
|
| 1218 |
|
| 1219 |
|
| 1220 |
|
| 1221 |
|
| 1222 |
|
| 1223 |
|
| 1224 |
|
| 1225 |
|
| 1226 |
|
| 1227 |
|
| 1228 |
|
| 1229 |
|
| 1230 |
|
| 1231 |
|
| 1232 |
|
| 1233 |
|
| 1234 |
|
| 1235 |
|
| 1236 |
|
| 1237 |
|
| 1238 | <dt class="tag-source">Source:</dt>
|
| 1239 | <dd class="tag-source"><ul class="dummy"><li>
|
| 1240 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line136">line 136</a>
|
| 1241 | </li></ul></dd>
|
| 1242 |
|
| 1243 |
|
| 1244 |
|
| 1245 |
|
| 1246 |
|
| 1247 |
|
| 1248 |
|
| 1249 | </dl>
|
| 1250 |
|
| 1251 |
|
| 1252 |
|
| 1253 |
|
| 1254 |
|
| 1255 |
|
| 1256 |
|
| 1257 |
|
| 1258 |
|
| 1259 |
|
| 1260 |
|
| 1261 |
|
| 1262 |
|
| 1263 | <h5>Returns:</h5>
|
| 1264 |
|
| 1265 |
|
| 1266 |
|
| 1267 |
|
| 1268 | <dl>
|
| 1269 | <dt>
|
| 1270 | Type
|
| 1271 | </dt>
|
| 1272 | <dd>
|
| 1273 |
|
| 1274 | <span class="param-type">Promise</span>
|
| 1275 |
|
| 1276 |
|
| 1277 | </dd>
|
| 1278 | </dl>
|
| 1279 |
|
| 1280 |
|
| 1281 |
|
| 1282 |
|
| 1283 |
|
| 1284 |
|
| 1285 |
|
| 1286 |
|
| 1287 |
|
| 1288 |
|
| 1289 | <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">(id)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 1290 |
|
| 1291 |
|
| 1292 |
|
| 1293 |
|
| 1294 |
|
| 1295 |
|
| 1296 |
|
| 1297 |
|
| 1298 |
|
| 1299 |
|
| 1300 |
|
| 1301 |
|
| 1302 |
|
| 1303 | <h5>Parameters:</h5>
|
| 1304 |
|
| 1305 |
|
| 1306 | <table class="params">
|
| 1307 | <thead>
|
| 1308 | <tr>
|
| 1309 |
|
| 1310 | <th>Name</th>
|
| 1311 |
|
| 1312 |
|
| 1313 | <th>Type</th>
|
| 1314 |
|
| 1315 |
|
| 1316 |
|
| 1317 |
|
| 1318 |
|
| 1319 | <th class="last">Description</th>
|
| 1320 | </tr>
|
| 1321 | </thead>
|
| 1322 |
|
| 1323 | <tbody>
|
| 1324 |
|
| 1325 |
|
| 1326 | <tr>
|
| 1327 |
|
| 1328 | <td class="name"><code>id</code></td>
|
| 1329 |
|
| 1330 |
|
| 1331 | <td class="type">
|
| 1332 |
|
| 1333 |
|
| 1334 | <span class="param-type">String</span>
|
| 1335 |
|
| 1336 |
|
| 1337 |
|
| 1338 | </td>
|
| 1339 |
|
| 1340 |
|
| 1341 |
|
| 1342 |
|
| 1343 |
|
| 1344 | <td class="description last">ServiceObject id</td>
|
| 1345 | </tr>
|
| 1346 |
|
| 1347 |
|
| 1348 | </tbody>
|
| 1349 | </table>
|
| 1350 |
|
| 1351 |
|
| 1352 |
|
| 1353 |
|
| 1354 |
|
| 1355 |
|
| 1356 | <dl class="details">
|
| 1357 |
|
| 1358 |
|
| 1359 |
|
| 1360 |
|
| 1361 |
|
| 1362 |
|
| 1363 |
|
| 1364 |
|
| 1365 |
|
| 1366 |
|
| 1367 |
|
| 1368 |
|
| 1369 |
|
| 1370 |
|
| 1371 |
|
| 1372 |
|
| 1373 |
|
| 1374 |
|
| 1375 |
|
| 1376 |
|
| 1377 |
|
| 1378 |
|
| 1379 |
|
| 1380 |
|
| 1381 |
|
| 1382 |
|
| 1383 | <dt class="tag-source">Source:</dt>
|
| 1384 | <dd class="tag-source"><ul class="dummy"><li>
|
| 1385 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line123">line 123</a>
|
| 1386 | </li></ul></dd>
|
| 1387 |
|
| 1388 |
|
| 1389 |
|
| 1390 |
|
| 1391 |
|
| 1392 |
|
| 1393 |
|
| 1394 | </dl>
|
| 1395 |
|
| 1396 |
|
| 1397 |
|
| 1398 |
|
| 1399 |
|
| 1400 |
|
| 1401 |
|
| 1402 |
|
| 1403 |
|
| 1404 |
|
| 1405 |
|
| 1406 |
|
| 1407 |
|
| 1408 | <h5>Returns:</h5>
|
| 1409 |
|
| 1410 |
|
| 1411 | <div class="param-desc">
|
| 1412 | A promise with the created SO
|
| 1413 | </div>
|
| 1414 |
|
| 1415 |
|
| 1416 |
|
| 1417 | <dl>
|
| 1418 | <dt>
|
| 1419 | Type
|
| 1420 | </dt>
|
| 1421 | <dd>
|
| 1422 |
|
| 1423 | <span class="param-type">Promise</span>
|
| 1424 |
|
| 1425 |
|
| 1426 | </dd>
|
| 1427 | </dl>
|
| 1428 |
|
| 1429 |
|
| 1430 |
|
| 1431 |
|
| 1432 |
|
| 1433 |
|
| 1434 |
|
| 1435 |
|
| 1436 |
|
| 1437 |
|
| 1438 | <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">(id)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 1439 |
|
| 1440 |
|
| 1441 |
|
| 1442 |
|
| 1443 |
|
| 1444 |
|
| 1445 |
|
| 1446 |
|
| 1447 |
|
| 1448 |
|
| 1449 |
|
| 1450 |
|
| 1451 |
|
| 1452 | <h5>Parameters:</h5>
|
| 1453 |
|
| 1454 |
|
| 1455 | <table class="params">
|
| 1456 | <thead>
|
| 1457 | <tr>
|
| 1458 |
|
| 1459 | <th>Name</th>
|
| 1460 |
|
| 1461 |
|
| 1462 | <th>Type</th>
|
| 1463 |
|
| 1464 |
|
| 1465 |
|
| 1466 |
|
| 1467 |
|
| 1468 | <th class="last">Description</th>
|
| 1469 | </tr>
|
| 1470 | </thead>
|
| 1471 |
|
| 1472 | <tbody>
|
| 1473 |
|
| 1474 |
|
| 1475 | <tr>
|
| 1476 |
|
| 1477 | <td class="name"><code>id</code></td>
|
| 1478 |
|
| 1479 |
|
| 1480 | <td class="type">
|
| 1481 |
|
| 1482 |
|
| 1483 | <span class="param-type">String</span>
|
| 1484 |
|
| 1485 |
|
| 1486 |
|
| 1487 | </td>
|
| 1488 |
|
| 1489 |
|
| 1490 |
|
| 1491 |
|
| 1492 |
|
| 1493 | <td class="description last">ServiceObject id</td>
|
| 1494 | </tr>
|
| 1495 |
|
| 1496 |
|
| 1497 | </tbody>
|
| 1498 | </table>
|
| 1499 |
|
| 1500 |
|
| 1501 |
|
| 1502 |
|
| 1503 |
|
| 1504 |
|
| 1505 | <dl class="details">
|
| 1506 |
|
| 1507 |
|
| 1508 |
|
| 1509 |
|
| 1510 |
|
| 1511 |
|
| 1512 |
|
| 1513 |
|
| 1514 |
|
| 1515 |
|
| 1516 |
|
| 1517 |
|
| 1518 |
|
| 1519 |
|
| 1520 |
|
| 1521 |
|
| 1522 |
|
| 1523 |
|
| 1524 |
|
| 1525 |
|
| 1526 |
|
| 1527 |
|
| 1528 |
|
| 1529 |
|
| 1530 |
|
| 1531 |
|
| 1532 | <dt class="tag-source">Source:</dt>
|
| 1533 | <dd class="tag-source"><ul class="dummy"><li>
|
| 1534 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line123">line 123</a>
|
| 1535 | </li></ul></dd>
|
| 1536 |
|
| 1537 |
|
| 1538 |
|
| 1539 |
|
| 1540 |
|
| 1541 |
|
| 1542 |
|
| 1543 | </dl>
|
| 1544 |
|
| 1545 |
|
| 1546 |
|
| 1547 |
|
| 1548 |
|
| 1549 |
|
| 1550 |
|
| 1551 |
|
| 1552 |
|
| 1553 |
|
| 1554 |
|
| 1555 |
|
| 1556 |
|
| 1557 | <h5>Returns:</h5>
|
| 1558 |
|
| 1559 |
|
| 1560 | <div class="param-desc">
|
| 1561 | A promise with the created SO
|
| 1562 | </div>
|
| 1563 |
|
| 1564 |
|
| 1565 |
|
| 1566 | <dl>
|
| 1567 | <dt>
|
| 1568 | Type
|
| 1569 | </dt>
|
| 1570 | <dd>
|
| 1571 |
|
| 1572 | <span class="param-type">Promise</span>
|
| 1573 |
|
| 1574 |
|
| 1575 | </dd>
|
| 1576 | </dl>
|
| 1577 |
|
| 1578 |
|
| 1579 |
|
| 1580 |
|
| 1581 |
|
| 1582 |
|
| 1583 |
|
| 1584 |
|
| 1585 |
|
| 1586 |
|
| 1587 |
|
| 1588 | </article>
|
| 1589 |
|
| 1590 | </section>
|
| 1591 |
|
| 1592 |
|
| 1593 |
|
| 1594 |
|
| 1595 |
|
| 1596 |
|
| 1597 |
|
| 1598 | <section>
|
| 1599 |
|
| 1600 | <header>
|
| 1601 |
|
| 1602 | <h2>Raptor</h2>
|
| 1603 |
|
| 1604 |
|
| 1605 | </header>
|
| 1606 |
|
| 1607 | <article>
|
| 1608 | <div class="container-overview">
|
| 1609 |
|
| 1610 |
|
| 1611 |
|
| 1612 |
|
| 1613 |
|
| 1614 | <h4 class="name" id="Raptor"><span class="type-signature"></span>new Raptor<span class="signature">(config)</span><span class="type-signature"></span></h4>
|
| 1615 |
|
| 1616 |
|
| 1617 |
|
| 1618 |
|
| 1619 |
|
| 1620 | <div class="description">
|
| 1621 | Raptor SDK wrapper
|
| 1622 | </div>
|
| 1623 |
|
| 1624 |
|
| 1625 |
|
| 1626 |
|
| 1627 |
|
| 1628 |
|
| 1629 |
|
| 1630 |
|
| 1631 |
|
| 1632 | <h5>Parameters:</h5>
|
| 1633 |
|
| 1634 |
|
| 1635 | <table class="params">
|
| 1636 | <thead>
|
| 1637 | <tr>
|
| 1638 |
|
| 1639 | <th>Name</th>
|
| 1640 |
|
| 1641 |
|
| 1642 | <th>Type</th>
|
| 1643 |
|
| 1644 |
|
| 1645 |
|
| 1646 |
|
| 1647 |
|
| 1648 | <th class="last">Description</th>
|
| 1649 | </tr>
|
| 1650 | </thead>
|
| 1651 |
|
| 1652 | <tbody>
|
| 1653 |
|
| 1654 |
|
| 1655 | <tr>
|
| 1656 |
|
| 1657 | <td class="name"><code>config</code></td>
|
| 1658 |
|
| 1659 |
|
| 1660 | <td class="type">
|
| 1661 |
|
| 1662 |
|
| 1663 | <span class="param-type">Object</span>
|
| 1664 |
|
| 1665 |
|
| 1666 |
|
| 1667 | </td>
|
| 1668 |
|
| 1669 |
|
| 1670 |
|
| 1671 |
|
| 1672 |
|
| 1673 | <td class="description last">configuration object</td>
|
| 1674 | </tr>
|
| 1675 |
|
| 1676 |
|
| 1677 | </tbody>
|
| 1678 | </table>
|
| 1679 |
|
| 1680 |
|
| 1681 |
|
| 1682 |
|
| 1683 |
|
| 1684 |
|
| 1685 | <dl class="details">
|
| 1686 |
|
| 1687 |
|
| 1688 |
|
| 1689 |
|
| 1690 |
|
| 1691 |
|
| 1692 |
|
| 1693 |
|
| 1694 |
|
| 1695 |
|
| 1696 |
|
| 1697 |
|
| 1698 |
|
| 1699 |
|
| 1700 |
|
| 1701 |
|
| 1702 |
|
| 1703 |
|
| 1704 | <dt class="tag-author">Author:</dt>
|
| 1705 | <dd class="tag-author">
|
| 1706 | <ul>
|
| 1707 | <li><a href="mailto:lcapra@fbk.eu">Luca Capra</a></li>
|
| 1708 | </ul>
|
| 1709 | </dd>
|
| 1710 |
|
| 1711 |
|
| 1712 |
|
| 1713 | <dt class="tag-copyright">Copyright:</dt>
|
| 1714 | <dd class="tag-copyright"><ul class="dummy"><li>CREATE-NET</li></ul></dd>
|
| 1715 |
|
| 1716 |
|
| 1717 |
|
| 1718 | <dt class="tag-license">License:</dt>
|
| 1719 | <dd class="tag-license"><ul class="dummy"><li>Apache-2.0</li></ul></dd>
|
| 1720 |
|
| 1721 |
|
| 1722 |
|
| 1723 |
|
| 1724 |
|
| 1725 | <dt class="tag-source">Source:</dt>
|
| 1726 | <dd class="tag-source"><ul class="dummy"><li>
|
| 1727 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line34">line 34</a>
|
| 1728 | </li></ul></dd>
|
| 1729 |
|
| 1730 |
|
| 1731 |
|
| 1732 |
|
| 1733 |
|
| 1734 |
|
| 1735 |
|
| 1736 | </dl>
|
| 1737 |
|
| 1738 |
|
| 1739 |
|
| 1740 |
|
| 1741 |
|
| 1742 |
|
| 1743 |
|
| 1744 |
|
| 1745 |
|
| 1746 |
|
| 1747 |
|
| 1748 |
|
| 1749 |
|
| 1750 |
|
| 1751 |
|
| 1752 |
|
| 1753 |
|
| 1754 | </div>
|
| 1755 |
|
| 1756 |
|
| 1757 |
|
| 1758 |
|
| 1759 |
|
| 1760 |
|
| 1761 |
|
| 1762 |
|
| 1763 |
|
| 1764 |
|
| 1765 |
|
| 1766 |
|
| 1767 | <h3 class="subsection-title">Members</h3>
|
| 1768 |
|
| 1769 |
|
| 1770 |
|
| 1771 | <h4 class="name" id="client"><span class="type-signature"></span>client<span class="type-signature"></span></h4>
|
| 1772 |
|
| 1773 |
|
| 1774 |
|
| 1775 |
|
| 1776 | <div class="description">
|
| 1777 | Return a API client instance
|
| 1778 | </div>
|
| 1779 |
|
| 1780 |
|
| 1781 |
|
| 1782 |
|
| 1783 |
|
| 1784 |
|
| 1785 |
|
| 1786 | <dl class="details">
|
| 1787 |
|
| 1788 |
|
| 1789 |
|
| 1790 |
|
| 1791 |
|
| 1792 |
|
| 1793 |
|
| 1794 |
|
| 1795 |
|
| 1796 |
|
| 1797 |
|
| 1798 |
|
| 1799 |
|
| 1800 |
|
| 1801 |
|
| 1802 |
|
| 1803 |
|
| 1804 |
|
| 1805 |
|
| 1806 |
|
| 1807 |
|
| 1808 |
|
| 1809 |
|
| 1810 |
|
| 1811 |
|
| 1812 |
|
| 1813 | <dt class="tag-source">Source:</dt>
|
| 1814 | <dd class="tag-source"><ul class="dummy"><li>
|
| 1815 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line82">line 82</a>
|
| 1816 | </li></ul></dd>
|
| 1817 |
|
| 1818 |
|
| 1819 |
|
| 1820 |
|
| 1821 |
|
| 1822 |
|
| 1823 |
|
| 1824 | </dl>
|
| 1825 |
|
| 1826 |
|
| 1827 |
|
| 1828 |
|
| 1829 |
|
| 1830 |
|
| 1831 |
|
| 1832 |
|
| 1833 | <h4 class="name" id="client"><span class="type-signature"></span>client<span class="type-signature"></span></h4>
|
| 1834 |
|
| 1835 |
|
| 1836 |
|
| 1837 |
|
| 1838 | <div class="description">
|
| 1839 | Return a API client instance
|
| 1840 | </div>
|
| 1841 |
|
| 1842 |
|
| 1843 |
|
| 1844 |
|
| 1845 |
|
| 1846 |
|
| 1847 |
|
| 1848 | <dl class="details">
|
| 1849 |
|
| 1850 |
|
| 1851 |
|
| 1852 |
|
| 1853 |
|
| 1854 |
|
| 1855 |
|
| 1856 |
|
| 1857 |
|
| 1858 |
|
| 1859 |
|
| 1860 |
|
| 1861 |
|
| 1862 |
|
| 1863 |
|
| 1864 |
|
| 1865 |
|
| 1866 |
|
| 1867 |
|
| 1868 |
|
| 1869 |
|
| 1870 |
|
| 1871 |
|
| 1872 |
|
| 1873 |
|
| 1874 |
|
| 1875 | <dt class="tag-source">Source:</dt>
|
| 1876 | <dd class="tag-source"><ul class="dummy"><li>
|
| 1877 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line82">line 82</a>
|
| 1878 | </li></ul></dd>
|
| 1879 |
|
| 1880 |
|
| 1881 |
|
| 1882 |
|
| 1883 |
|
| 1884 |
|
| 1885 |
|
| 1886 | </dl>
|
| 1887 |
|
| 1888 |
|
| 1889 |
|
| 1890 |
|
| 1891 |
|
| 1892 |
|
| 1893 |
|
| 1894 |
|
| 1895 | <h4 class="name" id="find"><span class="type-signature"></span>find<span class="type-signature"></span></h4>
|
| 1896 |
|
| 1897 |
|
| 1898 |
|
| 1899 |
|
| 1900 | <div class="description">
|
| 1901 | Search for Service Objects.
|
| 1902 | Example parameters:
|
| 1903 | 1) free-form query: { query: "some params" }
|
| 1904 | 2) field params:
|
| 1905 | {
|
| 1906 | name: "Object Name",
|
| 1907 | description: "optional description"
|
| 1908 | customFields: {
|
| 1909 | param1: "value"
|
| 1910 | }
|
| 1911 | }
|
| 1912 | </div>
|
| 1913 |
|
| 1914 |
|
| 1915 |
|
| 1916 |
|
| 1917 |
|
| 1918 |
|
| 1919 |
|
| 1920 | <dl class="details">
|
| 1921 |
|
| 1922 |
|
| 1923 |
|
| 1924 |
|
| 1925 |
|
| 1926 |
|
| 1927 |
|
| 1928 |
|
| 1929 |
|
| 1930 |
|
| 1931 |
|
| 1932 |
|
| 1933 |
|
| 1934 |
|
| 1935 |
|
| 1936 |
|
| 1937 |
|
| 1938 |
|
| 1939 |
|
| 1940 |
|
| 1941 |
|
| 1942 |
|
| 1943 |
|
| 1944 |
|
| 1945 |
|
| 1946 |
|
| 1947 | <dt class="tag-source">Source:</dt>
|
| 1948 | <dd class="tag-source"><ul class="dummy"><li>
|
| 1949 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line160">line 160</a>
|
| 1950 | </li></ul></dd>
|
| 1951 |
|
| 1952 |
|
| 1953 |
|
| 1954 |
|
| 1955 |
|
| 1956 |
|
| 1957 |
|
| 1958 | </dl>
|
| 1959 |
|
| 1960 |
|
| 1961 |
|
| 1962 |
|
| 1963 |
|
| 1964 |
|
| 1965 |
|
| 1966 |
|
| 1967 | <h4 class="name" id="find"><span class="type-signature"></span>find<span class="type-signature"></span></h4>
|
| 1968 |
|
| 1969 |
|
| 1970 |
|
| 1971 |
|
| 1972 | <div class="description">
|
| 1973 | Search for Service Objects.
|
| 1974 | Example parameters:
|
| 1975 | 1) free-form query: { query: "some params" }
|
| 1976 | 2) field params:
|
| 1977 | {
|
| 1978 | name: "Object Name",
|
| 1979 | description: "optional description"
|
| 1980 | customFields: {
|
| 1981 | param1: "value"
|
| 1982 | }
|
| 1983 | }
|
| 1984 | </div>
|
| 1985 |
|
| 1986 |
|
| 1987 |
|
| 1988 |
|
| 1989 |
|
| 1990 |
|
| 1991 |
|
| 1992 | <dl class="details">
|
| 1993 |
|
| 1994 |
|
| 1995 |
|
| 1996 |
|
| 1997 |
|
| 1998 |
|
| 1999 |
|
| 2000 |
|
| 2001 |
|
| 2002 |
|
| 2003 |
|
| 2004 |
|
| 2005 |
|
| 2006 |
|
| 2007 |
|
| 2008 |
|
| 2009 |
|
| 2010 |
|
| 2011 |
|
| 2012 |
|
| 2013 |
|
| 2014 |
|
| 2015 |
|
| 2016 |
|
| 2017 |
|
| 2018 |
|
| 2019 | <dt class="tag-source">Source:</dt>
|
| 2020 | <dd class="tag-source"><ul class="dummy"><li>
|
| 2021 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line160">line 160</a>
|
| 2022 | </li></ul></dd>
|
| 2023 |
|
| 2024 |
|
| 2025 |
|
| 2026 |
|
| 2027 |
|
| 2028 |
|
| 2029 |
|
| 2030 | </dl>
|
| 2031 |
|
| 2032 |
|
| 2033 |
|
| 2034 |
|
| 2035 |
|
| 2036 |
|
| 2037 |
|
| 2038 |
|
| 2039 |
|
| 2040 |
|
| 2041 | <h3 class="subsection-title">Methods</h3>
|
| 2042 |
|
| 2043 |
|
| 2044 |
|
| 2045 |
|
| 2046 |
|
| 2047 |
|
| 2048 | <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(wo)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2049 |
|
| 2050 |
|
| 2051 |
|
| 2052 |
|
| 2053 |
|
| 2054 | <div class="description">
|
| 2055 | Create a Service Object from an object or a WebObject
|
| 2056 | </div>
|
| 2057 |
|
| 2058 |
|
| 2059 |
|
| 2060 |
|
| 2061 |
|
| 2062 |
|
| 2063 |
|
| 2064 |
|
| 2065 |
|
| 2066 | <h5>Parameters:</h5>
|
| 2067 |
|
| 2068 |
|
| 2069 | <table class="params">
|
| 2070 | <thead>
|
| 2071 | <tr>
|
| 2072 |
|
| 2073 | <th>Name</th>
|
| 2074 |
|
| 2075 |
|
| 2076 | <th>Type</th>
|
| 2077 |
|
| 2078 |
|
| 2079 |
|
| 2080 |
|
| 2081 |
|
| 2082 | <th class="last">Description</th>
|
| 2083 | </tr>
|
| 2084 | </thead>
|
| 2085 |
|
| 2086 | <tbody>
|
| 2087 |
|
| 2088 |
|
| 2089 | <tr>
|
| 2090 |
|
| 2091 | <td class="name"><code>wo</code></td>
|
| 2092 |
|
| 2093 |
|
| 2094 | <td class="type">
|
| 2095 |
|
| 2096 |
|
| 2097 | <span class="param-type">Object</span>
|
| 2098 |
|
| 2099 |
|
| 2100 |
|
| 2101 | </td>
|
| 2102 |
|
| 2103 |
|
| 2104 |
|
| 2105 |
|
| 2106 |
|
| 2107 | <td class="description last">ServiceObject compatible definition object or WebObject</td>
|
| 2108 | </tr>
|
| 2109 |
|
| 2110 |
|
| 2111 | </tbody>
|
| 2112 | </table>
|
| 2113 |
|
| 2114 |
|
| 2115 |
|
| 2116 |
|
| 2117 |
|
| 2118 |
|
| 2119 | <dl class="details">
|
| 2120 |
|
| 2121 |
|
| 2122 |
|
| 2123 |
|
| 2124 |
|
| 2125 |
|
| 2126 |
|
| 2127 |
|
| 2128 |
|
| 2129 |
|
| 2130 |
|
| 2131 |
|
| 2132 |
|
| 2133 |
|
| 2134 |
|
| 2135 |
|
| 2136 |
|
| 2137 |
|
| 2138 |
|
| 2139 |
|
| 2140 |
|
| 2141 |
|
| 2142 |
|
| 2143 |
|
| 2144 |
|
| 2145 |
|
| 2146 | <dt class="tag-source">Source:</dt>
|
| 2147 | <dd class="tag-source"><ul class="dummy"><li>
|
| 2148 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line99">line 99</a>
|
| 2149 | </li></ul></dd>
|
| 2150 |
|
| 2151 |
|
| 2152 |
|
| 2153 |
|
| 2154 |
|
| 2155 |
|
| 2156 |
|
| 2157 | </dl>
|
| 2158 |
|
| 2159 |
|
| 2160 |
|
| 2161 |
|
| 2162 |
|
| 2163 |
|
| 2164 |
|
| 2165 |
|
| 2166 |
|
| 2167 |
|
| 2168 |
|
| 2169 |
|
| 2170 |
|
| 2171 | <h5>Returns:</h5>
|
| 2172 |
|
| 2173 |
|
| 2174 | <div class="param-desc">
|
| 2175 | Promise for the future ServiceObject created
|
| 2176 | </div>
|
| 2177 |
|
| 2178 |
|
| 2179 |
|
| 2180 | <dl>
|
| 2181 | <dt>
|
| 2182 | Type
|
| 2183 | </dt>
|
| 2184 | <dd>
|
| 2185 |
|
| 2186 | <span class="param-type">Promise</span>
|
| 2187 |
|
| 2188 |
|
| 2189 | </dd>
|
| 2190 | </dl>
|
| 2191 |
|
| 2192 |
|
| 2193 |
|
| 2194 |
|
| 2195 |
|
| 2196 |
|
| 2197 |
|
| 2198 |
|
| 2199 |
|
| 2200 |
|
| 2201 | <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(wo)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2202 |
|
| 2203 |
|
| 2204 |
|
| 2205 |
|
| 2206 |
|
| 2207 | <div class="description">
|
| 2208 | Create a Service Object from an object or a WebObject
|
| 2209 | </div>
|
| 2210 |
|
| 2211 |
|
| 2212 |
|
| 2213 |
|
| 2214 |
|
| 2215 |
|
| 2216 |
|
| 2217 |
|
| 2218 |
|
| 2219 | <h5>Parameters:</h5>
|
| 2220 |
|
| 2221 |
|
| 2222 | <table class="params">
|
| 2223 | <thead>
|
| 2224 | <tr>
|
| 2225 |
|
| 2226 | <th>Name</th>
|
| 2227 |
|
| 2228 |
|
| 2229 | <th>Type</th>
|
| 2230 |
|
| 2231 |
|
| 2232 |
|
| 2233 |
|
| 2234 |
|
| 2235 | <th class="last">Description</th>
|
| 2236 | </tr>
|
| 2237 | </thead>
|
| 2238 |
|
| 2239 | <tbody>
|
| 2240 |
|
| 2241 |
|
| 2242 | <tr>
|
| 2243 |
|
| 2244 | <td class="name"><code>wo</code></td>
|
| 2245 |
|
| 2246 |
|
| 2247 | <td class="type">
|
| 2248 |
|
| 2249 |
|
| 2250 | <span class="param-type">Object</span>
|
| 2251 |
|
| 2252 |
|
| 2253 |
|
| 2254 | </td>
|
| 2255 |
|
| 2256 |
|
| 2257 |
|
| 2258 |
|
| 2259 |
|
| 2260 | <td class="description last">ServiceObject compatible definition object or WebObject</td>
|
| 2261 | </tr>
|
| 2262 |
|
| 2263 |
|
| 2264 | </tbody>
|
| 2265 | </table>
|
| 2266 |
|
| 2267 |
|
| 2268 |
|
| 2269 |
|
| 2270 |
|
| 2271 |
|
| 2272 | <dl class="details">
|
| 2273 |
|
| 2274 |
|
| 2275 |
|
| 2276 |
|
| 2277 |
|
| 2278 |
|
| 2279 |
|
| 2280 |
|
| 2281 |
|
| 2282 |
|
| 2283 |
|
| 2284 |
|
| 2285 |
|
| 2286 |
|
| 2287 |
|
| 2288 |
|
| 2289 |
|
| 2290 |
|
| 2291 |
|
| 2292 |
|
| 2293 |
|
| 2294 |
|
| 2295 |
|
| 2296 |
|
| 2297 |
|
| 2298 |
|
| 2299 | <dt class="tag-source">Source:</dt>
|
| 2300 | <dd class="tag-source"><ul class="dummy"><li>
|
| 2301 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line99">line 99</a>
|
| 2302 | </li></ul></dd>
|
| 2303 |
|
| 2304 |
|
| 2305 |
|
| 2306 |
|
| 2307 |
|
| 2308 |
|
| 2309 |
|
| 2310 | </dl>
|
| 2311 |
|
| 2312 |
|
| 2313 |
|
| 2314 |
|
| 2315 |
|
| 2316 |
|
| 2317 |
|
| 2318 |
|
| 2319 |
|
| 2320 |
|
| 2321 |
|
| 2322 |
|
| 2323 |
|
| 2324 | <h5>Returns:</h5>
|
| 2325 |
|
| 2326 |
|
| 2327 | <div class="param-desc">
|
| 2328 | Promise for the future ServiceObject created
|
| 2329 | </div>
|
| 2330 |
|
| 2331 |
|
| 2332 |
|
| 2333 | <dl>
|
| 2334 | <dt>
|
| 2335 | Type
|
| 2336 | </dt>
|
| 2337 | <dd>
|
| 2338 |
|
| 2339 | <span class="param-type">Promise</span>
|
| 2340 |
|
| 2341 |
|
| 2342 | </dd>
|
| 2343 | </dl>
|
| 2344 |
|
| 2345 |
|
| 2346 |
|
| 2347 |
|
| 2348 |
|
| 2349 |
|
| 2350 |
|
| 2351 |
|
| 2352 |
|
| 2353 |
|
| 2354 | <h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(objectId)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2355 |
|
| 2356 |
|
| 2357 |
|
| 2358 |
|
| 2359 |
|
| 2360 | <div class="description">
|
| 2361 | Delete a Service Object by id
|
| 2362 | </div>
|
| 2363 |
|
| 2364 |
|
| 2365 |
|
| 2366 |
|
| 2367 |
|
| 2368 |
|
| 2369 |
|
| 2370 |
|
| 2371 |
|
| 2372 | <h5>Parameters:</h5>
|
| 2373 |
|
| 2374 |
|
| 2375 | <table class="params">
|
| 2376 | <thead>
|
| 2377 | <tr>
|
| 2378 |
|
| 2379 | <th>Name</th>
|
| 2380 |
|
| 2381 |
|
| 2382 | <th>Type</th>
|
| 2383 |
|
| 2384 |
|
| 2385 |
|
| 2386 |
|
| 2387 |
|
| 2388 | <th class="last">Description</th>
|
| 2389 | </tr>
|
| 2390 | </thead>
|
| 2391 |
|
| 2392 | <tbody>
|
| 2393 |
|
| 2394 |
|
| 2395 | <tr>
|
| 2396 |
|
| 2397 | <td class="name"><code>objectId</code></td>
|
| 2398 |
|
| 2399 |
|
| 2400 | <td class="type">
|
| 2401 |
|
| 2402 |
|
| 2403 | <span class="param-type">String</span>
|
| 2404 |
|
| 2405 |
|
| 2406 |
|
| 2407 | </td>
|
| 2408 |
|
| 2409 |
|
| 2410 |
|
| 2411 |
|
| 2412 |
|
| 2413 | <td class="description last">ServiceObject id</td>
|
| 2414 | </tr>
|
| 2415 |
|
| 2416 |
|
| 2417 | </tbody>
|
| 2418 | </table>
|
| 2419 |
|
| 2420 |
|
| 2421 |
|
| 2422 |
|
| 2423 |
|
| 2424 |
|
| 2425 | <dl class="details">
|
| 2426 |
|
| 2427 |
|
| 2428 |
|
| 2429 |
|
| 2430 |
|
| 2431 |
|
| 2432 |
|
| 2433 |
|
| 2434 |
|
| 2435 |
|
| 2436 |
|
| 2437 |
|
| 2438 |
|
| 2439 |
|
| 2440 |
|
| 2441 |
|
| 2442 |
|
| 2443 |
|
| 2444 |
|
| 2445 |
|
| 2446 |
|
| 2447 |
|
| 2448 |
|
| 2449 |
|
| 2450 |
|
| 2451 |
|
| 2452 | <dt class="tag-source">Source:</dt>
|
| 2453 | <dd class="tag-source"><ul class="dummy"><li>
|
| 2454 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line111">line 111</a>
|
| 2455 | </li></ul></dd>
|
| 2456 |
|
| 2457 |
|
| 2458 |
|
| 2459 |
|
| 2460 |
|
| 2461 |
|
| 2462 |
|
| 2463 | </dl>
|
| 2464 |
|
| 2465 |
|
| 2466 |
|
| 2467 |
|
| 2468 |
|
| 2469 |
|
| 2470 |
|
| 2471 |
|
| 2472 |
|
| 2473 |
|
| 2474 |
|
| 2475 |
|
| 2476 |
|
| 2477 | <h5>Returns:</h5>
|
| 2478 |
|
| 2479 |
|
| 2480 | <div class="param-desc">
|
| 2481 | Promise for the future result of the operation
|
| 2482 | </div>
|
| 2483 |
|
| 2484 |
|
| 2485 |
|
| 2486 | <dl>
|
| 2487 | <dt>
|
| 2488 | Type
|
| 2489 | </dt>
|
| 2490 | <dd>
|
| 2491 |
|
| 2492 | <span class="param-type">Promise</span>
|
| 2493 |
|
| 2494 |
|
| 2495 | </dd>
|
| 2496 | </dl>
|
| 2497 |
|
| 2498 |
|
| 2499 |
|
| 2500 |
|
| 2501 |
|
| 2502 |
|
| 2503 |
|
| 2504 |
|
| 2505 |
|
| 2506 |
|
| 2507 | <h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(objectId)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2508 |
|
| 2509 |
|
| 2510 |
|
| 2511 |
|
| 2512 |
|
| 2513 | <div class="description">
|
| 2514 | Delete a Service Object by id
|
| 2515 | </div>
|
| 2516 |
|
| 2517 |
|
| 2518 |
|
| 2519 |
|
| 2520 |
|
| 2521 |
|
| 2522 |
|
| 2523 |
|
| 2524 |
|
| 2525 | <h5>Parameters:</h5>
|
| 2526 |
|
| 2527 |
|
| 2528 | <table class="params">
|
| 2529 | <thead>
|
| 2530 | <tr>
|
| 2531 |
|
| 2532 | <th>Name</th>
|
| 2533 |
|
| 2534 |
|
| 2535 | <th>Type</th>
|
| 2536 |
|
| 2537 |
|
| 2538 |
|
| 2539 |
|
| 2540 |
|
| 2541 | <th class="last">Description</th>
|
| 2542 | </tr>
|
| 2543 | </thead>
|
| 2544 |
|
| 2545 | <tbody>
|
| 2546 |
|
| 2547 |
|
| 2548 | <tr>
|
| 2549 |
|
| 2550 | <td class="name"><code>objectId</code></td>
|
| 2551 |
|
| 2552 |
|
| 2553 | <td class="type">
|
| 2554 |
|
| 2555 |
|
| 2556 | <span class="param-type">String</span>
|
| 2557 |
|
| 2558 |
|
| 2559 |
|
| 2560 | </td>
|
| 2561 |
|
| 2562 |
|
| 2563 |
|
| 2564 |
|
| 2565 |
|
| 2566 | <td class="description last">ServiceObject id</td>
|
| 2567 | </tr>
|
| 2568 |
|
| 2569 |
|
| 2570 | </tbody>
|
| 2571 | </table>
|
| 2572 |
|
| 2573 |
|
| 2574 |
|
| 2575 |
|
| 2576 |
|
| 2577 |
|
| 2578 | <dl class="details">
|
| 2579 |
|
| 2580 |
|
| 2581 |
|
| 2582 |
|
| 2583 |
|
| 2584 |
|
| 2585 |
|
| 2586 |
|
| 2587 |
|
| 2588 |
|
| 2589 |
|
| 2590 |
|
| 2591 |
|
| 2592 |
|
| 2593 |
|
| 2594 |
|
| 2595 |
|
| 2596 |
|
| 2597 |
|
| 2598 |
|
| 2599 |
|
| 2600 |
|
| 2601 |
|
| 2602 |
|
| 2603 |
|
| 2604 |
|
| 2605 | <dt class="tag-source">Source:</dt>
|
| 2606 | <dd class="tag-source"><ul class="dummy"><li>
|
| 2607 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line111">line 111</a>
|
| 2608 | </li></ul></dd>
|
| 2609 |
|
| 2610 |
|
| 2611 |
|
| 2612 |
|
| 2613 |
|
| 2614 |
|
| 2615 |
|
| 2616 | </dl>
|
| 2617 |
|
| 2618 |
|
| 2619 |
|
| 2620 |
|
| 2621 |
|
| 2622 |
|
| 2623 |
|
| 2624 |
|
| 2625 |
|
| 2626 |
|
| 2627 |
|
| 2628 |
|
| 2629 |
|
| 2630 | <h5>Returns:</h5>
|
| 2631 |
|
| 2632 |
|
| 2633 | <div class="param-desc">
|
| 2634 | Promise for the future result of the operation
|
| 2635 | </div>
|
| 2636 |
|
| 2637 |
|
| 2638 |
|
| 2639 | <dl>
|
| 2640 | <dt>
|
| 2641 | Type
|
| 2642 | </dt>
|
| 2643 | <dd>
|
| 2644 |
|
| 2645 | <span class="param-type">Promise</span>
|
| 2646 |
|
| 2647 |
|
| 2648 | </dd>
|
| 2649 | </dl>
|
| 2650 |
|
| 2651 |
|
| 2652 |
|
| 2653 |
|
| 2654 |
|
| 2655 |
|
| 2656 |
|
| 2657 |
|
| 2658 |
|
| 2659 |
|
| 2660 | <h4 class="name" id="list"><span class="type-signature"></span>list<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2661 |
|
| 2662 |
|
| 2663 |
|
| 2664 |
|
| 2665 |
|
| 2666 | <div class="description">
|
| 2667 | Retrieve all the Service Objects from a given user (identified by the Authorization header).
|
| 2668 | </div>
|
| 2669 |
|
| 2670 |
|
| 2671 |
|
| 2672 |
|
| 2673 |
|
| 2674 |
|
| 2675 |
|
| 2676 |
|
| 2677 |
|
| 2678 |
|
| 2679 |
|
| 2680 |
|
| 2681 |
|
| 2682 | <dl class="details">
|
| 2683 |
|
| 2684 |
|
| 2685 |
|
| 2686 |
|
| 2687 |
|
| 2688 |
|
| 2689 |
|
| 2690 |
|
| 2691 |
|
| 2692 |
|
| 2693 |
|
| 2694 |
|
| 2695 |
|
| 2696 |
|
| 2697 |
|
| 2698 |
|
| 2699 |
|
| 2700 |
|
| 2701 |
|
| 2702 |
|
| 2703 |
|
| 2704 |
|
| 2705 |
|
| 2706 |
|
| 2707 |
|
| 2708 |
|
| 2709 | <dt class="tag-source">Source:</dt>
|
| 2710 | <dd class="tag-source"><ul class="dummy"><li>
|
| 2711 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line136">line 136</a>
|
| 2712 | </li></ul></dd>
|
| 2713 |
|
| 2714 |
|
| 2715 |
|
| 2716 |
|
| 2717 |
|
| 2718 |
|
| 2719 |
|
| 2720 | </dl>
|
| 2721 |
|
| 2722 |
|
| 2723 |
|
| 2724 |
|
| 2725 |
|
| 2726 |
|
| 2727 |
|
| 2728 |
|
| 2729 |
|
| 2730 |
|
| 2731 |
|
| 2732 |
|
| 2733 |
|
| 2734 | <h5>Returns:</h5>
|
| 2735 |
|
| 2736 |
|
| 2737 |
|
| 2738 |
|
| 2739 | <dl>
|
| 2740 | <dt>
|
| 2741 | Type
|
| 2742 | </dt>
|
| 2743 | <dd>
|
| 2744 |
|
| 2745 | <span class="param-type">Promise</span>
|
| 2746 |
|
| 2747 |
|
| 2748 | </dd>
|
| 2749 | </dl>
|
| 2750 |
|
| 2751 |
|
| 2752 |
|
| 2753 |
|
| 2754 |
|
| 2755 |
|
| 2756 |
|
| 2757 |
|
| 2758 |
|
| 2759 |
|
| 2760 | <h4 class="name" id="list"><span class="type-signature"></span>list<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2761 |
|
| 2762 |
|
| 2763 |
|
| 2764 |
|
| 2765 |
|
| 2766 | <div class="description">
|
| 2767 | Retrieve all the Service Objects from a given user (identified by the Authorization header).
|
| 2768 | </div>
|
| 2769 |
|
| 2770 |
|
| 2771 |
|
| 2772 |
|
| 2773 |
|
| 2774 |
|
| 2775 |
|
| 2776 |
|
| 2777 |
|
| 2778 |
|
| 2779 |
|
| 2780 |
|
| 2781 |
|
| 2782 | <dl class="details">
|
| 2783 |
|
| 2784 |
|
| 2785 |
|
| 2786 |
|
| 2787 |
|
| 2788 |
|
| 2789 |
|
| 2790 |
|
| 2791 |
|
| 2792 |
|
| 2793 |
|
| 2794 |
|
| 2795 |
|
| 2796 |
|
| 2797 |
|
| 2798 |
|
| 2799 |
|
| 2800 |
|
| 2801 |
|
| 2802 |
|
| 2803 |
|
| 2804 |
|
| 2805 |
|
| 2806 |
|
| 2807 |
|
| 2808 |
|
| 2809 | <dt class="tag-source">Source:</dt>
|
| 2810 | <dd class="tag-source"><ul class="dummy"><li>
|
| 2811 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line136">line 136</a>
|
| 2812 | </li></ul></dd>
|
| 2813 |
|
| 2814 |
|
| 2815 |
|
| 2816 |
|
| 2817 |
|
| 2818 |
|
| 2819 |
|
| 2820 | </dl>
|
| 2821 |
|
| 2822 |
|
| 2823 |
|
| 2824 |
|
| 2825 |
|
| 2826 |
|
| 2827 |
|
| 2828 |
|
| 2829 |
|
| 2830 |
|
| 2831 |
|
| 2832 |
|
| 2833 |
|
| 2834 | <h5>Returns:</h5>
|
| 2835 |
|
| 2836 |
|
| 2837 |
|
| 2838 |
|
| 2839 | <dl>
|
| 2840 | <dt>
|
| 2841 | Type
|
| 2842 | </dt>
|
| 2843 | <dd>
|
| 2844 |
|
| 2845 | <span class="param-type">Promise</span>
|
| 2846 |
|
| 2847 |
|
| 2848 | </dd>
|
| 2849 | </dl>
|
| 2850 |
|
| 2851 |
|
| 2852 |
|
| 2853 |
|
| 2854 |
|
| 2855 |
|
| 2856 |
|
| 2857 |
|
| 2858 |
|
| 2859 |
|
| 2860 | <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">(id)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2861 |
|
| 2862 |
|
| 2863 |
|
| 2864 |
|
| 2865 |
|
| 2866 |
|
| 2867 |
|
| 2868 |
|
| 2869 |
|
| 2870 |
|
| 2871 |
|
| 2872 |
|
| 2873 |
|
| 2874 | <h5>Parameters:</h5>
|
| 2875 |
|
| 2876 |
|
| 2877 | <table class="params">
|
| 2878 | <thead>
|
| 2879 | <tr>
|
| 2880 |
|
| 2881 | <th>Name</th>
|
| 2882 |
|
| 2883 |
|
| 2884 | <th>Type</th>
|
| 2885 |
|
| 2886 |
|
| 2887 |
|
| 2888 |
|
| 2889 |
|
| 2890 | <th class="last">Description</th>
|
| 2891 | </tr>
|
| 2892 | </thead>
|
| 2893 |
|
| 2894 | <tbody>
|
| 2895 |
|
| 2896 |
|
| 2897 | <tr>
|
| 2898 |
|
| 2899 | <td class="name"><code>id</code></td>
|
| 2900 |
|
| 2901 |
|
| 2902 | <td class="type">
|
| 2903 |
|
| 2904 |
|
| 2905 | <span class="param-type">String</span>
|
| 2906 |
|
| 2907 |
|
| 2908 |
|
| 2909 | </td>
|
| 2910 |
|
| 2911 |
|
| 2912 |
|
| 2913 |
|
| 2914 |
|
| 2915 | <td class="description last">ServiceObject id</td>
|
| 2916 | </tr>
|
| 2917 |
|
| 2918 |
|
| 2919 | </tbody>
|
| 2920 | </table>
|
| 2921 |
|
| 2922 |
|
| 2923 |
|
| 2924 |
|
| 2925 |
|
| 2926 |
|
| 2927 | <dl class="details">
|
| 2928 |
|
| 2929 |
|
| 2930 |
|
| 2931 |
|
| 2932 |
|
| 2933 |
|
| 2934 |
|
| 2935 |
|
| 2936 |
|
| 2937 |
|
| 2938 |
|
| 2939 |
|
| 2940 |
|
| 2941 |
|
| 2942 |
|
| 2943 |
|
| 2944 |
|
| 2945 |
|
| 2946 |
|
| 2947 |
|
| 2948 |
|
| 2949 |
|
| 2950 |
|
| 2951 |
|
| 2952 |
|
| 2953 |
|
| 2954 | <dt class="tag-source">Source:</dt>
|
| 2955 | <dd class="tag-source"><ul class="dummy"><li>
|
| 2956 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line123">line 123</a>
|
| 2957 | </li></ul></dd>
|
| 2958 |
|
| 2959 |
|
| 2960 |
|
| 2961 |
|
| 2962 |
|
| 2963 |
|
| 2964 |
|
| 2965 | </dl>
|
| 2966 |
|
| 2967 |
|
| 2968 |
|
| 2969 |
|
| 2970 |
|
| 2971 |
|
| 2972 |
|
| 2973 |
|
| 2974 |
|
| 2975 |
|
| 2976 |
|
| 2977 |
|
| 2978 |
|
| 2979 | <h5>Returns:</h5>
|
| 2980 |
|
| 2981 |
|
| 2982 | <div class="param-desc">
|
| 2983 | A promise with the created SO
|
| 2984 | </div>
|
| 2985 |
|
| 2986 |
|
| 2987 |
|
| 2988 | <dl>
|
| 2989 | <dt>
|
| 2990 | Type
|
| 2991 | </dt>
|
| 2992 | <dd>
|
| 2993 |
|
| 2994 | <span class="param-type">Promise</span>
|
| 2995 |
|
| 2996 |
|
| 2997 | </dd>
|
| 2998 | </dl>
|
| 2999 |
|
| 3000 |
|
| 3001 |
|
| 3002 |
|
| 3003 |
|
| 3004 |
|
| 3005 |
|
| 3006 |
|
| 3007 |
|
| 3008 |
|
| 3009 | <h4 class="name" id="load"><span class="type-signature"></span>load<span class="signature">(id)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 3010 |
|
| 3011 |
|
| 3012 |
|
| 3013 |
|
| 3014 |
|
| 3015 |
|
| 3016 |
|
| 3017 |
|
| 3018 |
|
| 3019 |
|
| 3020 |
|
| 3021 |
|
| 3022 |
|
| 3023 | <h5>Parameters:</h5>
|
| 3024 |
|
| 3025 |
|
| 3026 | <table class="params">
|
| 3027 | <thead>
|
| 3028 | <tr>
|
| 3029 |
|
| 3030 | <th>Name</th>
|
| 3031 |
|
| 3032 |
|
| 3033 | <th>Type</th>
|
| 3034 |
|
| 3035 |
|
| 3036 |
|
| 3037 |
|
| 3038 |
|
| 3039 | <th class="last">Description</th>
|
| 3040 | </tr>
|
| 3041 | </thead>
|
| 3042 |
|
| 3043 | <tbody>
|
| 3044 |
|
| 3045 |
|
| 3046 | <tr>
|
| 3047 |
|
| 3048 | <td class="name"><code>id</code></td>
|
| 3049 |
|
| 3050 |
|
| 3051 | <td class="type">
|
| 3052 |
|
| 3053 |
|
| 3054 | <span class="param-type">String</span>
|
| 3055 |
|
| 3056 |
|
| 3057 |
|
| 3058 | </td>
|
| 3059 |
|
| 3060 |
|
| 3061 |
|
| 3062 |
|
| 3063 |
|
| 3064 | <td class="description last">ServiceObject id</td>
|
| 3065 | </tr>
|
| 3066 |
|
| 3067 |
|
| 3068 | </tbody>
|
| 3069 | </table>
|
| 3070 |
|
| 3071 |
|
| 3072 |
|
| 3073 |
|
| 3074 |
|
| 3075 |
|
| 3076 | <dl class="details">
|
| 3077 |
|
| 3078 |
|
| 3079 |
|
| 3080 |
|
| 3081 |
|
| 3082 |
|
| 3083 |
|
| 3084 |
|
| 3085 |
|
| 3086 |
|
| 3087 |
|
| 3088 |
|
| 3089 |
|
| 3090 |
|
| 3091 |
|
| 3092 |
|
| 3093 |
|
| 3094 |
|
| 3095 |
|
| 3096 |
|
| 3097 |
|
| 3098 |
|
| 3099 |
|
| 3100 |
|
| 3101 |
|
| 3102 |
|
| 3103 | <dt class="tag-source">Source:</dt>
|
| 3104 | <dd class="tag-source"><ul class="dummy"><li>
|
| 3105 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line123">line 123</a>
|
| 3106 | </li></ul></dd>
|
| 3107 |
|
| 3108 |
|
| 3109 |
|
| 3110 |
|
| 3111 |
|
| 3112 |
|
| 3113 |
|
| 3114 | </dl>
|
| 3115 |
|
| 3116 |
|
| 3117 |
|
| 3118 |
|
| 3119 |
|
| 3120 |
|
| 3121 |
|
| 3122 |
|
| 3123 |
|
| 3124 |
|
| 3125 |
|
| 3126 |
|
| 3127 |
|
| 3128 | <h5>Returns:</h5>
|
| 3129 |
|
| 3130 |
|
| 3131 | <div class="param-desc">
|
| 3132 | A promise with the created SO
|
| 3133 | </div>
|
| 3134 |
|
| 3135 |
|
| 3136 |
|
| 3137 | <dl>
|
| 3138 | <dt>
|
| 3139 | Type
|
| 3140 | </dt>
|
| 3141 | <dd>
|
| 3142 |
|
| 3143 | <span class="param-type">Promise</span>
|
| 3144 |
|
| 3145 |
|
| 3146 | </dd>
|
| 3147 | </dl>
|
| 3148 |
|
| 3149 |
|
| 3150 |
|
| 3151 |
|
| 3152 |
|
| 3153 |
|
| 3154 |
|
| 3155 |
|
| 3156 |
|
| 3157 |
|
| 3158 |
|
| 3159 | </article>
|
| 3160 |
|
| 3161 | </section>
|
| 3162 |
|
| 3163 |
|
| 3164 |
|
| 3165 |
|
| 3166 | </div>
|
| 3167 |
|
| 3168 | <nav>
|
| 3169 | <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>
|
| 3170 | </nav>
|
| 3171 |
|
| 3172 | <br class="clear">
|
| 3173 |
|
| 3174 | <footer>
|
| 3175 | 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)
|
| 3176 | </footer>
|
| 3177 |
|
| 3178 | <script> prettyPrint(); </script>
|
| 3179 | <script src="scripts/linenumber.js"> </script>
|
| 3180 | </body>
|
| 3181 | </html> |
| \ | No newline at end of file |