@situm/cordova 3.14.0 → 3.14.1

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.
@@ -40,7 +40,7 @@
40
40
  <ul></ul>
41
41
  </div>
42
42
 
43
- <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="MapViewController.html">MapViewController</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="MapViewController_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="MapViewController.html#.navigateToPoi">navigateToPoi</a></li><li><a href="MapViewController.html#.onPoiDeselected">onPoiDeselected</a></li><li><a href="MapViewController.html#.onPoiSelected">onPoiSelected</a></li><li><a href="MapViewController.html#.selectPoi">selectPoi</a></li><li><a href="MapViewController.html#.setLanguage">setLanguage</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#.onLocationError">onLocationError</a></li><li><a href="Situm.html#.onLocationStatus">onLocationStatus</a></li><li><a href="Situm.html#.onLocationUpdate">onLocationUpdate</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#.removeUpdates">removeUpdates</a></li><li><a href="Situm.html#.requestDirections">requestDirections</a></li><li><a href="Situm.html#.requestLocationUpdates">requestLocationUpdates</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 class="hidden"><a href="global.html#OnLocationErrorCallback">OnLocationErrorCallback</a></li><li class="hidden"><a href="global.html#OnLocationStatusCallback">OnLocationStatusCallback</a></li><li class="hidden"><a href="global.html#OnLocationUpdateCallback">OnLocationUpdateCallback</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>
43
+ <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="MapViewController.html">MapViewController</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="MapViewController_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="MapViewController.html#.navigateToPoi">navigateToPoi</a></li><li><a href="MapViewController.html#.onPoiDeselected">onPoiDeselected</a></li><li><a href="MapViewController.html#.onPoiSelected">onPoiSelected</a></li><li><a href="MapViewController.html#.selectPoi">selectPoi</a></li><li><a href="MapViewController.html#.setDirectionsOptions">setDirectionsOptions</a></li><li><a href="MapViewController.html#.setLanguage">setLanguage</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#.getDeviceId">getDeviceId</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#.onLocationError">onLocationError</a></li><li><a href="Situm.html#.onLocationStatus">onLocationStatus</a></li><li><a href="Situm.html#.onLocationUpdate">onLocationUpdate</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#.removeUpdates">removeUpdates</a></li><li><a href="Situm.html#.requestDirections">requestDirections</a></li><li><a href="Situm.html#.requestLocationUpdates">requestLocationUpdates</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#.updateNavigationState">updateNavigationState</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#ExternalNavigation">ExternalNavigation</a></li><li><a href="global.html#Floor">Floor</a></li><li><a href="global.html#ForegroundServiceNotificationOptions">ForegroundServiceNotificationOptions</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 class="hidden"><a href="global.html#MapViewDirectionsOptions">MapViewDirectionsOptions</a></li><li><a href="global.html#NavigationProgress">NavigationProgress</a></li><li><a href="global.html#NavigationRequest">NavigationRequest</a></li><li class="hidden"><a href="global.html#OnLocationErrorCallback">OnLocationErrorCallback</a></li><li class="hidden"><a href="global.html#OnLocationStatusCallback">OnLocationStatusCallback</a></li><li class="hidden"><a href="global.html#OnLocationUpdateCallback">OnLocationUpdateCallback</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>
44
44
  </nav>
45
45
  <div id="resizer"></div>
46
46
 
@@ -85,9 +85,9 @@ var Building = {
85
85
  rotation,
86
86
  userIdentifier,
87
87
  customFields
88
- }
88
+ };
89
89
 
90
- module.exports = Building
90
+ module.exports = Building;
91
91
 
92
92
  /** @name
93
93
  * BuildingInfo
@@ -106,9 +106,9 @@ var BuildingInfo = {
106
106
  indoorPois,
107
107
  outdoorPois,
108
108
  events
109
- }
109
+ };
110
110
 
111
- module.exports = BuildingInfo
111
+ module.exports = BuildingInfo;
112
112
 
113
113
  /**
114
114
  * @name
@@ -131,9 +131,9 @@ var Floor = {
131
131
  mapUrl,
132
132
  scale,
133
133
  floorIdentifier
134
- }
134
+ };
135
135
 
136
- module.exports = Floor
136
+ module.exports = Floor;
137
137
 
138
138
  /** @name
139
139
  * Dimensions
@@ -146,9 +146,9 @@ module.exports = Floor
146
146
  var Dimensions = {
147
147
  width,
148
148
  height
149
- }
149
+ };
150
150
 
151
- module.exports = Dimensions
151
+ module.exports = Dimensions;
152
152
 
153
153
  /** @name
154
154
  * Bounds
@@ -165,9 +165,9 @@ var Bounds = {
165
165
  northWest,
166
166
  southEast,
167
167
  southWest
168
- }
168
+ };
169
169
 
170
- module.exports = Bounds
170
+ module.exports = Bounds;
171
171
 
172
172
  /**
173
173
  * @name
@@ -181,9 +181,9 @@ module.exports = Bounds
181
181
  var Coordinate = {
182
182
  latitude,
183
183
  longitude
184
- }
184
+ };
185
185
 
186
- module.exports = Coordinate
186
+ module.exports = Coordinate;
187
187
 
188
188
  /**
189
189
  * @name
@@ -197,9 +197,9 @@ module.exports = Coordinate
197
197
  var CartesianCoordinate = {
198
198
  x,
199
199
  y
200
- }
200
+ };
201
201
 
202
- module.exports = CartesianCoordinate
202
+ module.exports = CartesianCoordinate;
203
203
 
204
204
  /**
205
205
  * @name
@@ -233,9 +233,9 @@ var Poi = {
233
233
  category,
234
234
  infoHtml,
235
235
  customFields
236
- }
236
+ };
237
237
 
238
- module.exports = Poi
238
+ module.exports = Poi;
239
239
 
240
240
  /**
241
241
  * @name
@@ -258,9 +258,9 @@ var Geofence = {
258
258
  infoHtml,
259
259
  polygonPoints,
260
260
  customFields
261
- }
261
+ };
262
262
 
263
- module.exports = Geofence
263
+ module.exports = Geofence;
264
264
 
265
265
  /**
266
266
  * @name
@@ -274,16 +274,15 @@ module.exports = Geofence
274
274
  * @property {boolean} public - Whether the category is public or not
275
275
  */
276
276
 
277
-
278
277
  var PoiCategory = {
279
278
  poiCategoryCode,
280
279
  poiCategoryName,
281
280
  icon_selected,
282
281
  icon_unselected,
283
282
  public
284
- }
283
+ };
285
284
 
286
- module.exports = PoiCategory
285
+ module.exports = PoiCategory;
287
286
 
288
287
  /**
289
288
  * @name
@@ -305,9 +304,9 @@ var Point = {
305
304
  floorIdentifier,
306
305
  isIndoor,
307
306
  isOutdoor
308
- }
307
+ };
309
308
 
310
- module.exports = Point
309
+ module.exports = Point;
311
310
 
312
311
  /**
313
312
  * @name
@@ -351,9 +350,9 @@ var Location = {
351
350
  isIndoor,
352
351
  isOutdoor,
353
352
  deviceId
354
- }
353
+ };
355
354
 
356
- module.exports = Location
355
+ module.exports = Location;
357
356
 
358
357
  /**
359
358
  * @name
@@ -367,9 +366,9 @@ module.exports = Location
367
366
  var LocationStatus = {
368
367
  statusName,
369
368
  statusOrdinal
370
- }
369
+ };
371
370
 
372
- module.exports = LocationStatus
371
+ module.exports = LocationStatus;
373
372
 
374
373
  /**
375
374
  * @name
@@ -387,9 +386,9 @@ var Angle = {
387
386
  degreesClockwise,
388
387
  radians,
389
388
  radiansMinusPiPi
390
- }
389
+ };
391
390
 
392
- module.exports = Angle
391
+ module.exports = Angle;
393
392
 
394
393
  /**
395
394
  * @name
@@ -419,9 +418,9 @@ var Route = {
419
418
  to,
420
419
  steps,
421
420
  segments
422
- }
421
+ };
423
422
 
424
- module.exports = Route
423
+ module.exports = Route;
425
424
 
426
425
  /**
427
426
  * @name
@@ -445,9 +444,9 @@ var RouteStep = {
445
444
  to,
446
445
  isFirst,
447
446
  isLast
448
- }
447
+ };
449
448
 
450
- module.exports = RouteStep
449
+ module.exports = RouteStep;
451
450
 
452
451
  /**
453
452
  * @name
@@ -461,9 +460,9 @@ module.exports = RouteStep
461
460
  var RouteSegment = {
462
461
  floorIdentifier,
463
462
  points
464
- }
463
+ };
465
464
 
466
- module.exports = RouteSegment
465
+ module.exports = RouteSegment;
467
466
 
468
467
  /**
469
468
  * @name
@@ -489,10 +488,9 @@ var Indication = {
489
488
  stepIdxDestination,
490
489
  stepIdxOrigin,
491
490
  neededLevelChange
492
- }
493
-
494
- module.exports = Indication
491
+ };
495
492
 
493
+ module.exports = Indication;
496
494
 
497
495
  /**
498
496
  * @name
@@ -528,10 +526,9 @@ var NavigationProgress = {
528
526
  routeStep,
529
527
  points,
530
528
  segments
531
- }
532
-
533
- module.exports = NavigationProgress
529
+ };
534
530
 
531
+ module.exports = NavigationProgress;
535
532
 
536
533
  /**
537
534
  * @name
@@ -563,9 +560,9 @@ var SitumEvent = {
563
560
  name,
564
561
  x,
565
562
  y
566
- }
563
+ };
567
564
 
568
- module.exports = SitumEvent
565
+ module.exports = SitumEvent;
569
566
 
570
567
  /**
571
568
  * @name
@@ -584,10 +581,10 @@ var SitumConversionArea = {
584
581
  topLeft,
585
582
  topRight,
586
583
  bottomLeft,
587
- bottomRight,
588
- }
584
+ bottomRight
585
+ };
589
586
 
590
- module.exports = Circle
587
+ module.exports = Circle;
591
588
 
592
589
  /**
593
590
  * @name
@@ -600,10 +597,10 @@ module.exports = Circle
600
597
 
601
598
  var Circle = {
602
599
  center,
603
- radius,
604
- }
600
+ radius
601
+ };
605
602
 
606
- module.exports = SitumConversionArea
603
+ module.exports = SitumConversionArea;
607
604
 
608
605
  /**
609
606
  * @name
@@ -625,6 +622,7 @@ module.exports = SitumConversionArea
625
622
  * @property {number} smallestDisplacement - Default smallest displacement to nofiy location updates
626
623
  * @property {string} realtimeUpdateInterval - Default interval to send locations to the Realtime. Possible values are REALTIME, FAST, NORMAL, SLOW and BATTERY_SAVER
627
624
  * @property {boolean} autoEnableBleDuringPositioning - Set if the BLE should be re-enabled during positioning if the ble is used. Android only
625
+ * @property {ForegroundServiceNotificationOptions} foregroundServiceNotificationOptions - Used to configure the notification options for a foreground service, allowing the definition of the title, message, stop button, button text, and the {@link ForegroundServiceNotificationsTapAction}.
628
626
  */
629
627
  var LocationRequest = {
630
628
  buildingIdentifier,
@@ -642,10 +640,40 @@ var LocationRequest = {
642
640
  smallestDisplacement,
643
641
  realtimeUpdateInterval,
644
642
  autoEnableBleDuringPositioning,
643
+ foregroundServiceNotificationOptions
645
644
  };
646
645
 
647
646
  module.exports = LocationRequest;
648
647
 
648
+ /**
649
+ * @name ForegroundServiceNotificationOptions
650
+ *
651
+ * @description
652
+ * (Only applies for Android)
653
+ *
654
+ * A data object that let you customize the Foreground Service Notification
655
+ * that will be shown in the system's tray when the app is running as a
656
+ * Foreground Service. These options are defined within the {@link LocationRequest}.
657
+ *
658
+ * You can use the following tapAction behaviour:
659
+ * - 'LAUNCH_APP': Launch the app's main activity. This is the default value.
660
+ * - 'LAUNCH_SETTINGS': Launch the operating system settings screen for the app.
661
+ * - 'DO_NOTHING': Do nothing when tapping the notification.
662
+ * @property {string} title
663
+ * @property {string} message
664
+ * @property {boolean} showStopAction Whether to show or not the button that stops the positioning system. Defaults to true.
665
+ * @property {string} stopActionText
666
+ * @property {'DO_NOTHING' | 'LAUNCH_APP' | 'LAUNCH_SETTINGS'} tapAction Predefined actions performed when tapping the Situm Foreground Service Notification. Defaults to 'LAUNCH_APP'.
667
+ */
668
+ var ForegroundServiceNotificationOptions = {
669
+ title,
670
+ message,
671
+ showStopAction,
672
+ stopActionText,
673
+ tapAction
674
+ };
675
+ module.exports = ForegroundServiceNotificationOptions;
676
+
649
677
  /**
650
678
  * @name
651
679
  * LocationOptions
@@ -655,7 +683,7 @@ module.exports = LocationRequest;
655
683
  */
656
684
  var LocationOptions = LocationRequest;
657
685
 
658
- module.exports = LocationOptions
686
+ module.exports = LocationOptions;
659
687
 
660
688
  /**
661
689
  * @name
@@ -683,9 +711,9 @@ var NavigationRequest = {
683
711
  timeToFirstIndication,
684
712
  roundIndicationsStep,
685
713
  timeToIgnoreUnexpectedFloorChanges
686
- }
714
+ };
687
715
 
688
- module.exports = NavigationRequest
716
+ module.exports = NavigationRequest;
689
717
 
690
718
  /**
691
719
  * @name
@@ -703,9 +731,24 @@ var DirectionsRequest = {
703
731
  from,
704
732
  to,
705
733
  options
706
- }
734
+ };
707
735
 
708
- module.exports = DirectionsRequest
736
+ module.exports = DirectionsRequest;
737
+
738
+ /**
739
+ * @name
740
+ * ExternalNavigation
741
+ * @description
742
+ * For internal use only.
743
+ * @property {String} messageType
744
+ * @property {Map} payload
745
+ */
746
+ var ExternalNavigation = {
747
+ messageType,
748
+ payload
749
+ };
750
+
751
+ module.exports = ExternalNavigation;
709
752
 
710
753
  /**
711
754
  * @name
@@ -717,15 +760,19 @@ module.exports = DirectionsRequest
717
760
  * @property {boolean} accessible - Defines wheter or not the route has to be suitable for wheel chairs (true) or not (false). @deprecated, use accessibilityMode
718
761
  * @property {string} accessibilityMode - Defines the accessibility mode of the route. Possible values are: CHOOSE_SHORTEST, ONLY_NOT_ACCESSIBLE_FLOOR_CHANGES, ONLY_ACCESSIBLE
719
762
  * @property {number} startingAngle - Current user's orientation in degrees.
763
+ * @property {stting[]} includedTags - List of tags that you want to use when calculating a route. Only the tags added here will be used. If there are other tags in the graph they won't be used. The edges without a tag will be used. If you don't set nothing all the graph will be used to calculate the route. You can learn more about this topic on https://situm.com/docs/cartography-management/#tags
764
+ * @property {stting[]} excludedTags - List of tags that you want your route to avoid. If you exclude a tag the route will never pass through an edge that have this tag. If the route can only be generated passing through an edge with this tag the route calculation will fail. You can learn more about this topic on https://situm.com/docs/cartography-management/#tags.
720
765
  */
721
766
 
722
767
  var DirectionsOptions = {
723
768
  minimizeFloorChanges,
724
769
  accessibleRoute,
725
- startingAngle
726
- }
770
+ startingAngle,
771
+ includedTags,
772
+ excludedTags
773
+ };
727
774
 
728
- module.exports = DirectionsOptions
775
+ module.exports = DirectionsOptions;
729
776
 
730
777
  /**
731
778
  * @name
@@ -741,9 +788,9 @@ var OutdoorLocationOptions = {
741
788
  userDefinedThreshold,
742
789
  computeInterval,
743
790
  averageSnrThreshold
744
- }
791
+ };
745
792
 
746
- module.exports = OutdoorLocationOptions
793
+ module.exports = OutdoorLocationOptions;
747
794
 
748
795
  /**
749
796
  * @name
@@ -755,9 +802,9 @@ module.exports = OutdoorLocationOptions
755
802
 
756
803
  var BeaconFilter = {
757
804
  uuid
758
- }
805
+ };
759
806
 
760
- module.exports = BeaconFilter
807
+ module.exports = BeaconFilter;
761
808
 
762
809
  /**
763
810
  * @name
@@ -770,10 +817,10 @@ module.exports = BeaconFilter
770
817
 
771
818
  var RealTimeRequest = {
772
819
  building,
773
- pollTime,
774
- }
820
+ pollTime
821
+ };
775
822
 
776
- module.exports = RealTimeRequest
823
+ module.exports = RealTimeRequest;
777
824
 
778
825
  /**
779
826
  * @name
@@ -784,10 +831,10 @@ module.exports = RealTimeRequest
784
831
  */
785
832
 
786
833
  var RealTimeData = {
787
- locations,
788
- }
834
+ locations
835
+ };
789
836
 
790
- module.exports = RealTimeData
837
+ module.exports = RealTimeData;
791
838
 
792
839
  /**
793
840
  * @name
@@ -801,8 +848,8 @@ module.exports = RealTimeData
801
848
  var PoiSelectedResult = {
802
849
  poi: {
803
850
  identifier,
804
- buildingIdentifier,
805
- },
851
+ buildingIdentifier
852
+ }
806
853
  };
807
854
 
808
855
  module.exports = PoiSelectedResult;
@@ -819,11 +866,12 @@ module.exports = PoiSelectedResult;
819
866
  var PoiDeselectedResult = {
820
867
  poi: {
821
868
  identifier,
822
- buildingIdentifier,
869
+ buildingIdentifier
823
870
  }
824
871
  };
825
872
 
826
- module.exports = PoiDeselectedResult;</code></pre>
873
+ module.exports = PoiDeselectedResult;
874
+ </code></pre>
827
875
  </article>
828
876
  </section>
829
877
 
@@ -38,7 +38,7 @@
38
38
  <ul></ul>
39
39
  </div>
40
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="MapViewController.html">MapViewController</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="MapViewController_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="MapViewController.html#.navigateToPoi">navigateToPoi</a></li><li><a href="MapViewController.html#.onPoiDeselected">onPoiDeselected</a></li><li><a href="MapViewController.html#.onPoiSelected">onPoiSelected</a></li><li><a href="MapViewController.html#.selectPoi">selectPoi</a></li><li><a href="MapViewController.html#.setLanguage">setLanguage</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#.onLocationError">onLocationError</a></li><li><a href="Situm.html#.onLocationStatus">onLocationStatus</a></li><li><a href="Situm.html#.onLocationUpdate">onLocationUpdate</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#.removeUpdates">removeUpdates</a></li><li><a href="Situm.html#.requestDirections">requestDirections</a></li><li><a href="Situm.html#.requestLocationUpdates">requestLocationUpdates</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 class="hidden"><a href="global.html#OnLocationErrorCallback">OnLocationErrorCallback</a></li><li class="hidden"><a href="global.html#OnLocationStatusCallback">OnLocationStatusCallback</a></li><li class="hidden"><a href="global.html#OnLocationUpdateCallback">OnLocationUpdateCallback</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>
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="MapViewController.html">MapViewController</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="MapViewController_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="MapViewController.html#.navigateToPoi">navigateToPoi</a></li><li><a href="MapViewController.html#.onPoiDeselected">onPoiDeselected</a></li><li><a href="MapViewController.html#.onPoiSelected">onPoiSelected</a></li><li><a href="MapViewController.html#.selectPoi">selectPoi</a></li><li><a href="MapViewController.html#.setDirectionsOptions">setDirectionsOptions</a></li><li><a href="MapViewController.html#.setLanguage">setLanguage</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#.getDeviceId">getDeviceId</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#.onLocationError">onLocationError</a></li><li><a href="Situm.html#.onLocationStatus">onLocationStatus</a></li><li><a href="Situm.html#.onLocationUpdate">onLocationUpdate</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#.removeUpdates">removeUpdates</a></li><li><a href="Situm.html#.requestDirections">requestDirections</a></li><li><a href="Situm.html#.requestLocationUpdates">requestLocationUpdates</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#.updateNavigationState">updateNavigationState</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#ExternalNavigation">ExternalNavigation</a></li><li><a href="global.html#Floor">Floor</a></li><li><a href="global.html#ForegroundServiceNotificationOptions">ForegroundServiceNotificationOptions</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 class="hidden"><a href="global.html#MapViewDirectionsOptions">MapViewDirectionsOptions</a></li><li><a href="global.html#NavigationProgress">NavigationProgress</a></li><li><a href="global.html#NavigationRequest">NavigationRequest</a></li><li class="hidden"><a href="global.html#OnLocationErrorCallback">OnLocationErrorCallback</a></li><li class="hidden"><a href="global.html#OnLocationStatusCallback">OnLocationStatusCallback</a></li><li class="hidden"><a href="global.html#OnLocationUpdateCallback">OnLocationUpdateCallback</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
42
  </nav>
43
43
  <div id="resizer"></div>
44
44
 
@@ -188,7 +188,7 @@ Here's an example on how to implement this in your html view:
188
188
 
189
189
  <div class="container-source members">
190
190
  <code><a href="map-view.js.html">map-view.js</a></code>,
191
- <code><a href="map-view.js.html#line137">line 137</a></code>
191
+ <code><a href="map-view.js.html#line151">line 151</a></code>
192
192
  </div>
193
193
 
194
194
  </h4>