@situm/cordova 3.0.1 → 3.1.0

package/docs/JSDoc/map-view-controller.js.html

@@ -40,7 +40,7 @@
         <ul></ul>
     </div>
     
-    <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#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#Point">Point</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>
+    <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>
 </nav>
 <div id="resizer"></div>
 
@@ -59,6 +59,8 @@
  */
 class MapViewControllerImpl {
   _onLoadCallback = undefined;
+  _onPoiSelectedCallback = undefined;
+  _onPoiDeselectedCallback = undefined;
   _buildings = undefined;
   _mapView = undefined;
   _isNavigating = false;
@@ -80,22 +82,22 @@ class MapViewControllerImpl {
       type: type,
       payload: payload,
     };
-    if (this._mapView &amp;&amp; this._mapView.firstElementChild){
+    if (this._mapView &amp;&amp; this._mapView.firstElementChild) {
       this._mapView.firstElementChild.contentWindow.postMessage(
         message,
         this._mapView._getViewerDomain()
-      )
-    };
+      );
+    }
   }
 
   // ==================================================
-  // SDK MESSAGES: 
+  // SDK MESSAGES:
   // ==================================================
 
   _handleSdkNativeEvents(eventName, payload) {
     switch (eventName) {
       case "onLocationUpdate":
-        // TODO: iOS is sending messages here not related to Location. Check 
+        // TODO: iOS is sending messages here not related to Location. Check
         // some fields to avoid assuming that we receive an object of type Location.
         if (payload.buildingIdentifier &amp;&amp; payload.position) {
           this._handleOnLocationUpdate(payload);
@@ -115,30 +117,49 @@ class MapViewControllerImpl {
           // Do nothing.
         },
         () => {
-          console.error("Error at updateNavigationWithLocation")
+          console.error("Error at updateNavigationWithLocation");
         }
       );
     }
   }
 
   _handleOnLocationStatus(payload) {
-    this._sendMessageToViewer("location.update_status", {status: payload.statusName});
+    this._sendMessageToViewer("location.update_status", {
+      status: payload.statusName,
+    });
   }
 
   // ==================================================
-  // MAP-VIEWER MESSAGES: 
+  // MAP-VIEWER MESSAGES:
   // ==================================================
 
   _handleMapViewMessages(m) {
     switch (m.type) {
       case "app.map_is_ready":
-        if (this._onLoadCallback &amp;&amp; typeof this._onLoadCallback === 'function') {
+        if (
+          this._onLoadCallback &amp;&amp;
+          typeof this._onLoadCallback === "function"
+        ) {
           this._onLoadCallback(this);
-          console.debug('Map is ready!');
+          console.debug("Map is ready!");
         }
         break;
       case "cartography.poi_selected":
         console.debug(`poi (${m.payload.identifier}) was selected`);
+        this._onPoiSelectedCallback({
+          poi: {
+            identifier: m.payload.identifier,
+            buildingIdentifier: m.payload.buildingIdentifier,
+          },
+        });
+        break;
+      case "cartography.poi_deselected":
+        this._onPoiDeselectedCallback({
+          poi: {
+            identifier: m.payload.identifier,
+            buildingIdentifier: m.payload.buildingIdentifier,
+          },
+        });
         break;
       case "directions.requested":
         this._onDirectionsRequested(m.payload);
@@ -158,14 +179,18 @@ class MapViewControllerImpl {
   // Fetch the given building and return it or undefined if not found.
   _ensureBuilding(buildingId, callback) {
     if (this._buildings) {
-      let building = this._buildings.find(b => b.buildingIdentifier == buildingId);
+      let building = this._buildings.find(
+        (b) => b.buildingIdentifier == buildingId
+      );
       callback(building);
     } else {
       // Fetch buildings and calculate route.
       cordova.plugins.Situm.fetchBuildings(
         (res) => {
           this._buildings = res;
-          let building = this._buildings.find(b => b.buildingIdentifier == buildingId);
+          let building = this._buildings.find(
+            (b) => b.buildingIdentifier == buildingId
+          );
           callback(building);
         },
         (err) => {
@@ -184,20 +209,34 @@ class MapViewControllerImpl {
       originIdentifier: payload.originIdentifier,
       destinationIdentifier: payload.destinationIdentifier,
       type: directionsRequest.accessibilityMode,
-    }
+    };
     this._ensureBuilding(payload.buildingIdentifier, (building) => {
-      if (building){
+      if (building) {
         Situm.requestDirections(
-          [building, directionsRequest.from, directionsRequest.to, directionsRequest],
+          [
+            building,
+            directionsRequest.from,
+            directionsRequest.to,
+            directionsRequest,
+          ],
           (route) => {
-            this._sendMessageToViewer("directions.update", { ...route, ...mapViewerData });
+            this._sendMessageToViewer("directions.update", {
+              ...route,
+              ...mapViewerData,
+            });
           },
           (error) => {
-            this._sendMessageToViewer("directions.update", { error: -1, identifier: mapViewerData.identifier });
+            this._sendMessageToViewer("directions.update", {
+              error: -1,
+              identifier: mapViewerData.identifier,
+            });
           }
         );
       } else {
-        this._sendMessageToViewer("directions.update", { error: -1, identifier: payload.identifier });
+        this._sendMessageToViewer("directions.update", {
+          error: -1,
+          identifier: payload.identifier,
+        });
       }
     });
   }
@@ -211,36 +250,55 @@ class MapViewControllerImpl {
       originIdentifier: payload.originIdentifier,
       destinationIdentifier: payload.destinationIdentifier,
       type: directionsRequest.accessibilityMode,
-    }
+    };
     let navigationRequest = payload.navigationRequest;
     this._ensureBuilding(payload.buildingIdentifier, (building) => {
       // Request directions again to update the calculated route on the native side.
       Situm.requestDirections(
-        [building, directionsRequest.from, directionsRequest.to, directionsRequest],
+        [
+          building,
+          directionsRequest.from,
+          directionsRequest.to,
+          directionsRequest,
+        ],
         (route) => {
           this._isNavigating = true;
-          this._sendMessageToViewer("navigation.start", { ...route, ...mapViewerData });
+          this._sendMessageToViewer("navigation.start", {
+            ...route,
+            ...mapViewerData,
+          });
           Situm.requestNavigationUpdates(
             [navigationRequest],
             (progress) => {
               // Navigation is working, handle different progress types:
               if (progress.type == "progress") {
-                progress.type = 'PROGRESS'; // The map-viewer waits for an upper case "type".
+                progress.type = "PROGRESS"; // The map-viewer waits for an upper case "type".
                 this._sendMessageToViewer("navigation.update", progress);
               } else if (progress.type == "destinationReached") {
-                this._sendMessageToViewer("navigation.update", {type: "DESTINATION_REACHED"});
+                this._sendMessageToViewer("navigation.update", {
+                  type: "DESTINATION_REACHED",
+                });
                 this._isNavigating = false;
               } else if (progress.type == "userOutsideRoute") {
-                this._sendMessageToViewer("navigation.update", {type: "OUT_OF_ROUTE"});
+                this._sendMessageToViewer("navigation.update", {
+                  type: "OUT_OF_ROUTE",
+                });
               }
             },
             (error) => {
-              this._sendMessageToViewer("directions.update", { error: -1, identifier: mapViewerData.identifier });
+              this._sendMessageToViewer("directions.update", {
+                error: -1,
+                identifier: mapViewerData.identifier,
+              });
               this._isNavigating = false;
-            });
+            }
+          );
         },
         (error) => {
-          this._sendMessageToViewer("directions.update", { error: -1, identifier: mapViewerData.identifier });
+          this._sendMessageToViewer("directions.update", {
+            error: -1,
+            identifier: mapViewerData.identifier,
+          });
           this._isNavigating = false;
         }
       );
@@ -268,9 +326,50 @@ class MapViewControllerImpl {
    * @param {number} identifier The unique identifier of the resource.
    * */
   selectPoi(identifier) {
-    this._sendMessageToViewer("cartography.select_poi", { identifier: identifier });
+    this._sendMessageToViewer("cartography.select_poi", {
+      identifier: identifier,
+    });
   }
 
+  /**
+   * Navigate to a POI of a building.
+   *
+   * The types of {@link accessibilityMode} you can use are:
+   * - 'CHOOSE_SHORTEST' : Calculates the shortest route to the destination {@link POI}.
+   * - 'ONLY_ACCESSIBLE' : Calculates the shortest route to the destination {@link POI} but avoiding stairs and prioritizing accessible floor changes such as lifts.
+   * - 'ONLY_NOT_ACCESSIBLE_FLOOR_CHANGES' : Calculates the shortest route to the destination {@link POI} but avoiding lifts and prioritizing non-accessible floor changes such as stairs.
+   *
+   * accessibilityMode defaults to CHOOSE_SHORTEST.
+   *
+   * @param {number} identifier The identifier of the poi.
+   * @param {'CHOOSE_SHORTEST' | 'ONLY_ACCESSIBLE' | 'ONLY_NOT_ACCESSIBLE_FLOOR_CHANGES' | undefined} accessibilityMode Choose the route type to calculate.
+   * */
+  navigateToPoi(identifier, accessibilityMode) {
+    this._sendMessageToViewer("navigation.start", {
+      navigationTo: identifier,
+      type: accessibilityMode,
+    });
+  }
+
+  // ==================================================
+  // EVENTS
+  // ==================================================
+
+  /**
+   * A POI was selected in your building.
+   * @param {Function} cb A callback that returns a {@link PoiSelectedResult} by its parameters.
+   * */
+  onPoiSelected(cb) {
+    this._onPoiSelectedCallback = callback;
+  }
+
+  /**
+   * A POI was deselected in your building.
+   * @param {Function} cb A callback that returns a {@link PoiDeselectedResult} by its parameters.
+   * */
+  onPoiDeselected(cb) {
+    this._onPoiDeselectedCallback = callback;
+  }
 }
 
 let MapViewController = new MapViewControllerImpl();

package/docs/JSDoc/map-view.js.html

@@ -40,7 +40,7 @@
         <ul></ul>
     </div>
     
-    <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#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#Point">Point</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>
+    <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>
 </nav>
 <div id="resizer"></div>
 
@@ -53,7 +53,6 @@
     <section>
         <article>
             <pre class="prettyprint source linenums"><code>const MapViewController = require('./map-view-controller');
-
 /**
  * @namespace MapView
  */

package/docs/JSDoc/styles/custom.css

@@ -18,6 +18,10 @@ footer > img {
     color: rgb(0,161,223);
 }
 
+.description {
+    white-space: pre-line;
+}
+
 #resizer {
     background-color: rgb(0,161,223);
 }

package/docs/static/styles/custom.css

@@ -18,6 +18,10 @@ footer > img {
     color: rgb(0,161,223);
 }
 
+.description {
+    white-space: pre-line;
+}
+
 #resizer {
     background-color: rgb(0,161,223);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@situm/cordova",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Set of utilities that allow any developer to build Cordova location based apps using Situm's indoor positioning system.",
   "private": false,
   "repository": "https://github.com/situmtech/cordova",

package/plugin.xml

@@ -2,7 +2,7 @@
 
 <plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
     id="@situm/cordova"
-    version="3.0.1">
+    version="3.1.0">
     <name>Situm Cordova plugin Official</name>
     <description>This is the stable branch.</description>
     <license>MIT</license>

package/www/android/Interfaces.js

@@ -739,4 +739,40 @@ var RealTimeData = {
   locations,
 }
 
-module.exports = RealTimeData
+module.exports = RealTimeData
+
+/**
+ * @name
+ * PoiSelectedResult
+ * @description
+ * An object that contains the identifier of the {@link POI} the user has selected and the building indentifier where it is located.
+ * @property {number} identifier The unique identifier of the {@link POI} selected.
+ * @property {number} buildingIdentifier The unique identifier of the building where the {@link POI} is located at.
+ */
+
+var PoiSelectedResult = {
+  poi: {
+    identifier,
+    buildingIdentifier,
+  },
+};
+
+module.exports = PoiSelectedResult;
+
+/**
+ * @name
+ * PoiDeselectedResult
+ * @description
+ * An object that contains the identifier of the {@link POI} the user has deselected and the building indentifier where it is located.
+ * @property {number} identifier The unique identifier of the {@link POI} deselected.
+ * @property {number} buildingIdentifier The unique identifier of the building where the {@link POI} is located at.
+ */
+
+var PoiDeselectedResult = {
+  poi: {
+    identifier,
+    buildingIdentifier,
+  }
+};
+
+module.exports = PoiDeselectedResult;