@situm/cordova 3.5.34 → 3.6.0

package/CHANGELOG_UNRELEASED.md

@@ -1,2 +1,3 @@
-### Fixed
-* Fixed tests on iOS
+### Added
+
+- Added ForegroundServiceNotificationOptions functions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@situm/cordova",
-  "version": "3.5.34",
+  "version": "3.6.0",
   "description": "Situm Wayfinding for Capacitor and Cordova. Integrate plug&play indoor navigation experience with floorplans, POIs, routes and turn-by-turn directions in no time. With the power of Situm.",
   "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.5.34">
+    version="3.6.0">
     <name>Situm Cordova plugin Official</name>
     <description>This is the stable branch.</description>
     <license>MIT</license>

package/src/android/app/src/main/java/es/situm/plugin/SitumMapper.java

@@ -1,5 +1,7 @@
 package es.situm.plugin;
 
+import static es.situm.plugin.JsonUtils.toMap;
+
 import android.content.Context;
 import android.graphics.Bitmap;
 import android.util.Base64;
@@ -23,6 +25,7 @@ import java.util.Map;
 import java.util.Arrays;
 
 import es.situm.sdk.directions.DirectionsRequest;
+import es.situm.sdk.location.ForegroundServiceNotificationOptions;
 import es.situm.sdk.location.LocationRequest;
 import es.situm.sdk.location.LocationStatus;
 import es.situm.sdk.location.OutdoorLocationOptions;
@@ -229,6 +232,8 @@ class SitumMapper {
   public static final String LOCATIONS = "locations";
   public static final String POLL_TIME = "pollTime";
 
+  public static final String FOREGROUND_SERVICE_NOTIFICATION_OPTIONS = "foregroundServiceNotificationOptions";
+
   public static final DateFormat dateFormat = DateUtils.dateFormat;
 
   private static final String TAG = "PluginHelper";
@@ -759,6 +764,12 @@ static JSONObject buildingInfoToJsonObject(BuildingInfo buildingInfo) throws JSO
     }
 
     JSONObject request = args.getJSONObject(0);
+    if (request.has(SitumMapper.FOREGROUND_SERVICE_NOTIFICATION_OPTIONS)) {
+      JSONObject notificationOptions = request.getJSONObject(SitumMapper.FOREGROUND_SERVICE_NOTIFICATION_OPTIONS);
+      ForegroundServiceNotificationOptions notificationConfig = ForegroundServiceNotificationOptions.fromMap(toMap(notificationOptions));
+      locationBuilder.foregroundServiceNotificationOptions(notificationConfig);
+    }
+
     if (request.has(SitumMapper.BUILDING_IDENTIFIER)) {
       String buildingIdentifier = String.valueOf(request.get(SitumMapper.BUILDING_IDENTIFIER));
       if (buildingIdentifier.isEmpty()) {

package/www/Interfaces.js

@@ -568,6 +568,7 @@ module.exports = SitumConversionArea;
  * @property {number} smallestDisplacement - Default smallest displacement to nofiy location updates
  * @property {string} realtimeUpdateInterval - Default interval to send locations to the Realtime. Possible values are REALTIME, FAST, NORMAL, SLOW and BATTERY_SAVER
  * @property {boolean} autoEnableBleDuringPositioning - Set if the BLE should be re-enabled during positioning if the ble is used. Android only
+ * @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}.
  */
 var LocationRequest = {
   buildingIdentifier,
@@ -584,11 +585,41 @@ var LocationRequest = {
   beaconFilters,
   smallestDisplacement,
   realtimeUpdateInterval,
-  autoEnableBleDuringPositioning
+  autoEnableBleDuringPositioning,
+  foregroundServiceNotificationOptions
 };
 
 module.exports = LocationRequest;
 
+/**
+ * @name ForegroundServiceNotificationOptions
+ *
+ * @description
+ * (Only applies for Android)
+ *
+ * A data object that let you customize the Foreground Service Notification
+ * that will be shown in the system's tray when the app is running as a
+ * Foreground Service. These options are defined within the {@link LocationRequest}.
+ *
+ * You can use the following tapAction behaviour:
+ * - 'LAUNCH_APP': Launch the app's main activity. This is the default value.
+ * - 'LAUNCH_SETTINGS': Launch the operating system settings screen for the app.
+ * - 'DO_NOTHING': Do nothing when tapping the notification.
+ * @property {string} title
+ * @property {string} message
+ * @property {boolean} showStopAction Whether to show or not the button that stops the positioning system. Defaults to true.
+ * @property {string} stopActionText
+ * @property {'DO_NOTHING' | 'LAUNCH_APP' | 'LAUNCH_SETTINGS'} tapAction Predefined actions performed when tapping the Situm Foreground Service Notification. Defaults to 'LAUNCH_APP'.
+ */
+var ForegroundServiceNotificationOptions = {
+  title,
+  message,
+  showStopAction,
+  stopActionText,
+  tapAction
+};
+module.exports = ForegroundServiceNotificationOptions;
+
 /**
  * @name
  * LocationOptions
@@ -650,14 +681,13 @@ var DirectionsRequest = {
 
 module.exports = DirectionsRequest;
 
-
 /**
  * @name
  * ExternalNavigation
  * @description
  * For internal use only.
  * @property {String} messageType
- * @property {Map} payload 
+ * @property {Map} payload
  */
 var ExternalNavigation = {
   messageType,