@vertigis/viewer-spec 45.0.0 → 46.0.0

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

@@ -476,7 +476,7 @@
         },
         "AddNodeToGeometryArgs": {
             "additionalProperties": false,
-            "description": "Arguments for the \"sketching.add-node-to-geometry\" operation.",
+            "description": "Deprecated - Mobile users should rather use \"geometry.add-point\"; Web users should use \"sketching.add-point\" with {@link AddPointArgs} or \"sketching.insert-point\" with {@link InsertPointArgs} instead.",
             "properties": {
                 "geometry": {
                     "$ref": "#/definitions/esri.Geometry",
@@ -696,6 +696,10 @@
                     "$ref": "MapsLike",
                     "description": "The maps to activate drawing on. By default it will be all maps."
                 },
+                "maxSegments": {
+                    "description": "The maximum number of segments permitted for a polyline or polygon sketch. Default is no limit. Mobile only.",
+                    "type": "number"
+                },
                 "symbol": {
                     "anyOf": [
                         {
@@ -751,6 +755,25 @@
             ],
             "type": "object"
         },
+        "ClearConstraintsArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"sketching.clear-constraints\" command.",
+            "properties": {
+                "clearAngleConstraint": {
+                    "description": "Indicates whether the angle constraint should be cleared. Defaults to true if not specified.",
+                    "type": "boolean"
+                },
+                "clearLengthConstraint": {
+                    "description": "Indicates whether the length constraint should be cleared. Defaults to true if not specified.",
+                    "type": "boolean"
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                }
+            },
+            "type": "object"
+        },
         "ConfirmOperationArgs": {
             "additionalProperties": false,
             "description": "Arguments for the 'ui.confirm' operation.",
@@ -849,12 +872,24 @@
             "description": "Arguments for the \"sketching.delete\" command.",
             "properties": {
                 "geometry": {
-                    "$ref": "#/definitions/esri.Point",
-                    "description": "The point to delete from the active sketch. Not supported in Geocortex Mobile."
+                    "$ref": "#/definitions/esri.Geometry",
+                    "description": "The geometry to remove a point from. If this property is not specified, any active vertices will be deleted."
                 },
                 "maps": {
                     "$ref": "MapsLike",
                     "description": "Map(s) to use for the command/operation."
+                },
+                "partIndex": {
+                    "description": "The index of the part of the geometry that the point should be removed from. Required for polyline and polygon geometry types when the geometry and pointIndex properties are defined.",
+                    "type": "number"
+                },
+                "point": {
+                    "$ref": "#/definitions/esri.Point",
+                    "description": "The point to remove from the geometry. If this property is defined, the 'pointIndex' and 'partIndex' properties are ignored. If no point nor pointIndex/partIndex are specified, any active points will be deleted. If there are no active points, the entire geometry will be deleted."
+                },
+                "pointIndex": {
+                    "description": "The index of the point that should be removed from the geometry. If this property is defined, the geometry property must also be defined.",
+                    "type": "number"
                 }
             },
             "type": "object"
@@ -915,8 +950,8 @@
                     "type": "boolean"
                 },
                 "message": {
-                    "description": "The message to be displayed in the notification.",
-                    "type": "string"
+                    "$ref": "#/definitions/TranslatableText",
+                    "description": "The message to be displayed in the notification. Mobile only supports a string for this property."
                 },
                 "notificationGroup": {
                     "description": "Notifications in the same notification group are mutually exclusive, and will supersede one another. Mobile only.",
@@ -1052,6 +1087,10 @@
                     "description": "Whether to allow scaling of the edited geometry. Defaults to true.",
                     "type": "boolean"
                 },
+                "enableVertexEditing": {
+                    "description": "Whether to allow the user to add, move, and remove vertices from a geometry. Defaults to true.",
+                    "type": "boolean"
+                },
                 "scaleMode": {
                     "description": "Setting \"free\" allows independent scaling on the x and y axis, \"preserve-aspect-ratio\" constrains scaling to the original aspect ratio. Defaults to \"preserve-aspect-ratio\".",
                     "enum": [
@@ -1059,6 +1098,10 @@
                         "preserve-aspect-ratio"
                     ],
                     "type": "string"
+                },
+                "validateGeometry": {
+                    "description": "Whether the resulting geometry is validated before it's returned from the operation. If the geometry is invalid upon completion, an error is thrown. Defaults to true.",
+                    "type": "boolean"
                 }
             },
             "type": "object"
@@ -1683,6 +1726,36 @@
             ],
             "type": "object"
         },
+        "InsertPointArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"sketching.insert-point\" command.",
+            "properties": {
+                "geometry": {
+                    "$ref": "#/definitions/esri.Geometry",
+                    "description": "The geometry to add the point to, if multiple are present in an active editing session. Not supported by Mobile."
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                },
+                "newPoint": {
+                    "$ref": "#/definitions/esri.Point",
+                    "description": "The new point to be added."
+                },
+                "partIndex": {
+                    "description": "The index of the part to which the point will be added. If null, the last part will be used.",
+                    "type": "number"
+                },
+                "pointIndex": {
+                    "description": "The index at which the point will be added. If null, the point will be added as the last point.",
+                    "type": "number"
+                }
+            },
+            "required": [
+                "newPoint"
+            ],
+            "type": "object"
+        },
         "JobParameters": {
             "additionalProperties": false,
             "description": "A set of parameters used to run a job.",
@@ -2314,6 +2387,45 @@
             ],
             "type": "object"
         },
+        "SetConstraintsArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"sketching.set-constraints\" command.",
+            "properties": {
+                "angle": {
+                    "description": "The constraint for the angle of the line between the selected vertex and the new point, relative to the reference line. Remains unchanged until set to a different value, or cleared.",
+                    "type": "number"
+                },
+                "autoClear": {
+                    "description": "Indicates whether constraints will be automatically cleared after a vertex is added or updated. If not set (value is null), then the value will remain unchanged with this operation. If the value has never been set, the default is false. Remains unchanged until set to a different value.",
+                    "type": "boolean"
+                },
+                "geodetic": {
+                    "description": "Indicates whether the distance calculations will be geodetic or planar. Default is true.",
+                    "type": "boolean"
+                },
+                "geodeticCurveType": {
+                    "$ref": "#/definitions/GeodeticCurveType",
+                    "description": "The geodetic curve type used when calculating the new point. Only applies when geodetic is set to true. Defaults to geodesic."
+                },
+                "length": {
+                    "description": "The constraint for the length of the line between the selected vertex and the new point.",
+                    "type": "number"
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                },
+                "referenceLine": {
+                    "$ref": "#/definitions/ReferenceLine",
+                    "description": "A reference line that the angle will be relative to. Defaults to 'north'. Remains unchanged until set again."
+                },
+                "units": {
+                    "$ref": "#/definitions/LengthUnitsMobile",
+                    "description": "The units to be used for length. If not specified, the units of the map's spatial reference will be used."
+                }
+            },
+            "type": "object"
+        },
         "SetGeometryModeArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.set-geometry-mode\" command.",
@@ -2463,6 +2575,10 @@
                     "$ref": "MapsLike",
                     "description": "The map to sketch on."
                 },
+                "maxSegments": {
+                    "description": "The maximum number of segments permitted for a polyline or polygon sketch. Default is no limit. Mobile only.",
+                    "type": "number"
+                },
                 "resumeId": {
                     "description": "Gets a resume ID for the sketch. Cannot be set.",
                     "type": "string"
@@ -2483,6 +2599,21 @@
             ],
             "type": "object"
         },
+        "StartStreamingArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"sketching.start-streaming\" command.",
+            "properties": {
+                "interval": {
+                    "description": "An optional value indicating, in seconds, how often points should be recorded.",
+                    "type": "number"
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                }
+            },
+            "type": "object"
+        },
         "StopGeometryEditArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.stop\" operation.",
@@ -2605,6 +2736,61 @@
             },
             "type": "object"
         },
+        "TranslatableText": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/TranslateOptions"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "A translatable string, either a language string or a language string with arguments to pass into it."
+        },
+        "TranslateOptions": {
+            "additionalProperties": false,
+            "description": "The available options for the Locale Service translate function.",
+            "properties": {
+                "args": {
+                    "description": "The values to substitute into the format string if it contains substitution placeholders (see utilities/string/format in Geocortex API).",
+                    "items": {
+                    },
+                    "type": "array"
+                },
+                "currency": {
+                    "description": "The default unit of currency to use when formatting currency. See {@link NumberSettings.currency}.",
+                    "type": "string"
+                },
+                "dateFormat": {
+                    "description": "The default format to use when formatting dates. See {@link DateFormatter.format}.",
+                    "type": "string"
+                },
+                "fractionalDigits": {
+                    "description": "The default number of digits to show after the decimal point when formatting numbers. See {@link NumberSettings.fractionalDigits}.",
+                    "type": "number"
+                },
+                "locale": {
+                    "description": "The locale to use for translation. If not specified, the current locale will be used.",
+                    "type": "string"
+                },
+                "numberFormat": {
+                    "description": "The default format to use when formatting numbers. See {@link NumberFormatter.format}.",
+                    "type": "string"
+                },
+                "text": {
+                    "description": "The string to translate. If the text is a language resource key, then a localized version of that resource will be used if one exists, otherwise the original text is returned.",
+                    "type": "string"
+                },
+                "timeZone": {
+                    "description": "The time zone of a date being formatted.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "text"
+            ],
+            "type": "object"
+        },
         "UpdateResultsFeaturesArgs": {
             "additionalProperties": false,
             "description": "Arguments for various commands that affect a result component's features.",
@@ -12943,7 +13129,7 @@
             "type": "string"
         },
         "sketching.add-node-to-geometry": {
-            "description": "Adds a point to a given polyline or polygon geometry. Returns the resulting geometry. Deprecated in Mobile, use geometry.add-point instead.",
+            "description": "Deprecated - Mobile users should rather use \"geometry.add-point\"; Web users should use \"sketching.add-point\" or \"sketching.insert-point\" instead.",
             "enum": [
                 "sketching.add-node-to-geometry"
             ]
@@ -12954,6 +13140,12 @@
         "sketching.add-node-to-geometry:output": {
             "$ref": "#/definitions/esri.Geometry"
         },
+        "sketching.add-point": {
+            "description": "Adds a point to polygon, polyline, or multipoint using the selected index as the point to insert after.",
+            "enum": [
+                "sketching.add-point"
+            ]
+        },
         "sketching.add-point-at-center": {
             "description": "Adds a point at the center of the map while editing a geometry. Works in centerCrosshair mode only.",
             "enum": [
@@ -12972,6 +13164,9 @@
         "sketching.add-point-at-current-location:input": {
             "$ref": "#/definitions/HasMaps"
         },
+        "sketching.add-point:input": {
+            "$ref": "#/definitions/AddPointArgs"
+        },
         "sketching.capture-geometry": {
             "description": "Allows the user to create geometry by sketching on a map. Returns the geometry that was drawn, along with the map that it was drawn on.",
             "enum": [
@@ -12984,14 +13179,30 @@
         "sketching.capture-geometry:output": {
             "$ref": "#/definitions/CaptureGeometryResult"
         },
+        "sketching.clear-constraints": {
+            "description": "Clears constraints that have been previously set.",
+            "enum": [
+                "sketching.clear-constraints"
+            ]
+        },
+        "sketching.clear-constraints:input": {
+            "$ref": "#/definitions/ClearConstraintsArgs"
+        },
         "sketching.delete": {
-            "description": "If a point is supplied while a sketching or editing operation is active, the vertex at that point will be deleted from the current geometry. If no point is supplied and a geometry editing session is active, the entire geometry will be deleted.",
+            "description": "If a point is supplied while a sketching or editing operation is active, the vertex at that point will be deleted from the current geometry. If no point is supplied, any active points in the session will be deleted. If there are no active points in the session, the entire geometry will be deleted.",
             "enum": [
                 "sketching.delete"
             ]
         },
         "sketching.delete:input": {
-            "$ref": "#/definitions/DeleteGeometryArgs"
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/DeleteGeometryArgs"
+                },
+                {
+                    "type": "null"
+                }
+            ]
         },
         "sketching.edit-geometry": {
             "description": "Allows the user to edit an existing geometry by drawing on a map. Returns the geometry that was edited, or the supplied feature with the altered geometry applied, along with the map that it was drawn on.",
@@ -13005,6 +13216,27 @@
         "sketching.edit-geometry:output": {
             "$ref": "#/definitions/EditGeometryResult"
         },
+        "sketching.insert-point": {
+            "description": "Inserts a point into a polygon, polyline, or multipoint at the specified index. If the partIndex is null, then the last part is used. If the pointIndex is null, then the new point is inserted at the end.",
+            "enum": [
+                "sketching.insert-point"
+            ]
+        },
+        "sketching.insert-point:input": {
+            "$ref": "#/definitions/InsertPointArgs"
+        },
+        "sketching.is-streaming": {
+            "description": "Checks whether streaming is active.",
+            "enum": [
+                "sketching.is-streaming"
+            ]
+        },
+        "sketching.is-streaming:input": {
+            "$ref": "#/definitions/HasMaps"
+        },
+        "sketching.is-streaming:output": {
+            "type": "boolean"
+        },
         "sketching.redo": {
             "description": "Redoes the last undone edit while editing a geometry.",
             "enum": [
@@ -13014,6 +13246,15 @@
         "sketching.redo:input": {
             "$ref": "#/definitions/HasMaps"
         },
+        "sketching.set-constraints": {
+            "description": "Sets constraints on the active sketch.",
+            "enum": [
+                "sketching.set-constraints"
+            ]
+        },
+        "sketching.set-constraints:input": {
+            "$ref": "#/definitions/SetConstraintsArgs"
+        },
         "sketching.set-geometry-mode": {
             "description": "Sets the geometry mode of the geometry editor.",
             "enum": [
@@ -13041,12 +13282,30 @@
         "sketching.set-point-at-current-location:input": {
             "$ref": "#/definitions/HasMaps"
         },
+        "sketching.start-streaming": {
+            "description": "Starts streaming: recording your location at regular intervals and adding the collected points to the currently active geometry editor.",
+            "enum": [
+                "sketching.start-streaming"
+            ]
+        },
+        "sketching.start-streaming:input": {
+            "$ref": "#/definitions/StartStreamingArgs"
+        },
         "sketching.stop": {
-            "description": "Stops geometry capturing or editing on a given map. Returns the current geometry. If validateGeometry parameter is true and geometry is invalid, returns null.",
+            "description": "Stops geometry capturing or editing on a given map. Returns the current geometry. If validateGeometry parameter is true and geometry is invalid, the operation will return null.",
             "enum": [
                 "sketching.stop"
             ]
         },
+        "sketching.stop-streaming": {
+            "description": "Stops streaming.",
+            "enum": [
+                "sketching.stop-streaming"
+            ]
+        },
+        "sketching.stop-streaming:input": {
+            "$ref": "#/definitions/HasMaps"
+        },
         "sketching.stop:input": {
             "anyOf": [
                 {
@@ -14497,6 +14756,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.add-point:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.add-point"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -14529,6 +14804,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.clear-constraints:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.clear-constraints"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -14545,6 +14836,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.insert-point:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.insert-point"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -14561,6 +14868,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.set-constraints:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.set-constraints"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -14609,6 +14932,38 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.start-streaming:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.start-streaming"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.stop-streaming:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.stop-streaming"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -15106,18 +15461,30 @@
                 {
                     "$ref": "#/definitions/search.set-source"
                 },
+                {
+                    "$ref": "#/definitions/sketching.add-point"
+                },
                 {
                     "$ref": "#/definitions/sketching.add-point-at-center"
                 },
                 {
                     "$ref": "#/definitions/sketching.add-point-at-current-location"
                 },
+                {
+                    "$ref": "#/definitions/sketching.clear-constraints"
+                },
                 {
                     "$ref": "#/definitions/sketching.delete"
                 },
+                {
+                    "$ref": "#/definitions/sketching.insert-point"
+                },
                 {
                     "$ref": "#/definitions/sketching.redo"
                 },
+                {
+                    "$ref": "#/definitions/sketching.set-constraints"
+                },
                 {
                     "$ref": "#/definitions/sketching.set-geometry-mode"
                 },
@@ -15127,6 +15494,12 @@
                 {
                     "$ref": "#/definitions/sketching.set-point-at-current-location"
                 },
+                {
+                    "$ref": "#/definitions/sketching.start-streaming"
+                },
+                {
+                    "$ref": "#/definitions/sketching.stop-streaming"
+                },
                 {
                     "$ref": "#/definitions/sketching.undo"
                 },
@@ -15745,6 +16118,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.is-streaming:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.is-streaming"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -15929,6 +16318,9 @@
                 {
                     "$ref": "#/definitions/sketching.edit-geometry"
                 },
+                {
+                    "$ref": "#/definitions/sketching.is-streaming"
+                },
                 {
                     "$ref": "#/definitions/sketching.stop"
                 },