@vertigis/viewer-spec 49.9.0 → 50.0.0

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

@@ -60,6 +60,9 @@
                 },
                 "geometry": {
                     "anyOf": [
+                        {
+                            "$ref": "#/definitions/esri.Geometry"
+                        },
                         {
                             "$ref": "#/definitions/esri.rest-api.Point.Point"
                         },
@@ -74,9 +77,6 @@
                         },
                         {
                             "$ref": "#/definitions/esri.rest-api.Extent.Extent"
-                        },
-                        {
-                            "$ref": "#/definitions/esri.Geometry"
                         }
                     ],
                     "description": "The feature's geometry."
@@ -806,7 +806,7 @@
                 },
                 "symbol": {
                     "$ref": "#/definitions/esri.Symbol",
-                    "description": "The symbol that was used. Unavailable in Geocortex Web Viewer."
+                    "description": "The symbol that was used. Unavailable in VertiGIS Studio Web."
                 }
             },
             "required": [
@@ -1741,6 +1741,9 @@
                     },
                     "type": "array"
                 },
+                {
+                    "$ref": "#/definitions/esri.Geometry"
+                },
                 {
                     "$ref": "#/definitions/esri.rest-api.Feature.Feature"
                 },
@@ -1775,12 +1778,12 @@
                 {
                     "$ref": "#/definitions/esri.rest-api.Extent.Extent"
                 },
-                {
-                    "$ref": "#/definitions/esri.Geometry"
-                },
                 {
                     "items": {
                         "anyOf": [
+                            {
+                                "$ref": "#/definitions/esri.Geometry"
+                            },
                             {
                                 "$ref": "#/definitions/esri.rest-api.Point.Point"
                             },
@@ -1795,9 +1798,6 @@
                             },
                             {
                                 "$ref": "#/definitions/esri.rest-api.Extent.Extent"
-                            },
-                            {
-                                "$ref": "#/definitions/esri.Geometry"
                             }
                         ]
                     },
@@ -1808,37 +1808,37 @@
         },
         "GeometryModeArgs": {
             "additionalProperties": false,
-            "description": "Arguments for the measurement events. Only available in the Geocortex Mobile Viewer.",
+            "description": "Arguments for the measurement events. Only available in VertiGIS Studio Mobile.",
             "properties": {
                 "geometryMode": {
                     "$ref": "GeometryMode",
                     "description": "The geometry mode that is used to perform operations."
                 },
                 "maps": {
-                    "$ref": "MapsLike"
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
                 }
             },
             "required": [
-                "geometryMode",
-                "maps"
+                "geometryMode"
             ],
             "type": "object"
         },
         "GeometryToolbarArgs": {
             "additionalProperties": false,
-            "description": "Arguments for the Geometry Toolbar show command. Only available in the Geocortex Mobile Viewer.",
+            "description": "Arguments for the Geometry Toolbar show command. Only available in VertiGIS Studio Mobile.",
             "properties": {
                 "isAreaToggleable": {
                     "description": "Whether the toolbar will allow users to toggle between area and line drawing modes. Defaults to true.",
                     "type": "boolean"
                 },
                 "maps": {
-                    "$ref": "MapsLike"
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
                 }
             },
             "required": [
-                "isAreaToggleable",
-                "maps"
+                "isAreaToggleable"
             ],
             "type": "object"
         },
@@ -1875,6 +1875,10 @@
             "additionalProperties": false,
             "description": "A geolocation source.",
             "properties": {
+                "deviceFullName": {
+                    "description": "Full name of the GNSS device.",
+                    "type": "string"
+                },
                 "deviceName": {
                     "description": "Name of the GNSS device.",
                     "type": "string"
@@ -1889,6 +1893,7 @@
                 }
             },
             "required": [
+                "deviceFullName",
                 "deviceName",
                 "deviceType",
                 "settings"
@@ -1945,6 +1950,21 @@
             },
             "type": "object"
         },
+        "HasMapsAndFeatures": {
+            "additionalProperties": false,
+            "description": "Defines an object that has a `maps` property and a `features` property.",
+            "properties": {
+                "features": {
+                    "$ref": "#/definitions/FeaturesLike",
+                    "description": "Features to use for the command/operation."
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                }
+            },
+            "type": "object"
+        },
         "HasUITarget": {
             "additionalProperties": false,
             "description": "An object with arguments for a command or operation that can display temporary UI.",
@@ -2010,7 +2030,7 @@
                     "description": "The geometry to identify by."
                 },
                 "layersInScaleRangeOnly": {
-                    "description": "When \"map\" is specified, this determines whether to include only layers that are in visible scale range. The default is false. Not supported in Geocortex Mobile Viewer.",
+                    "description": "When \"map\" is specified, this determines whether to include only layers that are in visible scale range. The default is false. Not supported in VertiGIS Studio Mobile.",
                     "type": "boolean"
                 },
                 "maps": {
@@ -2018,38 +2038,38 @@
                     "description": "The map to identify. Can be used instead of or in addition to \"sources\". Layers on the map will be used as sources according to the \"layersInScaleRangeOnly\" and \"visibleLayersOnly\" flags."
                 },
                 "maxAllowableOffset": {
-                    "description": "The maximum allowable offset used for generalizing returned geometries. Not supported in Geocortex Mobile Viewer.",
+                    "description": "The maximum allowable offset used for generalizing returned geometries. Not supported in VertiGIS Studio Mobile.",
                     "type": "number"
                 },
                 "maxResults": {
-                    "description": "The maximum number of results to return per source. Not supported in Geocortex Mobile Viewer.",
+                    "description": "The maximum number of results to return per source. Not supported in VertiGIS Studio Mobile.",
                     "type": "number"
                 },
                 "outSpatialReference": {
                     "$ref": "#/definitions/esri.SpatialReference",
-                    "description": "The spatial reference for the returned geometry. Not supported in Geocortex Mobile Viewer."
+                    "description": "The spatial reference for the returned geometry. Not supported in VertiGIS Studio Mobile."
                 },
                 "pointTolerance": {
-                    "description": "A tolerance value to use for point identify operations. All features falling within a buffer of this many logical pixels around the point will be returned by the identify operation. The default is 10. Not supported in Geocortex Mobile Viewer.",
+                    "description": "A tolerance value to use for point identify operations. All features falling within a buffer of this many logical pixels around the point will be returned by the identify operation. The default is 10. Not supported in VertiGIS Studio Mobile.",
                     "type": "number"
                 },
                 "polyTolerance": {
-                    "description": "A tolerance value to use for polyline and polygon identify operations. All features falling within a buffer of this many logical pixels around the geometry will be returned by the identify operation. The default is 2. Not supported in Geocortex Mobile Viewer.",
+                    "description": "A tolerance value to use for polyline and polygon identify operations. All features falling within a buffer of this many logical pixels around the geometry will be returned by the identify operation. The default is 2. Not supported in VertiGIS Studio Mobile.",
                     "type": "number"
                 },
                 "returnGeometry": {
-                    "description": "Whether geometry for features should be returned. Not supported in Geocortex Mobile Viewer.",
+                    "description": "Whether geometry for features should be returned. Not supported in VertiGIS Studio Mobile.",
                     "type": "boolean"
                 },
                 "sources": {
-                    "description": "The feature sources to identify. Can be used instead of or in addition to \"maps\". Not supported in Geocortex Mobile Viewer (use \"maps\").",
+                    "description": "The feature sources to identify. Can be used instead of or in addition to \"maps\". Not supported in VertiGIS Studio Mobile (use \"maps\").",
                     "items": {
                         "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
                     },
                     "type": "array"
                 },
                 "visibleLayersOnly": {
-                    "description": "When \"map\" is specified, this determines whether to include only visible layers. The default is true. Not supported in Geocortex Mobile Viewer.",
+                    "description": "When \"map\" is specified, this determines whether to include only visible layers. The default is true. Not supported in VertiGIS Studio Mobile.",
                     "type": "boolean"
                 }
             },
@@ -2184,19 +2204,6 @@
             ],
             "type": "string"
         },
-        "MapExtensionArgs": {
-            "additionalProperties": false,
-            "description": "One or more map extensions.",
-            "properties": {
-                "maps": {
-                    "$ref": "MapsLike"
-                }
-            },
-            "required": [
-                "maps"
-            ],
-            "type": "object"
-        },
         "MapsLike": {
             "anyOf": [
                 {
@@ -2724,7 +2731,7 @@
         },
         "SaveStorageDataArgs": {
             "additionalProperties": false,
-            "description": "Arguments for the app.set-persistent-data operations. Only available in the Geocortex Mobile Viewer.",
+            "description": "Arguments for the app.set-persistent-data operations. Only available in VertiGIS Studio Mobile.",
             "properties": {
                 "data": {
                     "description": "The data to be stored."
@@ -2749,9 +2756,13 @@
             "description": "Arguments for search operations.",
             "properties": {
                 "disableSearchAreaExpansion": {
-                    "description": "By default the search area will be expanded to try and return the specified maxResults. Set to true to disable this behavior. Not supported in Geocortex Mobile Viewer.",
+                    "description": "By default the search area will be expanded to try and return the specified maxResults. Set to true to disable this behavior. Not supported in VertiGIS Studio Mobile.",
                     "type": "boolean"
                 },
+                "mapViewpoint": {
+                    "$ref": "#/definitions/esri.Viewpoint",
+                    "description": "The map Viewpoint at the time of the search. Mobile only."
+                },
                 "maps": {
                     "$ref": "MapsLike",
                     "description": "The map(s) to search. Can be used instead of or in addition to \"sources\"."
@@ -2766,11 +2777,11 @@
                 },
                 "near": {
                     "$ref": "#/definitions/esri.Point",
-                    "description": "If specified, this will influence the score of spatial features based on their proximity to this point. Most commonly this would be the user's current location, but can be any point of interest. This option requires searchArea to also be specified. Not supported in Geocortex Mobile Viewer."
+                    "description": "If specified, this will influence the score of spatial features based on their proximity to this point. Most commonly this would be the user's current location, but can be any point of interest. This option requires searchArea to also be specified. Not supported in VertiGIS Studio Mobile."
                 },
                 "outSpatialReference": {
                     "$ref": "#/definitions/esri.SpatialReference",
-                    "description": "The spatial reference for the returned geometry. Not supported in Geocortex Mobile Viewer."
+                    "description": "The spatial reference for the returned geometry. Not supported in VertiGIS Studio Mobile."
                 },
                 "searchArea": {
                     "$ref": "#/definitions/esri.Geometry",
@@ -2785,7 +2796,7 @@
                     "type": "string"
                 },
                 "sources": {
-                    "description": "The feature sources to search. Can be used instead of or in addition to \"maps\". Not supported in Geocortex Mobile Viewer (use \"maps\").",
+                    "description": "The feature sources to search. Can be used instead of or in addition to \"maps\". Not supported in VertiGIS Studio Mobile (use \"maps\").",
                     "items": {
                         "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
                     },
@@ -2793,6 +2804,7 @@
                 }
             },
             "required": [
+                "mapViewpoint",
                 "searchText"
             ],
             "type": "object"
@@ -2836,7 +2848,7 @@
         },
         "SetBasemapWithTargetMapArg": {
             "additionalProperties": false,
-            "description": "Argument used in case when we have more than 1 map in the app, and we need to pass the target map from outside (eg basemap picker in web viewer).",
+            "description": "Argument used in case when we have more than 1 map in the app, and we need to pass the target map from outside (eg basemap picker in VertiGIS Studio Web).",
             "properties": {
                 "basemap": {
                     "$ref": "#/definitions/SetBasemapArg",
@@ -3088,7 +3100,7 @@
         },
         "StorageDataArgs": {
             "additionalProperties": false,
-            "description": "Arguments for the reading app.*-persistent-data operations. Only available in the Geocortex Mobile Viewer.",
+            "description": "Arguments for the reading app.*-persistent-data operations. Only available in VertiGIS Studio Mobile.",
             "properties": {
                 "key": {
                     "description": "The key of the data to store.",
@@ -3419,7 +3431,7 @@
             "$ref": "#/definitions/StorageDataArgs"
         },
         "app.go-to-app-selector": {
-            "description": "Returns to the Geocortex Go view where the user can select a different app. Only enabled if the current app was launched through Geocortex Go.",
+            "description": "Returns to the app selector view where the user can select a different app. Only enabled if the current app was launched through VertiGIS Studio Go.",
             "enum": [
                 "app.go-to-app-selector"
             ]
@@ -3476,7 +3488,7 @@
             "$ref": "esriRuntimeSdk.Credential"
         },
         "auth.sign-in": {
-            "description": "Initiates user sign-in if they aren't already signed in. The argument indicates whether or not the map should be reloaded when the sign-in is complete. This argument is optional and only supported by Geocortex Mobile Viewer.",
+            "description": "Initiates user sign-in if they aren't already signed in. The argument indicates whether or not the map should be reloaded when the sign-in is complete. This argument is optional and only supported by VertiGIS Studio Mobile.",
             "enum": [
                 "auth.sign-in"
             ]
@@ -3488,7 +3500,7 @@
             ]
         },
         "auth.sign-out": {
-            "description": "Signs the user out. The argument indicates whether or not the map should be reloaded when the sign-out is complete. This argument is optional and only supported by Geocortex Mobile Viewer.",
+            "description": "Signs the user out. The argument indicates whether or not the map should be reloaded when the sign-out is complete. This argument is optional and only supported by VertiGIS Studio Mobile.",
             "enum": [
                 "auth.sign-out"
             ]
@@ -3586,6 +3598,9 @@
                     },
                     "type": "array"
                 },
+                {
+                    "$ref": "#/definitions/esri.Geometry"
+                },
                 {
                     "$ref": "#/definitions/esri.rest-api.Feature.Feature"
                 },
@@ -3620,12 +3635,12 @@
                 {
                     "$ref": "#/definitions/esri.rest-api.Extent.Extent"
                 },
-                {
-                    "$ref": "#/definitions/esri.Geometry"
-                },
                 {
                     "items": {
                         "anyOf": [
+                            {
+                                "$ref": "#/definitions/esri.Geometry"
+                            },
                             {
                                 "$ref": "#/definitions/esri.rest-api.Point.Point"
                             },
@@ -3640,9 +3655,6 @@
                             },
                             {
                                 "$ref": "#/definitions/esri.rest-api.Extent.Extent"
-                            },
-                            {
-                                "$ref": "#/definitions/esri.Geometry"
                             }
                         ]
                     },
@@ -3796,10 +3808,10 @@
         "edit.display-add-feature:input": {
             "anyOf": [
                 {
-                    "$ref": "#/definitions/DisplayAddFeatureArgs"
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
                 },
                 {
-                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
+                    "$ref": "#/definitions/DisplayAddFeatureArgs"
                 }
             ]
         },
@@ -12749,7 +12761,7 @@
             "$ref": "#/definitions/SuggestArgs"
         },
         "geolocation.auto-recenter": {
-            "description": "Centers the map on the user's current location and keeps the location centered as it moves around. The maps parameter is only supported in Geocortex Mobile Viewer. In Geocortex Web Viewer, all maps are affected.",
+            "description": "Centers the map on the user's current location and keeps the location centered as it moves around. The maps parameter is only supported in VertiGIS Studio Mobile. In VertiGIS Studio Web, all maps are affected.",
             "enum": [
                 "geolocation.auto-recenter"
             ]
@@ -12761,7 +12773,7 @@
             ]
         },
         "geolocation.auto-recenter-and-reorient:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "geolocation.auto-recenter:input": {
             "anyOf": [
@@ -12884,7 +12896,7 @@
         "geometry-toolbar.hide:input": {
             "anyOf": [
                 {
-                    "$ref": "MapExtensionArgs"
+                    "$ref": "#/definitions/HasMaps"
                 },
                 {
                     "type": "null"
@@ -13036,10 +13048,10 @@
             ]
         },
         "highlights.hide-focus:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "highlights.hide:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "highlights.pulse": {
             "description": "Adds a temporary focused-state highlight to one or more features.",
@@ -13057,7 +13069,7 @@
             ]
         },
         "highlights.refresh:input": {
-            "$ref": "MapExtensionFeatureArgs"
+            "$ref": "#/definitions/HasMapsAndFeatures"
         },
         "highlights.remove": {
             "description": "Removes highlighting from one or many features.",
@@ -13090,10 +13102,10 @@
             ]
         },
         "highlights.show-focus:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "highlights.show:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "iwtm.open": {
             "description": "Displays the I Want To Menu with the given ID.",
@@ -13195,7 +13207,7 @@
             ]
         },
         "map.disable-map-click:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "map.display-extent-selector": {
             "description": "Displays a square overlay on the map that allows the user to change the map extent within the overlay.",
@@ -13213,7 +13225,7 @@
             ]
         },
         "map.enable-map-click:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "map.export-image": {
             "description": "Exports the currently rendered map to a png image file on disk, and also returns that image.",
@@ -13265,7 +13277,7 @@
             ]
         },
         "map.get-geometry-from-selector:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "map.get-geometry-from-selector:output": {
             "$ref": "#/definitions/esri.Extent"
@@ -13305,7 +13317,7 @@
             ]
         },
         "map.get-view-insets:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "map.get-view-insets:output": {
             "$ref": "#/definitions/GetViewInsetsArgs"
@@ -13317,7 +13329,7 @@
             ]
         },
         "map.get-visible-center:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "map.get-visible-center:output": {
             "$ref": "#/definitions/esri.Point"
@@ -13335,7 +13347,7 @@
             ]
         },
         "map.hide-extent-selector:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "map.hide:input": {
             "$ref": "#/definitions/HideMapArgs"
@@ -13359,7 +13371,7 @@
             ]
         },
         "map.pause-sketch:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "map.refresh": {
             "description": "Refreshes / reloads the map.",
@@ -13368,7 +13380,7 @@
             ]
         },
         "map.refresh:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "map.replace": {
             "description": "Replaces the entire current map in the MapExtension and in the map component with a different map.",
@@ -13404,7 +13416,7 @@
             ]
         },
         "map.resume-sketch:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "map.rotate-by": {
             "description": "Rotates the map by the specified amount.",
@@ -13431,7 +13443,7 @@
             ]
         },
         "map.show:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "map.show:output": {
             "type": "boolean"
@@ -13455,7 +13467,7 @@
             ]
         },
         "map.stop-sketch:input": {
-            "$ref": "MapExtensionArgs"
+            "$ref": "#/definitions/HasMaps"
         },
         "map.stop-sketch:output": {
             "$ref": "#/definitions/esri.Geometry"
@@ -14416,7 +14428,7 @@
             "$ref": "#/definitions/Features"
         },
         "ui.activate": {
-            "description": "Activates a component with the given ID or model, causing it to become visible. For Geocortex Mobile Viewer, only ID is supported.",
+            "description": "Activates a component with the given ID or model, causing it to become visible. For VertiGIS Studio Mobile, only ID is supported.",
             "enum": [
                 "ui.activate"
             ]
@@ -14471,7 +14483,7 @@
             "type": "boolean"
         },
         "ui.deactivate": {
-            "description": "Deactivates a component with the given ID, causing it to disappear. For Geocortex Mobile Viewer, only ID is supported.",
+            "description": "Deactivates a component with the given ID, causing it to disappear. For VertiGIS Studio Mobile, only ID is supported.",
             "enum": [
                 "ui.deactivate"
             ]