@situm/cordova 3.3.0 → 3.3.2

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.
@@ -1,755 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>Namespace: MapViewControllerImpl | Situm</title>
6
-
7
- <script src="scripts/prettify/prettify.js"> </script>
8
- <script src="scripts/prettify/lang-css.js"> </script>
9
- <!--[if lt IE 9]>
10
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
- <![endif]-->
12
- <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
13
- <link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
14
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
15
- <link type="text/css" rel="stylesheet" href="styles/tui-doc.css">
16
-
17
-
18
-
19
- <link type="text/css" rel="stylesheet" href="styles/custom.css">
20
-
21
-
22
- </head>
23
- <body>
24
- <nav class="lnb" id="lnb">
25
- <div class="logo" style="width: 90px; height: 90px">
26
-
27
- <a href="https://github.com/situmtech/situm-cordova-plugin" rel="noopener noreferrer" target="_blank">
28
- <img src="https://situm.com/wp-content/uploads/2023/04/situm_logo_blanco_300_sq.png" width="100%" height="100%">
29
- </a>
30
-
31
- </div>
32
- <div class="title">
33
- <h1><a href="index.html" class="link">Situm</a></h1>
34
-
35
- </div>
36
- <div class="search-container" id="search-container">
37
- <input type="text" placeholder="Search">
38
- <ul></ul>
39
- </div>
40
-
41
- <div class="lnb-api hidden"><h3>Namespaces</h3><ul><li><a href="MapView.html">MapView</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="MapView_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="MapView.html#.onLoad">onLoad</a></li></ul></div></li><li><a href="MapViewControllerImpl.html">MapViewControllerImpl</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="MapViewControllerImpl_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="MapViewControllerImpl.html#navigateToPoi">navigateToPoi</a></li><li><a href="MapViewControllerImpl.html#onPoiDeselected">onPoiDeselected</a></li><li><a href="MapViewControllerImpl.html#onPoiSelected">onPoiSelected</a></li><li><a href="MapViewControllerImpl.html#selectPoi">selectPoi</a></li></ul></div></li><li><a href="Situm.html">Situm</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Situm_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Situm.html#.fetchBuildingInfo">fetchBuildingInfo</a></li><li><a href="Situm.html#.fetchBuildings">fetchBuildings</a></li><li><a href="Situm.html#.fetchEventsFromBuilding">fetchEventsFromBuilding</a></li><li><a href="Situm.html#.fetchFloorsFromBuilding">fetchFloorsFromBuilding</a></li><li><a href="Situm.html#.fetchGeofencesFromBuilding">fetchGeofencesFromBuilding</a></li><li><a href="Situm.html#.fetchIndoorPOIsFromBuilding">fetchIndoorPOIsFromBuilding</a></li><li><a href="Situm.html#.fetchMapFromFloor">fetchMapFromFloor</a></li><li><a href="Situm.html#.fetchOutdoorPOIsFromBuilding">fetchOutdoorPOIsFromBuilding</a></li><li><a href="Situm.html#.fetchPoiCategories">fetchPoiCategories</a></li><li><a href="Situm.html#.fetchPoiCategoryIconNormal">fetchPoiCategoryIconNormal</a></li><li><a href="Situm.html#.fetchPoiCategoryIconSelected">fetchPoiCategoryIconSelected</a></li><li><a href="Situm.html#.internalSetEventDelegate">internalSetEventDelegate</a></li><li><a href="Situm.html#.invalidateCache">invalidateCache</a></li><li><a href="Situm.html#.onEnterGeofences">onEnterGeofences</a></li><li><a href="Situm.html#.onExitGeofences">onExitGeofences</a></li><li><a href="Situm.html#.removeNavigationUpdates">removeNavigationUpdates</a></li><li><a href="Situm.html#.removeRealTimeUpdates">removeRealTimeUpdates</a></li><li><a href="Situm.html#.requestDirections">requestDirections</a></li><li><a href="Situm.html#.requestNavigationUpdates">requestNavigationUpdates</a></li><li><a href="Situm.html#.requestRealTimeUpdates">requestRealTimeUpdates</a></li><li><a href="Situm.html#.setApiKey">setApiKey</a></li><li><a href="Situm.html#.setCacheMaxAge">setCacheMaxAge</a></li><li><a href="Situm.html#.setUserPass">setUserPass</a></li><li><a href="Situm.html#.startPositioning">startPositioning</a></li><li><a href="Situm.html#.stopPositioning">stopPositioning</a></li><li><a href="Situm.html#.updateNavigationWithLocation">updateNavigationWithLocation</a></li></ul></div></li></ul></div><div class="lnb-api hidden"><h3>Global</h3><ul><li><a href="global.html#Angle">Angle</a></li><li><a href="global.html#BeaconFilter">BeaconFilter</a></li><li><a href="global.html#Bounds">Bounds</a></li><li><a href="global.html#Building">Building</a></li><li><a href="global.html#BuildingInfo">BuildingInfo</a></li><li><a href="global.html#CartesianCoordinate">CartesianCoordinate</a></li><li><a href="global.html#Circle">Circle</a></li><li><a href="global.html#Coordinate">Coordinate</a></li><li><a href="global.html#Dimensions">Dimensions</a></li><li><a href="global.html#DirectionsOptions">DirectionsOptions</a></li><li><a href="global.html#DirectionsRequest">DirectionsRequest</a></li><li><a href="global.html#Floor">Floor</a></li><li><a href="global.html#Geofence">Geofence</a></li><li><a href="global.html#Indication">Indication</a></li><li><a href="global.html#Location">Location</a></li><li><a href="global.html#LocationOptions">LocationOptions</a></li><li><a href="global.html#LocationRequest">LocationRequest</a></li><li><a href="global.html#LocationStatus">LocationStatus</a></li><li><a href="global.html#NavigationProgress">NavigationProgress</a></li><li><a href="global.html#NavigationRequest">NavigationRequest</a></li><li><a href="global.html#OutdoorLocationOptions">OutdoorLocationOptions</a></li><li><a href="global.html#POI">POI</a></li><li><a href="global.html#PoiCategory">PoiCategory</a></li><li><a href="global.html#PoiDeselectedResult">PoiDeselectedResult</a></li><li><a href="global.html#Point">Point</a></li><li><a href="global.html#PoiSelectedResult">PoiSelectedResult</a></li><li><a href="global.html#RealTimeData">RealTimeData</a></li><li><a href="global.html#RealTimeRequest">RealTimeRequest</a></li><li><a href="global.html#Route">Route</a></li><li><a href="global.html#RouteSegment">RouteSegment</a></li><li><a href="global.html#RouteStep">RouteStep</a></li><li><a href="global.html#SitumConversionArea">SitumConversionArea</a></li><li><a href="global.html#SitumEvent">SitumEvent</a></li></ul></div>
42
- </nav>
43
- <div id="resizer"></div>
44
-
45
- <div class="main" id="main">
46
-
47
-
48
-
49
-
50
-
51
- <section>
52
-
53
- <header>
54
-
55
- <h2>MapViewControllerImpl</h2>
56
-
57
-
58
- </header>
59
-
60
- <article>
61
-
62
- <div class="container-overview">
63
-
64
-
65
-
66
-
67
-
68
-
69
- <dl class="details">
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
-
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
- </dl>
101
-
102
-
103
-
104
-
105
- </div>
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
- <h3 class="subsection-title">Methods</h3>
124
-
125
- <dl>
126
-
127
-
128
- <dt>
129
-
130
- <h4 class="name" id="navigateToPoi">
131
-
132
- <span class="type-signature"></span>navigateToPoi<span class="signature">(identifier, accessibilityMode)</span><span class="type-signature"></span>
133
-
134
-
135
- <div class="container-source members">
136
- <code><a href="map-view-controller.js.html">map-view-controller.js</a></code>,
137
- <code><a href="map-view-controller.js.html#line293">line 293</a></code>
138
- </div>
139
-
140
- </h4>
141
-
142
-
143
-
144
- </dt>
145
- <dd>
146
-
147
-
148
- <div class="description">
149
- Navigate to a POI of a building.
150
-
151
- The types of accessibilityMode you can use are:
152
- - 'CHOOSE_SHORTEST' : Calculates the shortest route to the destination <a href="global.html#POI">POI</a>.
153
- - 'ONLY_ACCESSIBLE' : Calculates the shortest route to the destination <a href="global.html#POI">POI</a> but avoiding stairs and prioritizing accessible floor changes such as lifts.
154
- - 'ONLY_NOT_ACCESSIBLE_FLOOR_CHANGES' : Calculates the shortest route to the destination <a href="global.html#POI">POI</a> but avoiding lifts and prioritizing non-accessible floor changes such as stairs.
155
-
156
- accessibilityMode defaults to CHOOSE_SHORTEST.
157
- </div>
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
- <div class="container-params">
168
- <h5>Parameters:</h5>
169
-
170
- <table class="params">
171
- <thead>
172
- <tr>
173
-
174
- <th>Name</th>
175
-
176
-
177
- <th>Type</th>
178
-
179
-
180
-
181
-
182
-
183
- <th class="last">Description</th>
184
- </tr>
185
- </thead>
186
-
187
- <tbody>
188
-
189
-
190
- <tr>
191
-
192
- <td class="name"><code>identifier</code></td>
193
-
194
-
195
- <td class="type">
196
-
197
-
198
- <span class="param-type">number</span>
199
-
200
-
201
-
202
- </td>
203
-
204
-
205
-
206
-
207
-
208
- <td class="description last">The identifier of the poi.</td>
209
- </tr>
210
-
211
-
212
-
213
- <tr>
214
-
215
- <td class="name"><code>accessibilityMode</code></td>
216
-
217
-
218
- <td class="type">
219
-
220
-
221
- <span class="param-type">'CHOOSE_SHORTEST'</span>
222
- |
223
-
224
- <span class="param-type">'ONLY_ACCESSIBLE'</span>
225
- |
226
-
227
- <span class="param-type">'ONLY_NOT_ACCESSIBLE_FLOOR_CHANGES'</span>
228
- |
229
-
230
- <span class="param-type">undefined</span>
231
-
232
-
233
-
234
- </td>
235
-
236
-
237
-
238
-
239
-
240
- <td class="description last">Choose the route type to calculate.</td>
241
- </tr>
242
-
243
-
244
- </tbody>
245
- </table>
246
-
247
- </div>
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
- <dl class="details">
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
-
280
-
281
-
282
-
283
-
284
-
285
-
286
-
287
-
288
-
289
-
290
-
291
-
292
-
293
-
294
-
295
-
296
- </dl>
297
-
298
-
299
-
300
-
301
- </dd>
302
-
303
-
304
-
305
-
306
- <dt>
307
-
308
- <h4 class="name" id="onPoiDeselected">
309
-
310
- <span class="type-signature"></span>onPoiDeselected<span class="signature">(cb)</span><span class="type-signature"></span>
311
-
312
-
313
- <div class="container-source members">
314
- <code><a href="map-view-controller.js.html">map-view-controller.js</a></code>,
315
- <code><a href="map-view-controller.js.html#line316">line 316</a></code>
316
- </div>
317
-
318
- </h4>
319
-
320
-
321
-
322
- </dt>
323
- <dd>
324
-
325
-
326
- <div class="description">
327
- A POI was deselected in your building.
328
- </div>
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
-
337
-
338
- <div class="container-params">
339
- <h5>Parameters:</h5>
340
-
341
- <table class="params">
342
- <thead>
343
- <tr>
344
-
345
- <th>Name</th>
346
-
347
-
348
- <th>Type</th>
349
-
350
-
351
-
352
-
353
-
354
- <th class="last">Description</th>
355
- </tr>
356
- </thead>
357
-
358
- <tbody>
359
-
360
-
361
- <tr>
362
-
363
- <td class="name"><code>cb</code></td>
364
-
365
-
366
- <td class="type">
367
-
368
-
369
- <span class="param-type">function</span>
370
-
371
-
372
-
373
- </td>
374
-
375
-
376
-
377
-
378
-
379
- <td class="description last">A callback that returns a <a href="global.html#PoiDeselectedResult">PoiDeselectedResult</a> by its parameters.</td>
380
- </tr>
381
-
382
-
383
- </tbody>
384
- </table>
385
-
386
- </div>
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
- <dl class="details">
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
- </dl>
436
-
437
-
438
-
439
-
440
- </dd>
441
-
442
-
443
-
444
-
445
- <dt>
446
-
447
- <h4 class="name" id="onPoiSelected">
448
-
449
- <span class="type-signature"></span>onPoiSelected<span class="signature">(cb)</span><span class="type-signature"></span>
450
-
451
-
452
- <div class="container-source members">
453
- <code><a href="map-view-controller.js.html">map-view-controller.js</a></code>,
454
- <code><a href="map-view-controller.js.html#line308">line 308</a></code>
455
- </div>
456
-
457
- </h4>
458
-
459
-
460
-
461
- </dt>
462
- <dd>
463
-
464
-
465
- <div class="description">
466
- A POI was selected in your building.
467
- </div>
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
- <div class="container-params">
478
- <h5>Parameters:</h5>
479
-
480
- <table class="params">
481
- <thead>
482
- <tr>
483
-
484
- <th>Name</th>
485
-
486
-
487
- <th>Type</th>
488
-
489
-
490
-
491
-
492
-
493
- <th class="last">Description</th>
494
- </tr>
495
- </thead>
496
-
497
- <tbody>
498
-
499
-
500
- <tr>
501
-
502
- <td class="name"><code>cb</code></td>
503
-
504
-
505
- <td class="type">
506
-
507
-
508
- <span class="param-type">function</span>
509
-
510
-
511
-
512
- </td>
513
-
514
-
515
-
516
-
517
-
518
- <td class="description last">A callback that returns a <a href="global.html#PoiSelectedResult">PoiSelectedResult</a> by its parameters.</td>
519
- </tr>
520
-
521
-
522
- </tbody>
523
- </table>
524
-
525
- </div>
526
-
527
-
528
-
529
-
530
-
531
-
532
-
533
-
534
-
535
-
536
-
537
-
538
-
539
-
540
-
541
-
542
-
543
- <dl class="details">
544
-
545
-
546
-
547
-
548
-
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
- </dl>
575
-
576
-
577
-
578
-
579
- </dd>
580
-
581
-
582
-
583
-
584
- <dt>
585
-
586
- <h4 class="name" id="selectPoi">
587
-
588
- <span class="type-signature"></span>selectPoi<span class="signature">(identifier)</span><span class="type-signature"></span>
589
-
590
-
591
- <div class="container-source members">
592
- <code><a href="map-view-controller.js.html">map-view-controller.js</a></code>,
593
- <code><a href="map-view-controller.js.html#line274">line 274</a></code>
594
- </div>
595
-
596
- </h4>
597
-
598
-
599
-
600
- </dt>
601
- <dd>
602
-
603
-
604
- <div class="description">
605
- Select a <a href="global.html#POI">POI</a> of a building.
606
- </div>
607
-
608
-
609
-
610
-
611
-
612
-
613
-
614
-
615
-
616
- <div class="container-params">
617
- <h5>Parameters:</h5>
618
-
619
- <table class="params">
620
- <thead>
621
- <tr>
622
-
623
- <th>Name</th>
624
-
625
-
626
- <th>Type</th>
627
-
628
-
629
-
630
-
631
-
632
- <th class="last">Description</th>
633
- </tr>
634
- </thead>
635
-
636
- <tbody>
637
-
638
-
639
- <tr>
640
-
641
- <td class="name"><code>identifier</code></td>
642
-
643
-
644
- <td class="type">
645
-
646
-
647
- <span class="param-type">number</span>
648
-
649
-
650
-
651
- </td>
652
-
653
-
654
-
655
-
656
-
657
- <td class="description last">The unique identifier of the resource.</td>
658
- </tr>
659
-
660
-
661
- </tbody>
662
- </table>
663
-
664
- </div>
665
-
666
-
667
-
668
-
669
-
670
-
671
-
672
-
673
-
674
-
675
-
676
-
677
-
678
-
679
-
680
-
681
-
682
- <dl class="details">
683
-
684
-
685
-
686
-
687
-
688
-
689
-
690
-
691
-
692
-
693
-
694
-
695
-
696
-
697
-
698
-
699
-
700
-
701
-
702
-
703
-
704
-
705
-
706
-
707
-
708
-
709
-
710
-
711
-
712
-
713
- </dl>
714
-
715
-
716
-
717
-
718
- </dd>
719
-
720
- </dl>
721
-
722
-
723
-
724
-
725
-
726
- </article>
727
-
728
- </section>
729
-
730
-
731
-
732
-
733
- </div>
734
-
735
- <footer>
736
- <img class="logo" src="https://situm.com/wp-content/uploads/2023/04/situm_logo_blanco_300_sq.png" style="width: 90px; height: 90px">
737
- <div class="footer-text">COPYRIGHT © SITUM TECHNOLOGIES 2014 - 2018</div>
738
- </footer>
739
- <script>prettyPrint();</script>
740
- <script src="scripts/jquery.min.js"></script>
741
- <script src="scripts/tui-doc.js"></script>
742
- <script src="scripts/linenumber.js"></script>
743
-
744
- <script>
745
- var id = 'MapViewControllerImpl_sub'.replace(/"/g, '_');
746
- var selectedApi = document.getElementById(id); // do not use jquery selector
747
- var $selectedApi = $(selectedApi);
748
-
749
- $selectedApi.removeClass('hidden');
750
- $selectedApi.parent().find('.glyphicon').removeClass('glyphicon-plus').addClass('glyphicon-minus');
751
- showLnbApi();
752
- </script>
753
-
754
- </body>
755
- </html>