@vertigis/viewer-spec 46.4.2 → 47.0.0

package/messaging/registry/system.d.ts

@@ -1,5 +1,7 @@
 import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
 import type { Blob, File, HasFeatures, HasGeometry, HasLayers, HasMaps, HasUITarget } from "../common.js";
@@ -82,6 +84,34 @@ export interface OpenUrlArgs {
      */
     numberFormatterLocale?: string;
 }
+/**
+ * Arguments for the system.disable-background-location-updates command.
+ */
+export interface BackgroundLocationUpdatesArgs {
+    /**
+     * The task ID for enabling and disabling background location updates. Once
+     * enabled using a certain task ID, background location updates can only be
+     * stopped once they are disabled with that same task ID.
+     *
+     * Cannot be set to null, but if this argument is not provided, a preset
+     * default value will be used.
+     */
+    taskId?: string;
+}
+/**
+ * Arguments for the system.enable-background-location-updates command.
+ */
+export interface EnableBackgroundLocationUpdateArgs extends BackgroundLocationUpdatesArgs {
+    /**
+     * The title used in the sticky notification on Android. If null or an empty
+     * string, a default title will be used.
+     */
+    androidNotificationTitle?: string;
+    /**
+     * The message used in the sticky notification on Android.
+     */
+    androidNotificationMessage?: string;
+}
 export declare class SystemCommands extends CommandRegistry {
     /**
      * Displays a sharing link to the user.
@@ -121,6 +151,22 @@ export declare class SystemCommands extends CommandRegistry {
      * @mobileOnly
      */
     get keepScreenOn(): Command<boolean>;
+    /**
+     * Enables background location updates. While enabled, the application will
+     * continue to execute code while running in the background.
+     *
+     * Note for iOS: If the user has not accepted location permissions for the
+     * app, no code will be allowed to execute in the background.
+     *
+     * @mobileOnly
+     */
+    get enableBackgroundLocationUpdates(): Command<EnableBackgroundLocationUpdateArgs>;
+    /**
+     * Disables background location updates.
+     *
+     * @mobileOnly
+     */
+    get disableBackgroundLocationUpdates(): Command<BackgroundLocationUpdatesArgs>;
 }
 export declare class SystemOperations extends OperationRegistry {
     /**
@@ -143,3 +189,17 @@ export declare class SystemOperations extends OperationRegistry {
      */
     get getSharingLink(): Operation<void, string>;
 }
+export declare class SystemEvents extends EventRegistry {
+    /**
+     * Raised when background location updates are enabled.
+     *
+     * @mobileOnly
+     */
+    get backgroundLocationUpdatesEnabled(): Event;
+    /**
+     * Raised when background location updates are disabled.
+     *
+     * @mobileOnly
+     */
+    get backgroundLocationUpdatesDisabled(): Event;
+}

package/messaging/registry/system.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class SystemCommands extends CommandRegistry{get displaySharingLink(){return this._messages.command("system.display-sharing-link")}get downloadFile(){return this._messages.command("system.download-file")}get openUrl(){return this._messages.command("system.open-url")}get keepScreenOn(){return this._messages.command("system.keep-screen-on")}}export class SystemOperations extends OperationRegistry{get readUrl(){return this._messages.operation("system.read-url")}get readFile(){return this._messages.operation("system.read-file")}get getSharingLink(){return this._messages.operation("system.get-sharing-link")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class SystemCommands extends CommandRegistry{get displaySharingLink(){return this._messages.command("system.display-sharing-link")}get downloadFile(){return this._messages.command("system.download-file")}get openUrl(){return this._messages.command("system.open-url")}get keepScreenOn(){return this._messages.command("system.keep-screen-on")}get enableBackgroundLocationUpdates(){return this._messages.command("system.enable-background-location-updates")}get disableBackgroundLocationUpdates(){return this._messages.command("system.disable-background-location-updates")}}export class SystemOperations extends OperationRegistry{get readUrl(){return this._messages.operation("system.read-url")}get readFile(){return this._messages.operation("system.read-file")}get getSharingLink(){return this._messages.operation("system.get-sharing-link")}}export class SystemEvents extends EventRegistry{get backgroundLocationUpdatesEnabled(){return this._messages.event("system.background-location-updates-enabled")}get backgroundLocationUpdatesDisabled(){return this._messages.event("system.background-location-updates-disabled")}}

package/messaging/schema/mobile-action.schema.json

@@ -633,6 +633,17 @@
             ],
             "type": "object"
         },
+        "BackgroundLocationUpdatesArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the system.disable-background-location-updates command.",
+            "properties": {
+                "taskId": {
+                    "description": "The task ID for enabling and disabling background location updates. Once enabled using a certain task ID, background location updates can only be stopped once they are disabled with that same task ID. Cannot be set to null, but if this argument is not provided, a preset default value will be used.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "CalculatePointArgs": {
             "additionalProperties": false,
             "description": "Arguments for the geometry.calculate-point operation.",
@@ -1322,6 +1333,25 @@
             ],
             "type": "string"
         },
+        "EnableBackgroundLocationUpdateArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the system.enable-background-location-updates command.",
+            "properties": {
+                "androidNotificationMessage": {
+                    "description": "The message used in the sticky notification on Android.",
+                    "type": "string"
+                },
+                "androidNotificationTitle": {
+                    "description": "The title used in the sticky notification on Android. If null or an empty string, a default title will be used.",
+                    "type": "string"
+                },
+                "taskId": {
+                    "description": "The task ID for enabling and disabling background location updates. Once enabled using a certain task ID, background location updates can only be stopped once they are disabled with that same task ID. Cannot be set to null, but if this argument is not provided, a preset default value will be used.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "ExportMapImageArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"map.export-image\" operation.",
@@ -13185,6 +13215,24 @@
         "sketching.undo:input": {
             "$ref": "#/definitions/HasMaps"
         },
+        "system.disable-background-location-updates": {
+            "description": "Disables background location updates.",
+            "enum": [
+                "system.disable-background-location-updates"
+            ]
+        },
+        "system.disable-background-location-updates:input": {
+            "$ref": "#/definitions/BackgroundLocationUpdatesArgs"
+        },
+        "system.enable-background-location-updates": {
+            "description": "Enables background location updates. While enabled, the application will continue to execute code while running in the background. Note for iOS: If the user has not accepted location permissions for the app, no code will be allowed to execute in the background.",
+            "enum": [
+                "system.enable-background-location-updates"
+            ]
+        },
+        "system.enable-background-location-updates:input": {
+            "$ref": "#/definitions/EnableBackgroundLocationUpdateArgs"
+        },
         "system.keep-screen-on": {
             "description": "Allows to control if the screen should be kept on. Passing true as parameter will keep the screen on, ignoring possible system settings for screen timeouts. Passing false as parameter will make the app respect system settings again.",
             "enum": [
@@ -14744,6 +14792,38 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/system.disable-background-location-updates:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/system.disable-background-location-updates"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/system.enable-background-location-updates:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/system.enable-background-location-updates"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -15243,6 +15323,12 @@
                 {
                     "$ref": "#/definitions/sketching.undo"
                 },
+                {
+                    "$ref": "#/definitions/system.disable-background-location-updates"
+                },
+                {
+                    "$ref": "#/definitions/system.enable-background-location-updates"
+                },
                 {
                     "$ref": "#/definitions/system.keep-screen-on"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "46.4.2",
+  "version": "47.0.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the Geocortex Viewer Specification.
  */
-export declare const version = "46.4.2";
+export declare const version = "47.0.0";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the Geocortex Viewer Specification.
  */
-export const version = "46.4.2";
+export const version = "47.0.0";