opengate-js 12.1.1 → 12.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bower.json +1 -1
- package/dist/{opengate-api-bower-12.1.1.js → opengate-api-bower-12.2.0.js} +28 -18
- package/dist/opengate-api-bower-12.2.0.js.map +1 -0
- package/dist/{opengate-api-bower-12.1.1.min.js → opengate-api-bower-12.2.0.min.js} +34 -34
- package/dist/{opengate-api-bower-12.1.1.min.js.map → opengate-api-bower-12.2.0.min.js.map} +1 -1
- package/dist/src/GenericFinder.js +1 -0
- package/dist/src/GenericFinder.js.map +1 -1
- package/dist/src/provision/BaseProvision.js +2 -0
- package/dist/src/provision/BaseProvision.js.map +1 -1
- package/dist/src/searching/BaseSearch.js +1 -0
- package/dist/src/searching/BaseSearch.js.map +1 -1
- package/dist/src/searching/builder/HardwaresSearchBuilder.js +5 -5
- package/dist/src/searching/builder/HardwaresSearchBuilder.js.map +1 -1
- package/dist/src/users/Users.js +3 -3
- package/dist/src/util/NorthAmpliaREST.js +6 -0
- package/dist/src/util/NorthAmpliaREST.js.map +1 -1
- package/docs/ast/source/GenericFinder.js.json +4504 -4504
- package/docs/ast/source/provision/BaseProvision.js.json +9643 -9643
- package/docs/ast/source/searching/BaseSearch.js.json +7981 -7981
- package/docs/ast/source/searching/builder/HardwaresSearchBuilder.js.json +505 -505
- package/docs/ast/source/users/Users.js.json +7 -7
- package/docs/ast/source/util/NorthAmpliaREST.js.json +10803 -10803
- package/docs/class/src/GenericFinder.js~GenericFinder.html +10 -3
- package/docs/class/src/provision/BaseProvision.js~BaseProvision.html +19 -6
- package/docs/class/src/searching/BaseSearch.js~BaseSearch.html +15 -8
- package/docs/class/src/searching/builder/HardwaresSearchBuilder.js~HardwaresSearchBuilder.html +37 -2
- package/docs/class/src/searching/builder/SearchBuilder.js~SearchBuilder.html +2 -2
- package/docs/class/src/searching/builder/SearchWithSummaryBuilder.js~SearchWithSummaryBuilder.html +1 -1
- package/docs/class/src/users/Users.js~User.html +34 -34
- package/docs/class/src/util/NorthAmpliaREST.js~NorthAmpliaREST.html +61 -19
- package/docs/class/src/util/SouthAmpliaREST.js~SouthAmpliaREST.html +6 -6
- package/docs/coverage.json +2 -2
- package/docs/dump.json +189 -89
- package/docs/file/src/GenericFinder.js.html +1 -0
- package/docs/file/src/provision/BaseProvision.js.html +2 -0
- package/docs/file/src/searching/BaseSearch.js.html +1 -0
- package/docs/file/src/searching/builder/HardwaresSearchBuilder.js.html +2 -2
- package/docs/file/src/users/Users.js.html +2 -2
- package/docs/file/src/util/NorthAmpliaREST.js.html +6 -0
- package/docs/package.json +1 -1
- package/docs/script/search_index.js +6 -6
- package/docs/source.html +231 -231
- package/features/features/provision/analytics/create_delete_analytics.feature +0 -1
- package/features/features/provision/users/reset_password.feature +3 -3
- package/features/features/provision/users/reset_password_mock.feature +0 -1
- package/features/step_definitions/when_step_definitions.js +39 -37
- package/features/support/hooks.js +11 -10
- package/features/support/world.js +1 -2
- package/package.json +1 -1
- package/src/GenericFinder.js +1 -0
- package/src/provision/BaseProvision.js +2 -0
- package/src/searching/BaseSearch.js +1 -0
- package/src/searching/builder/HardwaresSearchBuilder.js +2 -2
- package/src/users/Users.js +2 -2
- package/src/util/NorthAmpliaREST.js +6 -0
- package/dist/opengate-api-bower-12.1.1.js.map +0 -1
|
@@ -336,7 +336,7 @@
|
|
|
336
336
|
<p>
|
|
337
337
|
|
|
338
338
|
|
|
339
|
-
<span data-ice="name"><span><a href="class/src/GenericFinder.js~GenericFinder.html#instance-constructor-constructor">constructor</a></span></span><span data-ice="signature">(ogapi: <span><a href="class/src/InternalOpenGateAPI.js~InternalOpenGateAPI.html">InternalOpenGateAPI</a></span>, source: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, reponseJsonData: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, error_not_found: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>)</span>
|
|
339
|
+
<span data-ice="name"><span><a href="class/src/GenericFinder.js~GenericFinder.html#instance-constructor-constructor">constructor</a></span></span><span data-ice="signature">(ogapi: <span><a href="class/src/InternalOpenGateAPI.js~InternalOpenGateAPI.html">InternalOpenGateAPI</a></span>, source: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, reponseJsonData: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, error_not_found: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, serviceBaseURL: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>)</span>
|
|
340
340
|
</p>
|
|
341
341
|
</div>
|
|
342
342
|
<div>
|
|
@@ -370,11 +370,11 @@
|
|
|
370
370
|
|
|
371
371
|
|
|
372
372
|
|
|
373
|
-
<span data-ice="name">constructor</span><span data-ice="signature">(ogapi: <span><a href="class/src/InternalOpenGateAPI.js~InternalOpenGateAPI.html">InternalOpenGateAPI</a></span>, source: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, reponseJsonData: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, error_not_found: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>)</span>
|
|
373
|
+
<span data-ice="name">constructor</span><span data-ice="signature">(ogapi: <span><a href="class/src/InternalOpenGateAPI.js~InternalOpenGateAPI.html">InternalOpenGateAPI</a></span>, source: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, reponseJsonData: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, error_not_found: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, serviceBaseURL: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>)</span>
|
|
374
374
|
<span class="right-info">
|
|
375
375
|
|
|
376
376
|
|
|
377
|
-
<span data-ice="source"><span><a href="file/src/GenericFinder.js.html#
|
|
377
|
+
<span data-ice="source"><span><a href="file/src/GenericFinder.js.html#lineNumber18">source</a></span></span>
|
|
378
378
|
</span>
|
|
379
379
|
</h3>
|
|
380
380
|
|
|
@@ -421,6 +421,13 @@
|
|
|
421
421
|
<td data-ice="description"><p>String error which will be thrown on not_found error.</p>
|
|
422
422
|
</td>
|
|
423
423
|
</tr>
|
|
424
|
+
<tr data-ice="property" data-depth="0">
|
|
425
|
+
<td data-ice="name" data-depth="0">serviceBaseURL</td>
|
|
426
|
+
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td>
|
|
427
|
+
<td data-ice="appendix"></td>
|
|
428
|
+
<td data-ice="description"><p>base of the uri petition</p>
|
|
429
|
+
</td>
|
|
430
|
+
</tr>
|
|
424
431
|
</tbody>
|
|
425
432
|
</table>
|
|
426
433
|
</div>
|
|
@@ -337,7 +337,7 @@ This class is responsible for managing the request to execute Norte OpenGate API
|
|
|
337
337
|
<p>
|
|
338
338
|
|
|
339
339
|
|
|
340
|
-
<span data-ice="name"><span><a href="class/src/provision/BaseProvision.js~BaseProvision.html#instance-constructor-constructor">constructor</a></span></span><span data-ice="signature">(ogapi: <span><a href="class/src/InternalOpenGateAPI.js~InternalOpenGateAPI.html">InternalOpenGateAPI</a></span>, resource: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, timeout: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>)</span>
|
|
340
|
+
<span data-ice="name"><span><a href="class/src/provision/BaseProvision.js~BaseProvision.html#instance-constructor-constructor">constructor</a></span></span><span data-ice="signature">(ogapi: <span><a href="class/src/InternalOpenGateAPI.js~InternalOpenGateAPI.html">InternalOpenGateAPI</a></span>, resource: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, timeout: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>, requiredParameters: <span>array</span>, serviceBaseURL: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>)</span>
|
|
341
341
|
</p>
|
|
342
342
|
</div>
|
|
343
343
|
<div>
|
|
@@ -464,11 +464,11 @@ This function updates a entity of provision</p>
|
|
|
464
464
|
|
|
465
465
|
|
|
466
466
|
|
|
467
|
-
<span data-ice="name">constructor</span><span data-ice="signature">(ogapi: <span><a href="class/src/InternalOpenGateAPI.js~InternalOpenGateAPI.html">InternalOpenGateAPI</a></span>, resource: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, timeout: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>)</span>
|
|
467
|
+
<span data-ice="name">constructor</span><span data-ice="signature">(ogapi: <span><a href="class/src/InternalOpenGateAPI.js~InternalOpenGateAPI.html">InternalOpenGateAPI</a></span>, resource: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, timeout: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>, requiredParameters: <span>array</span>, serviceBaseURL: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>)</span>
|
|
468
468
|
<span class="right-info">
|
|
469
469
|
|
|
470
470
|
|
|
471
|
-
<span data-ice="source"><span><a href="file/src/provision/BaseProvision.js.html#
|
|
471
|
+
<span data-ice="source"><span><a href="file/src/provision/BaseProvision.js.html#lineNumber17">source</a></span></span>
|
|
472
472
|
</span>
|
|
473
473
|
</h3>
|
|
474
474
|
|
|
@@ -509,6 +509,19 @@ This function updates a entity of provision</p>
|
|
|
509
509
|
<td data-ice="description"><p>timeout on request</p>
|
|
510
510
|
</td>
|
|
511
511
|
</tr>
|
|
512
|
+
<tr data-ice="property" data-depth="0">
|
|
513
|
+
<td data-ice="name" data-depth="0">requiredParameters</td>
|
|
514
|
+
<td data-ice="type"><span>array</span></td>
|
|
515
|
+
<td data-ice="appendix"></td>
|
|
516
|
+
<td data-ice="description"></td>
|
|
517
|
+
</tr>
|
|
518
|
+
<tr data-ice="property" data-depth="0">
|
|
519
|
+
<td data-ice="name" data-depth="0">serviceBaseURL</td>
|
|
520
|
+
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td>
|
|
521
|
+
<td data-ice="appendix"></td>
|
|
522
|
+
<td data-ice="description"><p>base of the uri petition</p>
|
|
523
|
+
</td>
|
|
524
|
+
</tr>
|
|
512
525
|
</tbody>
|
|
513
526
|
</table>
|
|
514
527
|
</div>
|
|
@@ -547,7 +560,7 @@ This function updates a entity of provision</p>
|
|
|
547
560
|
<span class="right-info">
|
|
548
561
|
|
|
549
562
|
|
|
550
|
-
<span data-ice="source"><span><a href="file/src/provision/BaseProvision.js.html#
|
|
563
|
+
<span data-ice="source"><span><a href="file/src/provision/BaseProvision.js.html#lineNumber68">source</a></span></span>
|
|
551
564
|
</span>
|
|
552
565
|
</h3>
|
|
553
566
|
|
|
@@ -635,7 +648,7 @@ This function create a entity of provision</p>
|
|
|
635
648
|
<span class="right-info">
|
|
636
649
|
|
|
637
650
|
|
|
638
|
-
<span data-ice="source"><span><a href="file/src/provision/BaseProvision.js.html#
|
|
651
|
+
<span data-ice="source"><span><a href="file/src/provision/BaseProvision.js.html#lineNumber111">source</a></span></span>
|
|
639
652
|
</span>
|
|
640
653
|
</h3>
|
|
641
654
|
|
|
@@ -741,7 +754,7 @@ ogapi.certificatesBuilder().withId('d3l3t3-c3rt1f1c4t3').delete();</co
|
|
|
741
754
|
<span class="right-info">
|
|
742
755
|
|
|
743
756
|
|
|
744
|
-
<span data-ice="source"><span><a href="file/src/provision/BaseProvision.js.html#
|
|
757
|
+
<span data-ice="source"><span><a href="file/src/provision/BaseProvision.js.html#lineNumber142">source</a></span></span>
|
|
745
758
|
</span>
|
|
746
759
|
</h3>
|
|
747
760
|
|
|
@@ -337,7 +337,7 @@ This class is responsible to manage execute request to OpenGate North API</p>
|
|
|
337
337
|
<p>
|
|
338
338
|
|
|
339
339
|
|
|
340
|
-
<span data-ice="name"><span><a href="class/src/searching/BaseSearch.js~BaseSearch.html#instance-constructor-constructor">constructor</a></span></span><span data-ice="signature">(ogapi: <span><a href="class/src/InternalOpenGateAPI.js~InternalOpenGateAPI.html">InternalOpenGateAPI</a></span>, resource: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, timeout: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>)</span>
|
|
340
|
+
<span data-ice="name"><span><a href="class/src/searching/BaseSearch.js~BaseSearch.html#instance-constructor-constructor">constructor</a></span></span><span data-ice="signature">(ogapi: <span><a href="class/src/InternalOpenGateAPI.js~InternalOpenGateAPI.html">InternalOpenGateAPI</a></span>, resource: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, timeout: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>, serviceBaseURL: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>)</span>
|
|
341
341
|
</p>
|
|
342
342
|
</div>
|
|
343
343
|
<div>
|
|
@@ -523,11 +523,11 @@ In case of canceling the process, the response will be 403: Forbidden -> {dat
|
|
|
523
523
|
|
|
524
524
|
|
|
525
525
|
|
|
526
|
-
<span data-ice="name">constructor</span><span data-ice="signature">(ogapi: <span><a href="class/src/InternalOpenGateAPI.js~InternalOpenGateAPI.html">InternalOpenGateAPI</a></span>, resource: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, timeout: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>)</span>
|
|
526
|
+
<span data-ice="name">constructor</span><span data-ice="signature">(ogapi: <span><a href="class/src/InternalOpenGateAPI.js~InternalOpenGateAPI.html">InternalOpenGateAPI</a></span>, resource: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, timeout: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>, serviceBaseURL: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>)</span>
|
|
527
527
|
<span class="right-info">
|
|
528
528
|
|
|
529
529
|
|
|
530
|
-
<span data-ice="source"><span><a href="file/src/searching/BaseSearch.js.html#
|
|
530
|
+
<span data-ice="source"><span><a href="file/src/searching/BaseSearch.js.html#lineNumber19">source</a></span></span>
|
|
531
531
|
</span>
|
|
532
532
|
</h3>
|
|
533
533
|
|
|
@@ -568,6 +568,13 @@ In case of canceling the process, the response will be 403: Forbidden -> {dat
|
|
|
568
568
|
<td data-ice="description"><p>timeout on request</p>
|
|
569
569
|
</td>
|
|
570
570
|
</tr>
|
|
571
|
+
<tr data-ice="property" data-depth="0">
|
|
572
|
+
<td data-ice="name" data-depth="0">serviceBaseURL</td>
|
|
573
|
+
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td>
|
|
574
|
+
<td data-ice="appendix"></td>
|
|
575
|
+
<td data-ice="description"><p>base of the uri petition</p>
|
|
576
|
+
</td>
|
|
577
|
+
</tr>
|
|
571
578
|
</tbody>
|
|
572
579
|
</table>
|
|
573
580
|
</div>
|
|
@@ -605,7 +612,7 @@ In case of canceling the process, the response will be 403: Forbidden -> {dat
|
|
|
605
612
|
<span class="right-info">
|
|
606
613
|
|
|
607
614
|
|
|
608
|
-
<span data-ice="source"><span><a href="file/src/searching/BaseSearch.js.html#
|
|
615
|
+
<span data-ice="source"><span><a href="file/src/searching/BaseSearch.js.html#lineNumber176">source</a></span></span>
|
|
609
616
|
</span>
|
|
610
617
|
</h3>
|
|
611
618
|
|
|
@@ -651,7 +658,7 @@ In case of canceling the process, the response will be 403: Forbidden -> {dat
|
|
|
651
658
|
<span class="right-info">
|
|
652
659
|
|
|
653
660
|
|
|
654
|
-
<span data-ice="source"><span><a href="file/src/searching/BaseSearch.js.html#
|
|
661
|
+
<span data-ice="source"><span><a href="file/src/searching/BaseSearch.js.html#lineNumber174">source</a></span></span>
|
|
655
662
|
</span>
|
|
656
663
|
</h3>
|
|
657
664
|
|
|
@@ -710,7 +717,7 @@ In case of canceling the process, the response will be 403: Forbidden -> {dat
|
|
|
710
717
|
<span class="right-info">
|
|
711
718
|
|
|
712
719
|
|
|
713
|
-
<span data-ice="source"><span><a href="file/src/searching/BaseSearch.js.html#
|
|
720
|
+
<span data-ice="source"><span><a href="file/src/searching/BaseSearch.js.html#lineNumber130">source</a></span></span>
|
|
714
721
|
</span>
|
|
715
722
|
</h3>
|
|
716
723
|
|
|
@@ -791,7 +798,7 @@ In case of canceling the process, the response will be 403: Forbidden -> {dat
|
|
|
791
798
|
<span class="right-info">
|
|
792
799
|
|
|
793
800
|
|
|
794
|
-
<span data-ice="source"><span><a href="file/src/searching/BaseSearch.js.html#
|
|
801
|
+
<span data-ice="source"><span><a href="file/src/searching/BaseSearch.js.html#lineNumber76">source</a></span></span>
|
|
795
802
|
</span>
|
|
796
803
|
</h3>
|
|
797
804
|
|
|
@@ -871,7 +878,7 @@ In case of canceling the process, the response will be 403: Forbidden -> {dat
|
|
|
871
878
|
<span class="right-info">
|
|
872
879
|
|
|
873
880
|
|
|
874
|
-
<span data-ice="source"><span><a href="file/src/searching/BaseSearch.js.html#
|
|
881
|
+
<span data-ice="source"><span><a href="file/src/searching/BaseSearch.js.html#lineNumber257">source</a></span></span>
|
|
875
882
|
</span>
|
|
876
883
|
</h3>
|
|
877
884
|
|
package/docs/class/src/searching/builder/HardwaresSearchBuilder.js~HardwaresSearchBuilder.html
CHANGED
|
@@ -294,7 +294,7 @@
|
|
|
294
294
|
|
|
295
295
|
|
|
296
296
|
|
|
297
|
-
<div class="flat-list" data-ice="extendsChain"><h4>Extends:</h4><div><span><a href="class/src/searching/builder/SearchBuilder.js~SearchBuilder.html">SearchBuilder</a></span> → HardwaresSearchBuilder</div></div>
|
|
297
|
+
<div class="flat-list" data-ice="extendsChain"><h4>Extends:</h4><div><span><a href="class/src/searching/builder/SearchBuilder.js~SearchBuilder.html">SearchBuilder</a></span> → <span><a href="class/src/searching/builder/SearchWithSummaryBuilder.js~SearchWithSummaryBuilder.html">SearchWithSummaryBuilder</a></span> → HardwaresSearchBuilder</div></div>
|
|
298
298
|
|
|
299
299
|
|
|
300
300
|
|
|
@@ -818,6 +818,41 @@
|
|
|
818
818
|
<td>
|
|
819
819
|
|
|
820
820
|
|
|
821
|
+
</td>
|
|
822
|
+
</tr>
|
|
823
|
+
</tbody>
|
|
824
|
+
</table>
|
|
825
|
+
|
|
826
|
+
<table class="summary" data-ice="summary">
|
|
827
|
+
<thead><tr><td data-ice="title" colspan="3"><span class="toggle closed"></span> From class <span><a href="class/src/searching/builder/SearchWithSummaryBuilder.js~SearchWithSummaryBuilder.html">SearchWithSummaryBuilder</a></span></td></tr></thead>
|
|
828
|
+
<tbody>
|
|
829
|
+
|
|
830
|
+
<tr data-ice="target">
|
|
831
|
+
<td>
|
|
832
|
+
<span class="access" data-ice="access">public</span>
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
<span class="override" data-ice="override"></span>
|
|
837
|
+
</td>
|
|
838
|
+
<td>
|
|
839
|
+
<div>
|
|
840
|
+
<p>
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
<span data-ice="name"><span><a href="class/src/searching/builder/SearchWithSummaryBuilder.js~SearchWithSummaryBuilder.html#instance-method-summary">summary</a></span></span><span data-ice="signature">(): <span><a href="class/src/searching/builder/SearchWithSummaryBuilder.js~SearchWithSummaryBuilder.html">SearchWithSummaryBuilder</a></span></span>
|
|
844
|
+
</p>
|
|
845
|
+
</div>
|
|
846
|
+
<div>
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
<div data-ice="description"><p>The response will only have a summary information </p>
|
|
850
|
+
</div>
|
|
851
|
+
</div>
|
|
852
|
+
</td>
|
|
853
|
+
<td>
|
|
854
|
+
|
|
855
|
+
|
|
821
856
|
</td>
|
|
822
857
|
</tr>
|
|
823
858
|
</tbody>
|
|
@@ -849,7 +884,7 @@
|
|
|
849
884
|
|
|
850
885
|
|
|
851
886
|
|
|
852
|
-
<div data-ice="override"><h4>Override:</h4><span><a href="class/src/searching/builder/
|
|
887
|
+
<div data-ice="override"><h4>Override:</h4><span><a href="class/src/searching/builder/SearchWithSummaryBuilder.js~SearchWithSummaryBuilder.html#instance-constructor-constructor">SearchWithSummaryBuilder#constructor</a></span></div>
|
|
853
888
|
|
|
854
889
|
<div data-ice="properties"><div data-ice="properties">
|
|
855
890
|
<h4 data-ice="title">Params:</h4>
|
|
@@ -295,8 +295,8 @@
|
|
|
295
295
|
|
|
296
296
|
|
|
297
297
|
|
|
298
|
-
<div class="flat-list" data-ice="directSubclass"><h4>Direct Subclass:</h4><div><span><a href="class/src/searching/builder/AdministrativeStateSearchBuilder.js~AdministrativeStateSearchBuilder.html">AdministrativeStateSearchBuilder</a></span>, <span><a href="class/src/searching/builder/AllowedResourceTypeSearchBuilder.js~AllowedResourceTypeSearchBuilder.html">AllowedResourceTypeSearchBuilder</a></span>, <span><a href="class/src/searching/builder/AreasSearchBuilder.js~AreasSearchBuilder.html">AreasSearchBuilder</a></span>, <span><a href="class/src/searching/builder/BulkExecutionSearchBuilder.js~BulkExecutionSearchBuilder.html">BulkExecutionSearchBuilder</a></span>, <span><a href="class/src/searching/builder/BulkSearchBuilder.js~BulkSearchBuilder.html">BulkSearchBuilder</a></span>, <span><a href="class/src/searching/builder/BundlesSearchBuilder.js~BundlesSearchBuilder.html">BundlesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/CertificatesSearchBuilder.js~CertificatesSearchBuilder.html">CertificatesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/CommunicationsModuleTypeSearchBuilder.js~CommunicationsModuleTypeSearchBuilder.html">CommunicationsModuleTypeSearchBuilder</a></span>, <span><a href="class/src/searching/builder/CountryCodesSearchBuilder.js~CountryCodesSearchBuilder.html">CountryCodesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatamodelsSearchBuilder.js~DatamodelsSearchBuilder.html">DatamodelsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatapointsSearchBuilder.js~DatapointsSearchBuilder.html">DatapointsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatasetSearchBuilder.js~DatasetSearchBuilder.html">DatasetSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatasetsCatalogSearchBuilder.js~DatasetsCatalogSearchBuilder.html">DatasetsCatalogSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatastreamsSearchBuilder.js~DatastreamsSearchBuilder.html">DatastreamsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DevicesPlansSearchBuilder.js~DevicesPlansSearchBuilder.html">DevicesPlansSearchBuilder</a></span>, <span><a href="class/src/searching/builder/FeedsSearchBuilder.js~FeedsSearchBuilder.html">FeedsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/FieldsDefinitionSearchBuilder.js~FieldsDefinitionSearchBuilder.html">FieldsDefinitionSearchBuilder</a></span>, <span><a href="class/src/searching/builder/FlattenedSearchBuilder.js~FlattenedSearchBuilder.html">FlattenedSearchBuilder</a></span>, <span><a href="class/src/searching/builder/
|
|
299
|
-
<div class="flat-list" data-ice="indirectSubclass"><h4>Indirect Subclass:</h4><div><span><a href="class/src/searching/builder/AlarmsSearchBuilder.js~AlarmsSearchBuilder.html">AlarmsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/AssetsSearchBuilder.js~AssetsSearchBuilder.html">AssetsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/ChannelsSearchBuilder.js~ChannelsSearchBuilder.html">ChannelsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatasetEntitiesSearchBuilder.js~DatasetEntitiesSearchBuilder.html">DatasetEntitiesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DevicesSearchBuilder.js~DevicesSearchBuilder.html">DevicesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DomainsSearchBuilder.js~DomainsSearchBuilder.html">DomainsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/EntitiesSearchBuilder.js~EntitiesSearchBuilder.html">EntitiesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/ExecutionsHistorySearchBuilder.js~ExecutionsHistorySearchBuilder.html">ExecutionsHistorySearchBuilder</a></span>, <span><a href="class/src/searching/builder/ExecutionsSearchBuilder.js~ExecutionsSearchBuilder.html">ExecutionsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/OperationsSearchBuilder.js~OperationsSearchBuilder.html">OperationsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/PreFilteredSearchBuilder.js~PreFilteredSearchBuilder.html">PreFilteredSearchBuilder</a></span>, <span><a href="class/src/searching/builder/SoftwaresSearchBuilder.js~SoftwaresSearchBuilder.html">SoftwaresSearchBuilder</a></span>, <span><a href="class/src/searching/builder/SubscribersSearchBuilder.js~SubscribersSearchBuilder.html">SubscribersSearchBuilder</a></span>, <span><a href="class/src/searching/builder/SubscriptionsSearchBuilder.js~SubscriptionsSearchBuilder.html">SubscriptionsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/TasksSearchBuilder.js~TasksSearchBuilder.html">TasksSearchBuilder</a></span>, <span><a href="class/src/searching/builder/UsersSearchBuilder.js~UsersSearchBuilder.html">UsersSearchBuilder</a></span>, <span><a href="class/src/searching/builder/WorkgroupsSearchBuilder.js~WorkgroupsSearchBuilder.html">WorkgroupsSearchBuilder</a></span></div></div>
|
|
298
|
+
<div class="flat-list" data-ice="directSubclass"><h4>Direct Subclass:</h4><div><span><a href="class/src/searching/builder/AdministrativeStateSearchBuilder.js~AdministrativeStateSearchBuilder.html">AdministrativeStateSearchBuilder</a></span>, <span><a href="class/src/searching/builder/AllowedResourceTypeSearchBuilder.js~AllowedResourceTypeSearchBuilder.html">AllowedResourceTypeSearchBuilder</a></span>, <span><a href="class/src/searching/builder/AreasSearchBuilder.js~AreasSearchBuilder.html">AreasSearchBuilder</a></span>, <span><a href="class/src/searching/builder/BulkExecutionSearchBuilder.js~BulkExecutionSearchBuilder.html">BulkExecutionSearchBuilder</a></span>, <span><a href="class/src/searching/builder/BulkSearchBuilder.js~BulkSearchBuilder.html">BulkSearchBuilder</a></span>, <span><a href="class/src/searching/builder/BundlesSearchBuilder.js~BundlesSearchBuilder.html">BundlesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/CertificatesSearchBuilder.js~CertificatesSearchBuilder.html">CertificatesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/CommunicationsModuleTypeSearchBuilder.js~CommunicationsModuleTypeSearchBuilder.html">CommunicationsModuleTypeSearchBuilder</a></span>, <span><a href="class/src/searching/builder/CountryCodesSearchBuilder.js~CountryCodesSearchBuilder.html">CountryCodesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatamodelsSearchBuilder.js~DatamodelsSearchBuilder.html">DatamodelsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatapointsSearchBuilder.js~DatapointsSearchBuilder.html">DatapointsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatasetSearchBuilder.js~DatasetSearchBuilder.html">DatasetSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatasetsCatalogSearchBuilder.js~DatasetsCatalogSearchBuilder.html">DatasetsCatalogSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatastreamsSearchBuilder.js~DatastreamsSearchBuilder.html">DatastreamsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DevicesPlansSearchBuilder.js~DevicesPlansSearchBuilder.html">DevicesPlansSearchBuilder</a></span>, <span><a href="class/src/searching/builder/FeedsSearchBuilder.js~FeedsSearchBuilder.html">FeedsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/FieldsDefinitionSearchBuilder.js~FieldsDefinitionSearchBuilder.html">FieldsDefinitionSearchBuilder</a></span>, <span><a href="class/src/searching/builder/FlattenedSearchBuilder.js~FlattenedSearchBuilder.html">FlattenedSearchBuilder</a></span>, <span><a href="class/src/searching/builder/IoTDatastreamAccessSearchBuilder.js~IoTDatastreamAccessSearchBuilder.html">IoTDatastreamAccessSearchBuilder</a></span>, <span><a href="class/src/searching/builder/IoTDatastreamPeriodSearchBuilder.js~IoTDatastreamPeriodSearchBuilder.html">IoTDatastreamPeriodSearchBuilder</a></span>, <span><a href="class/src/searching/builder/IoTDatastreamStoragePeriodSearchBuilder.js~IoTDatastreamStoragePeriodSearchBuilder.html">IoTDatastreamStoragePeriodSearchBuilder</a></span>, <span><a href="class/src/searching/builder/MobilePhoneProviderSearchBuilder.js~MobilePhoneProviderSearchBuilder.html">MobilePhoneProviderSearchBuilder</a></span>, <span><a href="class/src/searching/builder/OperationTypesSearchBuilder.js~OperationTypesBuilder.html">OperationTypesBuilder</a></span>, <span><a href="class/src/searching/builder/OperationalStatusSearchBuilder.js~OperationalStatusSearchBuilder.html">OperationalStatusSearchBuilder</a></span>, <span><a href="class/src/searching/builder/OrganizationsSearchBuilder.js~OrganizationsSearchBuilder.html">OrganizationsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/PlansSearchBuilder.js~PlansSearchBuilder.html">PlansSearchBuilder</a></span>, <span><a href="class/src/searching/builder/ResourceTypeSearchBuilder.js~ResourceTypeSearchBuilder.html">ResourceTypeSearchBuilder</a></span>, <span><a href="class/src/searching/builder/RuleConfigurationSeveritySearchBuilder.js~RuleConfigurationSeveritySearchBuilder.html">RuleConfigurationSeveritySearchBuilder</a></span>, <span><a href="class/src/searching/builder/RuleModeSearchBuilder.js~RuleModeSearchBuilder.html">RuleModeSearchBuilder</a></span>, <span><a href="class/src/searching/builder/RuleTypeSearchBuilder.js~RuleTypeSearchBuilder.html">RuleTypeSearchBuilder</a></span>, <span><a href="class/src/searching/builder/RulesSearchBuilder.js~RulesSearchBuilder.html">RulesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/SearchWithSummaryBuilder.js~SearchWithSummaryBuilder.html">SearchWithSummaryBuilder</a></span>, <span><a href="class/src/searching/builder/ServiceGroupSearchBuilder.js~ServiceGroupSearchBuilder.html">ServiceGroupSearchBuilder</a></span>, <span><a href="class/src/searching/builder/TicketPrioritySearchBuilder.js~TicketPrioritySearchBuilder.html">TicketPrioritySearchBuilder</a></span>, <span><a href="class/src/searching/builder/TicketSeveritySearchBuilder.js~TicketSeveritySearchBuilder.html">TicketSeveritySearchBuilder</a></span>, <span><a href="class/src/searching/builder/TicketStatusSearchBuilder.js~TicketStatusSearchBuilder.html">TicketStatusSearchBuilder</a></span>, <span><a href="class/src/searching/builder/TicketsSearchBuilder.js~TicketsSearchBuilder.html">TicketsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/TimeserieSearchBuilder.js~TimeserieSearchBuilder.html">TimeserieSearchBuilder</a></span>, <span><a href="class/src/searching/builder/TimezoneSearchBuilder.js~TimezoneSearchBuilder.html">TimezoneSearchBuilder</a></span>, <span><a href="class/src/searching/builder/UserLanguagesSearchBuilder.js~UserLanguagesSearchBuilder.html">UserLanguagesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/UserProfilesSearchBuilder.js~UserProfilesSearchBuilder.html">UserProfilesSearchBuilder</a></span></div></div>
|
|
299
|
+
<div class="flat-list" data-ice="indirectSubclass"><h4>Indirect Subclass:</h4><div><span><a href="class/src/searching/builder/AlarmsSearchBuilder.js~AlarmsSearchBuilder.html">AlarmsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/AssetsSearchBuilder.js~AssetsSearchBuilder.html">AssetsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/ChannelsSearchBuilder.js~ChannelsSearchBuilder.html">ChannelsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatasetEntitiesSearchBuilder.js~DatasetEntitiesSearchBuilder.html">DatasetEntitiesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DevicesSearchBuilder.js~DevicesSearchBuilder.html">DevicesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DomainsSearchBuilder.js~DomainsSearchBuilder.html">DomainsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/EntitiesSearchBuilder.js~EntitiesSearchBuilder.html">EntitiesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/ExecutionsHistorySearchBuilder.js~ExecutionsHistorySearchBuilder.html">ExecutionsHistorySearchBuilder</a></span>, <span><a href="class/src/searching/builder/ExecutionsSearchBuilder.js~ExecutionsSearchBuilder.html">ExecutionsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/HardwaresSearchBuilder.js~HardwaresSearchBuilder.html">HardwaresSearchBuilder</a></span>, <span><a href="class/src/searching/builder/OperationsSearchBuilder.js~OperationsSearchBuilder.html">OperationsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/PreFilteredSearchBuilder.js~PreFilteredSearchBuilder.html">PreFilteredSearchBuilder</a></span>, <span><a href="class/src/searching/builder/SoftwaresSearchBuilder.js~SoftwaresSearchBuilder.html">SoftwaresSearchBuilder</a></span>, <span><a href="class/src/searching/builder/SubscribersSearchBuilder.js~SubscribersSearchBuilder.html">SubscribersSearchBuilder</a></span>, <span><a href="class/src/searching/builder/SubscriptionsSearchBuilder.js~SubscriptionsSearchBuilder.html">SubscriptionsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/TasksSearchBuilder.js~TasksSearchBuilder.html">TasksSearchBuilder</a></span>, <span><a href="class/src/searching/builder/UsersSearchBuilder.js~UsersSearchBuilder.html">UsersSearchBuilder</a></span>, <span><a href="class/src/searching/builder/WorkgroupsSearchBuilder.js~WorkgroupsSearchBuilder.html">WorkgroupsSearchBuilder</a></span></div></div>
|
|
300
300
|
|
|
301
301
|
|
|
302
302
|
|
package/docs/class/src/searching/builder/SearchWithSummaryBuilder.js~SearchWithSummaryBuilder.html
CHANGED
|
@@ -295,7 +295,7 @@
|
|
|
295
295
|
|
|
296
296
|
|
|
297
297
|
<div class="flat-list" data-ice="extendsChain"><h4>Extends:</h4><div><span><a href="class/src/searching/builder/SearchBuilder.js~SearchBuilder.html">SearchBuilder</a></span> → SearchWithSummaryBuilder</div></div>
|
|
298
|
-
<div class="flat-list" data-ice="directSubclass"><h4>Direct Subclass:</h4><div><span><a href="class/src/searching/builder/AlarmsSearchBuilder.js~AlarmsSearchBuilder.html">AlarmsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/ChannelsSearchBuilder.js~ChannelsSearchBuilder.html">ChannelsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatasetEntitiesSearchBuilder.js~DatasetEntitiesSearchBuilder.html">DatasetEntitiesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DomainsSearchBuilder.js~DomainsSearchBuilder.html">DomainsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/EntitiesSearchBuilder.js~EntitiesSearchBuilder.html">EntitiesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/ExecutionsHistorySearchBuilder.js~ExecutionsHistorySearchBuilder.html">ExecutionsHistorySearchBuilder</a></span>, <span><a href="class/src/searching/builder/ExecutionsSearchBuilder.js~ExecutionsSearchBuilder.html">ExecutionsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/OperationsSearchBuilder.js~OperationsSearchBuilder.html">OperationsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/SoftwaresSearchBuilder.js~SoftwaresSearchBuilder.html">SoftwaresSearchBuilder</a></span>, <span><a href="class/src/searching/builder/TasksSearchBuilder.js~TasksSearchBuilder.html">TasksSearchBuilder</a></span>, <span><a href="class/src/searching/builder/UsersSearchBuilder.js~UsersSearchBuilder.html">UsersSearchBuilder</a></span>, <span><a href="class/src/searching/builder/WorkgroupsSearchBuilder.js~WorkgroupsSearchBuilder.html">WorkgroupsSearchBuilder</a></span></div></div>
|
|
298
|
+
<div class="flat-list" data-ice="directSubclass"><h4>Direct Subclass:</h4><div><span><a href="class/src/searching/builder/AlarmsSearchBuilder.js~AlarmsSearchBuilder.html">AlarmsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/ChannelsSearchBuilder.js~ChannelsSearchBuilder.html">ChannelsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DatasetEntitiesSearchBuilder.js~DatasetEntitiesSearchBuilder.html">DatasetEntitiesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/DomainsSearchBuilder.js~DomainsSearchBuilder.html">DomainsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/EntitiesSearchBuilder.js~EntitiesSearchBuilder.html">EntitiesSearchBuilder</a></span>, <span><a href="class/src/searching/builder/ExecutionsHistorySearchBuilder.js~ExecutionsHistorySearchBuilder.html">ExecutionsHistorySearchBuilder</a></span>, <span><a href="class/src/searching/builder/ExecutionsSearchBuilder.js~ExecutionsSearchBuilder.html">ExecutionsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/HardwaresSearchBuilder.js~HardwaresSearchBuilder.html">HardwaresSearchBuilder</a></span>, <span><a href="class/src/searching/builder/OperationsSearchBuilder.js~OperationsSearchBuilder.html">OperationsSearchBuilder</a></span>, <span><a href="class/src/searching/builder/SoftwaresSearchBuilder.js~SoftwaresSearchBuilder.html">SoftwaresSearchBuilder</a></span>, <span><a href="class/src/searching/builder/TasksSearchBuilder.js~TasksSearchBuilder.html">TasksSearchBuilder</a></span>, <span><a href="class/src/searching/builder/UsersSearchBuilder.js~UsersSearchBuilder.html">UsersSearchBuilder</a></span>, <span><a href="class/src/searching/builder/WorkgroupsSearchBuilder.js~WorkgroupsSearchBuilder.html">WorkgroupsSearchBuilder</a></span></div></div>
|
|
299
299
|
|
|
300
300
|
|
|
301
301
|
|
|
@@ -371,14 +371,14 @@
|
|
|
371
371
|
<p>
|
|
372
372
|
|
|
373
373
|
|
|
374
|
-
<span data-ice="name"><span><a href="class/src/users/Users.js~User.html#instance-method-
|
|
374
|
+
<span data-ice="name"><span><a href="class/src/users/Users.js~User.html#instance-method-changePassword">changePassword</a></span></span><span data-ice="signature">(newPassword: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
|
|
375
375
|
</p>
|
|
376
376
|
</div>
|
|
377
377
|
<div>
|
|
378
378
|
|
|
379
379
|
|
|
380
380
|
<div data-ice="description"><p>This invoke a request to OpenGate North API and the callback is managed by promises
|
|
381
|
-
This function
|
|
381
|
+
This function updates a password of a user</p>
|
|
382
382
|
</div>
|
|
383
383
|
</div>
|
|
384
384
|
</td>
|
|
@@ -400,14 +400,14 @@ This function request for new password when the user forgets it.</p>
|
|
|
400
400
|
<p>
|
|
401
401
|
|
|
402
402
|
|
|
403
|
-
<span data-ice="name"><span><a href="class/src/users/Users.js~User.html#instance-method-
|
|
403
|
+
<span data-ice="name"><span><a href="class/src/users/Users.js~User.html#instance-method-requestResetPassword">requestResetPassword</a></span></span><span data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
|
|
404
404
|
</p>
|
|
405
405
|
</div>
|
|
406
406
|
<div>
|
|
407
407
|
|
|
408
408
|
|
|
409
409
|
<div data-ice="description"><p>This invoke a request to OpenGate North API and the callback is managed by promises
|
|
410
|
-
This function
|
|
410
|
+
This function request for new password when the user forgets it.</p>
|
|
411
411
|
</div>
|
|
412
412
|
</div>
|
|
413
413
|
</td>
|
|
@@ -921,18 +921,18 @@ This function updates a entity of provision</p>
|
|
|
921
921
|
<div data-ice="methodDetails"><h2 data-ice="title">Public Methods</h2>
|
|
922
922
|
|
|
923
923
|
<div class="detail" data-ice="detail">
|
|
924
|
-
<h3 data-ice="anchor" id="instance-method-
|
|
924
|
+
<h3 data-ice="anchor" id="instance-method-changePassword">
|
|
925
925
|
<span class="access" data-ice="access">public</span>
|
|
926
926
|
|
|
927
927
|
|
|
928
928
|
|
|
929
929
|
|
|
930
930
|
|
|
931
|
-
<span data-ice="name">
|
|
931
|
+
<span data-ice="name">changePassword</span><span data-ice="signature">(newPassword: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
|
|
932
932
|
<span class="right-info">
|
|
933
933
|
|
|
934
934
|
|
|
935
|
-
<span data-ice="source"><span><a href="file/src/users/Users.js.html#
|
|
935
|
+
<span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber267">source</a></span></span>
|
|
936
936
|
</span>
|
|
937
937
|
</h3>
|
|
938
938
|
|
|
@@ -940,13 +940,29 @@ This function updates a entity of provision</p>
|
|
|
940
940
|
|
|
941
941
|
|
|
942
942
|
<div data-ice="description"><p>This invoke a request to OpenGate North API and the callback is managed by promises
|
|
943
|
-
This function
|
|
944
|
-
Sends a password recovery email</p>
|
|
943
|
+
This function updates a password of a user</p>
|
|
945
944
|
</div>
|
|
946
945
|
|
|
947
946
|
|
|
948
947
|
|
|
949
|
-
<div data-ice="properties">
|
|
948
|
+
<div data-ice="properties"><div data-ice="properties">
|
|
949
|
+
<h4 data-ice="title">Params:</h4>
|
|
950
|
+
<table class="params">
|
|
951
|
+
<thead>
|
|
952
|
+
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
953
|
+
</thead>
|
|
954
|
+
<tbody>
|
|
955
|
+
|
|
956
|
+
<tr data-ice="property" data-depth="0">
|
|
957
|
+
<td data-ice="name" data-depth="0">newPassword</td>
|
|
958
|
+
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
|
|
959
|
+
<td data-ice="appendix"></td>
|
|
960
|
+
<td data-ice="description"><p>required field</p>
|
|
961
|
+
</td>
|
|
962
|
+
</tr>
|
|
963
|
+
</tbody>
|
|
964
|
+
</table>
|
|
965
|
+
</div>
|
|
950
966
|
</div>
|
|
951
967
|
|
|
952
968
|
<div class="return-params" data-ice="returnParams">
|
|
@@ -1000,7 +1016,7 @@ Sends a password recovery email</p>
|
|
|
1000
1016
|
|
|
1001
1017
|
<div class="example-doc" data-ice="exampleDoc">
|
|
1002
1018
|
|
|
1003
|
-
<pre class="prettyprint source-code"><code data-ice="exampleCode"> ogapi.usersBuilder().withEmail(example@example.es).
|
|
1019
|
+
<pre class="prettyprint source-code"><code data-ice="exampleCode"> ogapi.usersBuilder().withEmail(example@example.es).withPassword(oldPassword).changePassword(newPassword);</code></pre>
|
|
1004
1020
|
</div>
|
|
1005
1021
|
</div>
|
|
1006
1022
|
|
|
@@ -1010,18 +1026,18 @@ Sends a password recovery email</p>
|
|
|
1010
1026
|
|
|
1011
1027
|
</div>
|
|
1012
1028
|
<div class="detail" data-ice="detail">
|
|
1013
|
-
<h3 data-ice="anchor" id="instance-method-
|
|
1029
|
+
<h3 data-ice="anchor" id="instance-method-requestResetPassword">
|
|
1014
1030
|
<span class="access" data-ice="access">public</span>
|
|
1015
1031
|
|
|
1016
1032
|
|
|
1017
1033
|
|
|
1018
1034
|
|
|
1019
1035
|
|
|
1020
|
-
<span data-ice="name">
|
|
1036
|
+
<span data-ice="name">requestResetPassword</span><span data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
|
|
1021
1037
|
<span class="right-info">
|
|
1022
1038
|
|
|
1023
1039
|
|
|
1024
|
-
<span data-ice="source"><span><a href="file/src/users/Users.js.html#
|
|
1040
|
+
<span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber296">source</a></span></span>
|
|
1025
1041
|
</span>
|
|
1026
1042
|
</h3>
|
|
1027
1043
|
|
|
@@ -1029,29 +1045,13 @@ Sends a password recovery email</p>
|
|
|
1029
1045
|
|
|
1030
1046
|
|
|
1031
1047
|
<div data-ice="description"><p>This invoke a request to OpenGate North API and the callback is managed by promises
|
|
1032
|
-
This function
|
|
1048
|
+
This function request for new password when the user forgets it.
|
|
1049
|
+
Sends a password recovery email</p>
|
|
1033
1050
|
</div>
|
|
1034
1051
|
|
|
1035
1052
|
|
|
1036
1053
|
|
|
1037
|
-
<div data-ice="properties"
|
|
1038
|
-
<h4 data-ice="title">Params:</h4>
|
|
1039
|
-
<table class="params">
|
|
1040
|
-
<thead>
|
|
1041
|
-
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
1042
|
-
</thead>
|
|
1043
|
-
<tbody>
|
|
1044
|
-
|
|
1045
|
-
<tr data-ice="property" data-depth="0">
|
|
1046
|
-
<td data-ice="name" data-depth="0">newPassword</td>
|
|
1047
|
-
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
|
|
1048
|
-
<td data-ice="appendix"></td>
|
|
1049
|
-
<td data-ice="description"><p>required field</p>
|
|
1050
|
-
</td>
|
|
1051
|
-
</tr>
|
|
1052
|
-
</tbody>
|
|
1053
|
-
</table>
|
|
1054
|
-
</div>
|
|
1054
|
+
<div data-ice="properties">
|
|
1055
1055
|
</div>
|
|
1056
1056
|
|
|
1057
1057
|
<div class="return-params" data-ice="returnParams">
|
|
@@ -1105,7 +1105,7 @@ This function updates a password of a user</p>
|
|
|
1105
1105
|
|
|
1106
1106
|
<div class="example-doc" data-ice="exampleDoc">
|
|
1107
1107
|
|
|
1108
|
-
<pre class="prettyprint source-code"><code data-ice="exampleCode"> ogapi.usersBuilder().withEmail(example@example.es).
|
|
1108
|
+
<pre class="prettyprint source-code"><code data-ice="exampleCode"> ogapi.usersBuilder().withEmail(example@example.es).requestResetPassword()</code></pre>
|
|
1109
1109
|
</div>
|
|
1110
1110
|
</div>
|
|
1111
1111
|
|