@situm/cordova 3.2.4 → 3.3.0

package/README.md

@@ -2,9 +2,7 @@
 <h1 align="center">Situm Cordova Plugin</h1>
 </p>
 
-<div align="center" style="text-align:center">
 Situm Cordova Plugin is a set of utilities that allow any developer to build Cordova location based apps using Situm's indoor positioning system. Among many other capabilities, apps developed with Situm Cordova Plugin will be able to:
-</div>
 
 - Obtain information related to buildings where Situm's positioning system is already configured: floorplans, points of interest, geotriggered events, etc.
 - Retrieve the location of the smartphone inside these buildings (position, orientation, and floor where the smartphone is).
@@ -70,7 +68,7 @@ Situm Cordova Plugin is licensed under [MIT License](https://opensource.org/lice
 ### Methods
 
 > [!NOTE]
-> This plugin is currently under development. There may be method not implemented yet. Also there may be some API changes as development progresses.
+> This plugin is currently under development. There may be methods not implemented yet. Also there may be some API changes as development progresses.
 
 ### Situm class
 

package/example/package-lock.json

@@ -67,7 +67,7 @@
     },
     "..": {
       "name": "@situm/cordova",
-      "version": "3.1.0",
+      "version": "3.3.0",
       "engines": [
         {
           "name": "cordova-android",

package/example/src/app/wyf/wyf.page.html

@@ -16,6 +16,7 @@
     viewer-domain="https://map-viewer.situm.com"
     situm-api-key="YOUR_SITUM_API_KEY"
     building-identifier="YOUR_BUILDING_IDENTIFIER"
+    remote-identifier="YOUR_REMOTE_IDENTIFIER"
     #mapView
   />
   <!-- WARNING: We will be overwritting this attributes with the values in constants.ts -->

package/example/src/app/wyf/wyf.page.ts

@@ -43,5 +43,10 @@ export class WYFPage {
       'building-identifier',
       Constants.BUILDING_IDENTIFIER
     );
+
+    this.mapView?.nativeElement.setAttribute(
+      'remote-identifier',
+      Constants.REMOTE_IDENTIFIER
+    );
   }
 }

package/example/src/constants.ts.example

@@ -3,4 +3,5 @@
 export const API_USER = 'YOUR_SITUM_API_USER';
 export const API_KEY = 'YOUR_SITUM_API_KEY';
 export const BUILDING_IDENTIFIER = 'YOUR_BUILDING_IDENTIFIER';
+export const REMOTE_IDENTIFIER = 'YOUR_REMOTE_IDENTIFIER';
 export const VIEWER_DOMAIN = 'https://map-viewer.situm.com';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@situm/cordova",
-  "version": "3.2.4",
+  "version": "3.3.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.2.4">
+    version="3.3.0">
     <name>Situm Cordova plugin Official</name>
     <description>This is the stable branch.</description>
     <license>MIT</license>

package/src/android/app/build.gradle

@@ -44,7 +44,7 @@ dependencies {
     implementation ('com.googlecode.json-simple:json-simple:1.1.1'){
         exclude group: 'junit', module:'junit'
     }
-    implementation ('es.situm:situm-sdk:3.9.2@aar') {
+    implementation ('es.situm:situm-sdk:3.9.3@aar') {
         transitive = true
     }
     implementation 'org.apache.cordova:framework:10.1.1'

package/src/android/situm.gradle

@@ -13,7 +13,7 @@ allprojects {
 dependencies {
     implementation 'com.google.android.gms:play-services-maps:16.0.0'
     implementation 'com.google.android.gms:play-services-location:16.0.0'
-    implementation('es.situm:situm-sdk:3.9.2@aar') {
+    implementation('es.situm:situm-sdk:3.9.3@aar') {
         transitive = true
     }
 }

package/www/android/Interfaces.js

@@ -745,7 +745,7 @@ 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.
+ * An object that contains the identifier of the {@link POI} the user has selected and the building identifier 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.
  */
@@ -763,7 +763,7 @@ 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.
+ * An object that contains the identifier of the {@link POI} the user has deselected and the building identifier 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.
  */

package/www/map-view-controller.js

@@ -270,7 +270,8 @@ class MapViewControllerImpl {
   // ==================================================
 
   /**
-   * Select a {@link POI} of a building.
+   * Allows you to select a {@link POI} programmatically in your venue. This will cause the {@link MapView} to center the view on that POI and show its information.
+   * 
    * @param {number} identifier The unique identifier of the resource.
    * */
   selectPoi(identifier) {
@@ -280,7 +281,7 @@ class MapViewControllerImpl {
   }
 
   /**
-   * Navigate to a {@link POI} of a building.
+   * Allows you to navigate to a {@link POI} programmatically in your venue. This will cause the {@link MapView} to start navigation mode displaying the route between the user's location and the POI specified by parameters.
    *
    * The types of {@link accessibilityMode} you can use are:
    * - 'CHOOSE_SHORTEST' : Calculates the shortest route to the destination {@link POI}.
@@ -299,12 +300,23 @@ class MapViewControllerImpl {
     });
   }
 
+  /**
+   * Allows you to change the initial language that <map-view> uses to display its UI. 
+   * Checkout the [Situm docs](https://situm.com/docs/query-params/) to see the list of
+   * supported languages.
+   * 
+   * @param {string} language an ISO 639-1 code.
+   */
+  setLanguage(language){
+    this._sendMessageToViewer("ui.set_language", language);
+  }
+
   // ==================================================
   // EVENTS
   // ==================================================
 
   /**
-   * A {@link POI} was selected in your building.
+   * Informs you, through the function you pass as callback ({@link cb}), that a {@link POI} was selected in your building.
    * @param {Function} cb A callback that returns a {@link PoiSelectedResult} by its parameters.
    * */
   onPoiSelected(cb) {
@@ -312,7 +324,7 @@ class MapViewControllerImpl {
   }
 
   /**
-   * A {@link POI} was deselected in your building.
+   * Informs you, through the function you pass as callback ({@link cb}), that a {@link POI} was deselected in your building.
    * @param {Function} cb A callback that returns a {@link PoiDeselectedResult} by its parameters.
    * */
   onPoiDeselected(cb) {

package/www/map-view.js

@@ -33,10 +33,15 @@ class MapView extends HTMLElement {
     );
     let situmApiKey = this.getAttribute("situm-api-key") ?? "";
     let buildingIdentifier = this.getAttribute("building-identifier") ?? "";
+    let language = this.getAttribute("language") ?? "";
+
     let situmApiKeyQP = situmApiKey.length > 0 ? `apikey=${situmApiKey}` : "";
     let buildingIdentifierQP =
       buildingIdentifier.length > 0 ? `&buildingid=${buildingIdentifier}` : "";
-    let query = `${situmApiKeyQP}${buildingIdentifierQP}&mode=embed`;
+    let languageQP = language.length > 0 ? `&lng=${language}` : "";
+
+    let query = `${situmApiKeyQP}${buildingIdentifierQP}${languageQP}&mode=embed`;
+
     let remoteIdentifier = this.getAttribute("remote-identifier");
     if (remoteIdentifier) {
       return `${viewerDomain}/id/${remoteIdentifier}?${query}`;