@vertigis/viewer-spec 46.4.0 → 47.0.0

package/messaging/registry/map.d.ts

@@ -56,6 +56,19 @@ export interface ZoomToViewpointArgs {
      */
     viewpoint: ViewpointLike | string;
 }
+/**
+ * The result of getting a Viewpoint.
+ */
+export interface GetViewpointResult {
+    /**
+     * The map(s) used in the operation.
+     */
+    maps?: MapsLike;
+    /**
+     * The viewpoint.
+     */
+    viewpoint: Viewpoint;
+}
 /**
  * Arguments for the map.zoom-to-layer-extent and
  * map.zoom-to-layer-visible-scale commands.
@@ -963,19 +976,21 @@ export declare class MapOperations extends OperationRegistry {
     /**
      * Returns the initial viewpoint for the active map or scene of the
      * specified map. If no map extension is specified, returns the initial
-     * viewpoint for the first available map.
+     * viewpoint for the first available map. Also returns the map(s) used for
+     * the operation.
      *
      * @webOnly
      */
-    get getInitialViewpoint(): Operation<Maps | void, Viewpoint>;
+    get getInitialViewpoint(): Operation<Maps | void, GetViewpointResult>;
     /**
      * Returns the current viewpoint for the active map or scene of the
      * specified map. If no map extension is specified, returns the viewpoint
-     * for the first available map.
+     * for the first available map. Also returns the map(s) used for the
+     * operation.
      *
      * @webOnly
      */
-    get getViewpoint(): Operation<Maps | void, Viewpoint>;
+    get getViewpoint(): Operation<Maps | void, GetViewpointResult>;
     /**
      * If a map extension ID is specified, returns the spatial reference for
      * that map. If no map extension ID is specified, returns the spatial

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")}}