@vertigis/viewer-spec 59.30.0 → 60.0.0

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

@@ -803,7 +803,7 @@
         },
         "AddAttachmentArgs": {
             "additionalProperties": false,
-            "description": "Arguments for the \"edit.add-attachment\" command. Supported by both Web and Mobile.",
+            "description": "Arguments for the \"edit.add-attachment\" command. \"Features\" is the feature(s) the attachment is being added to.",
             "properties": {
                 "contentType": {
                     "description": "The MIME content type of the attachment.",
@@ -817,11 +817,8 @@
                     "type": "array"
                 },
                 "features": {
-                    "description": "The feature(s) to add the attachment to.",
-                    "items": {
-                        "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
-                    },
-                    "type": "array"
+                    "$ref": "#/definitions/FeaturesLike",
+                    "description": "Features to use for the command/operation."
                 },
                 "maps": {
                     "$ref": "MapsLike",
@@ -835,7 +832,6 @@
             "required": [
                 "contentType",
                 "data",
-                "features",
                 "maps",
                 "name"
             ],
@@ -896,53 +892,13 @@
             },
             "type": "object"
         },
-        "AddNodeOrder": {
-            "description": "Indicates whether a new point should be added before or after the active point in a sketch.",
-            "enum": [
-                "add-after-active",
-                "add-before-active"
-            ],
-            "type": "string"
-        },
-        "AddNodeToGeometryArgs": {
-            "additionalProperties": false,
-            "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/@arcgis.core.unionTypes.GeometryUnion",
-                    "description": "The initial geometry to add the point to. Can be null."
-                },
-                "geometryType": {
-                    "description": "The type of geometry to create if the initial geometry is null. In VertiGIS Studio Mobile, this value must be 'polygon' or 'polyline'. In VertiGIS Studio Web, this value may also be null if the point being added is intended to be added to the active sketch.",
-                    "type": "string"
-                },
-                "maps": {
-                    "$ref": "MapsLike",
-                    "description": "Map(s) to use for the command/operation."
-                },
-                "node": {
-                    "$ref": "#/definitions/@arcgis.core.unionTypes.GeometryUnion",
-                    "description": "A point geometry to add to the initial geometry. In VertiGIS Studio Web, this value may be null if the intention is to add a point at the position of the active point of an active sketch."
-                },
-                "nodeOrder": {
-                    "$ref": "#/definitions/AddNodeOrder",
-                    "description": "Indicates whether the new point should be added before or after the active point in the sketch. Not supported by VertiGIS Studio Mobile."
-                }
-            },
-            "required": [
-                "geometry",
-                "geometryType",
-                "node"
-            ],
-            "type": "object"
-        },
         "AddPointArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.add-point\" command.",
             "properties": {
                 "geometry": {
                     "$ref": "#/definitions/@arcgis.core.unionTypes.GeometryUnion",
-                    "description": "The geometry to add the point to, if multiple are present in an active editing session. Not supported by Mobile."
+                    "description": "The geometry to add the point to, if multiple are present in an active editing session. Not supported by VertiGIS Studio Mobile."
                 },
                 "maps": {
                     "$ref": "MapsLike",
@@ -968,7 +924,7 @@
                 },
                 "initialPosition": {
                     "$ref": "MessageBoxPosition",
-                    "description": "Where the dialog appears in the app when it is created. Defaults to center position. Web only."
+                    "description": "Where the dialog appears in the app when it is created. Defaults to \"center\" position. Web only."
                 },
                 "isDraggable": {
                     "description": "Whether the dialog is draggable or not. Defaults to true. Web only.",
@@ -1030,7 +986,7 @@
                     "type": "number"
                 },
                 "pluginSettings": {
-                    "description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
+                    "description": "Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings. Web only."
                 },
                 "symbol": {
                     "anyOf": [
@@ -1159,7 +1115,7 @@
                 },
                 "initialPosition": {
                     "$ref": "MessageBoxPosition",
-                    "description": "Where the dialog appears in the app when it is created. Defaults to center position. Web only."
+                    "description": "Where the dialog appears in the app when it is created. Defaults to \"center\" position. Web only."
                 },
                 "isDraggable": {
                     "description": "Whether the dialog is draggable or not. Defaults to true. Web only.",
@@ -1608,7 +1564,7 @@
                     "type": "string"
                 },
                 "pluginSettings": {
-                    "description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
+                    "description": "Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
                 },
                 "showNotifications": {
                     "description": "Whether to show UI notifications. Defaults to `true`.",
@@ -1688,7 +1644,7 @@
                     "type": "string"
                 },
                 "pluginSettings": {
-                    "description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
+                    "description": "Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
                 },
                 "relatedFeatureSource": {
                     "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource",
@@ -1868,7 +1824,7 @@
                     "description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes."
                 },
                 "pluginSettings": {
-                    "description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
+                    "description": "Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
                 },
                 "showNotifications": {
                     "description": "Whether to show UI notifications. Will default to `true`.",
@@ -2714,7 +2670,7 @@
                     "type": "boolean"
                 },
                 "sources": {
-                    "description": "The feature sources to identify. Can be used instead of or in addition to \"maps\". Not supported in VertiGIS Studio Mobile (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\"). Source will be used in addition to the maps.",
                     "items": {
                         "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
                     },
@@ -2736,7 +2692,7 @@
             "properties": {
                 "geometry": {
                     "$ref": "#/definitions/@arcgis.core.unionTypes.GeometryUnion",
-                    "description": "The geometry to add the point to, if multiple are present in an active editing session. Not supported by Mobile."
+                    "description": "The geometry to add the point to, if multiple are present in an active editing session. Not supported by VertiGIS Studio Mobile."
                 },
                 "maps": {
                     "$ref": "MapsLike",
@@ -2833,7 +2789,7 @@
             "additionalProperties": false,
             "properties": {
                 "accountId": {
-                    "description": "The accountId (orgId) that we want to check licensing.",
+                    "description": "The accountId (orgId) that we want to check licensing for.",
                     "type": "string"
                 },
                 "applicationName": {
@@ -2841,7 +2797,7 @@
                     "type": "string"
                 },
                 "sku": {
-                    "description": "Overwrite the SKU for license check.",
+                    "description": "Overwrite the default SKU (if any) for license checking.",
                     "type": "string"
                 }
             },
@@ -3421,7 +3377,7 @@
                     "type": "string"
                 }
             ],
-            "description": "Argument used in case when we have only 1 map in the app or when the first active map should be used. Basemap extension ID or the basemap self. If more than one basemap is specified, only the first one is used."
+            "description": "Argument used in case when we have only 1 map in the app or when the first active map should be used. Basemap extension ID or the basemap itself. If more than one basemap is specified, only the first one is used."
         },
         "SetBasemapArgs": {
             "anyOf": [
@@ -3445,7 +3401,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 VertiGIS Studio Web).",
+            "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 (e.g. basemap picker in VertiGIS Studio Web).",
             "properties": {
                 "basemap": {
                     "$ref": "#/definitions/SetBasemapArg",
@@ -4145,7 +4101,7 @@
                             "type": "array"
                         }
                     ],
-                    "description": "The blob(s) that contains the file attachment(s). If multiple attachments are specified, all attachment will be added to the feature(s)."
+                    "description": "The blob(s) that contains the file attachment(s). If multiple attachments are specified, all attachments will be added to the feature(s)."
                 },
                 "features": {
                     "$ref": "#/definitions/Features",
@@ -4278,7 +4234,7 @@
             "$ref": "Principal"
         },
         "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 VertiGIS Studio Mobile.",
+            "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. Default is true.",
             "enum": [
                 "auth.sign-in"
             ]
@@ -4290,7 +4246,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 VertiGIS Studio Mobile.",
+            "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. Default is true.",
             "enum": [
                 "auth.sign-out"
             ]
@@ -4599,7 +4555,7 @@
             ]
         },
         "edit.display-add-feature": {
-            "description": "Begin an interactive feature editing session with a new feature. `DisplayAddFeatureArgs` is not supported on Mobile.\n\n**Example:** Create and allow the user to edit a new feature with an initial attributes collection. If no geometry is provided in context they will be asked to select one.\n\n_Note:_ $map1.map.extension is the output of a 'Get Map' activity run in Web by Workflow. When the map and/or layer are provided in the context of a command chain these parameters can be omitted.\n\n```\n{\n    \"editAttributes\": true,\n    \"editGeometry\": true,\n    \"featureAttributes\": {\n        \"ASSET_ID\": \"WFH001234\"\n    },\n    \"layers\": \"Victoria_Fire_Hydrants_8780\",\n    \"maps\": $map1.map.extension\n}\n```",
+            "description": "Begin an interactive feature editing session with a new feature. `DisplayAddFeatureArgs` is not supported on Mobile.\n\n**Example:** Create and allow the user to edit a new feature with an initial attributes collection. If no geometry is provided in context they will be asked to select one.\n\n_Note:_ \"maps\" argument can be the output of a 'Get Map' activity run in Web by Workflow or coming from a previous operation in the action chain. When the map and/or layer are provided in the context of a command chain these parameters can be omitted.\n\n```\n{\n    \"editAttributes\": true,\n    \"editGeometry\": true,\n    \"featureAttributes\": {\n        \"ASSET_ID\": \"WFH001234\"\n    },\n    \"layers\": \"Victoria_Fire_Hydrants_8780\"\n}\n```",
             "enum": [
                 "edit.display-add-feature"
             ]
@@ -4615,7 +4571,7 @@
             ]
         },
         "edit.display-add-related-feature": {
-            "description": "Begin an interactive feature editing session for a new related feature. The specified feature will be the original feature that the new related feature will be added to in the relationship.\n\n**Example:** Create and edit a new record on a related table, with the option to add attachments. Make sure the 'COMMENTS' field is included in the editable attributes and make it required.\n\n_Notes:_.\n\n1. The feature used here must come from the running viewer, and cannot be an    ad-hoc feature created from a JSON object. For example, you can use    the output of `results.get-active-features`, or the feature provided    in a command chain context.\n2. `editableExpression` and `requiredExpression` both take an arcade    expression, and here the string \"true\" is just a simple arcade    expression that always returns true. You can also use a more complex    expression, or reference one from your webmap.\n\n```\n{\n    \"editAttributes\": true,\n    \"editAttachments\": true,\n    \"features\": $runOperation1.result,\n    \"relationshipId\": \"1\",\n    \"fieldElements\": [\n        {\n            \"fieldName\": \"COMMENTS\",\n            \"editableExpression\": \"true\",\n            \"requiredExpression\": \"true\"\n        }\n    ]\n}\n```",
+            "description": "Begin an interactive feature editing session for a new related feature. The specified feature will be the original feature that the new related feature will be added to in the relationship.\n\n**Example:** Create and edit a new record on a related table, with the option to add attachments. Make sure the 'COMMENTS' field is included in the editable attributes and make it required.\n\n_Notes:_.\n\n1. The feature used here must come from the running viewer, and cannot be an    ad-hoc feature created from a JSON object. For example, you can use    the output of `results.get-active-features`, or the feature provided    in a command chain context.\n2. `editableExpression` and `requiredExpression` both take an Arcade    expression, and here the string \"true\" is just a simple Arcade    expression that always returns true. You can also use a more complex    expression, or reference one from your webmap.\n\n```\n{\n    \"editAttributes\": true,\n    \"editAttachments\": true,\n    \"relationshipId\": \"1\",\n    \"fieldElements\": [\n        {\n            \"fieldName\": \"COMMENTS\",\n            \"editableExpression\": \"true\",\n            \"requiredExpression\": \"true\"\n        }\n    ]\n}\n```",
             "enum": [
                 "edit.display-add-related-feature"
             ]
@@ -14946,13 +14902,13 @@
             ]
         },
         "results.display": {
-            "description": "Presents features to the user within any components that can display features, such as a feature list, feature table, or feature details component. The argument is the features to display, or an object specifying both features and the target results component to update (Web only).",
+            "description": "Presents features to the user within any components that can display features, such as a feature list, feature table, or feature details component. The argument is the features to display, or an object specifying both features and the target results component to update (Web only). If features are specified, they will overwrite any incoming features from previous operations up the action chain.",
             "enum": [
                 "results.display"
             ]
         },
         "results.display-details": {
-            "description": "Presents feature details to the user within the feature-details component. The argument is the feature(s) to display, or an object specifying both features and the target results component to update (Web only).",
+            "description": "Presents feature details to the user within the feature-details component. The argument is the feature(s) to display, or an object specifying both features and the target results component to update (this object, UpdateResultsFeaturesArgs, is Web only).",
             "enum": [
                 "results.display-details"
             ]
@@ -15137,18 +15093,6 @@
                 "search.clear"
             ]
         },
-        "sketching.add-node-to-geometry": {
-            "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"
-            ]
-        },
-        "sketching.add-node-to-geometry:input": {
-            "$ref": "#/definitions/AddNodeToGeometryArgs"
-        },
-        "sketching.add-node-to-geometry:output": {
-            "$ref": "#/definitions/@arcgis.core.unionTypes.GeometryUnion"
-        },
         "sketching.add-point": {
             "description": "Adds a point to polygon, polyline, or multipoint using the selected index as the point to insert after.",
             "enum": [
@@ -16699,22 +16643,6 @@
                     ],
                     "type": "object"
                 },
-                {
-                    "additionalProperties": false,
-                    "properties": {
-                        "arguments": {
-                            "$ref": "#/definitions/sketching.add-node-to-geometry:input"
-                        },
-                        "name": {
-                            "$ref": "#/definitions/sketching.add-node-to-geometry"
-                        }
-                    },
-                    "required": [
-                        "name",
-                        "arguments"
-                    ],
-                    "type": "object"
-                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -16878,9 +16806,6 @@
                 {
                     "$ref": "#/definitions/results.upload-data-to-features"
                 },
-                {
-                    "$ref": "#/definitions/sketching.add-node-to-geometry"
-                },
                 {
                     "$ref": "#/definitions/sketching.capture-geometry"
                 },

package/messaging/schema/common-event.schema.json

@@ -226,7 +226,7 @@
             "description": "Arguments for the \"geolocation.status-changed\" event.",
             "properties": {
                 "isEnabled": {
-                    "description": "Indicates whether the geolocation is now enabled.",
+                    "description": "Indicates whether the geolocation is enabled.",
                     "type": "boolean"
                 }
             },
@@ -314,7 +314,7 @@
                 },
                 "layers": {
                     "$ref": "#/definitions/LayersLike",
-                    "description": "The layer whose visibility was changed. Web only."
+                    "description": "The layer(s) whose visibility was changed. Web only."
                 }
             },
             "type": "object"
@@ -697,7 +697,7 @@
                 },
                 "portalType": {
                     "$ref": "#/definitions/PortalType",
-                    "description": "The type of Portal: AGOL or Enterprise."
+                    "description": "The type of Portal: AGOL or ArcGISEnterprise."
                 },
                 "requestInfo": {
                     "description": "Information about the resource that is required to sign in. Not available in VertiGIS Studio Web. Will be an instance of esri.security.CredentialRequestInfo for VertiGIS Studio Mobile."
@@ -723,7 +723,7 @@
                 },
                 "portalType": {
                     "$ref": "#/definitions/PortalType",
-                    "description": "The type of Portal: AGOL or Enterprise."
+                    "description": "The type of Portal: AGOL or ArcGISEnterprise."
                 },
                 "requestInfo": {
                     "description": "Information about the resource that is required to sign in. Not available in VertiGIS Studio Web. Will be an instance of esri.security.CredentialRequestInfo for VertiGIS Studio Mobile."
@@ -797,6 +797,7 @@
         },
         "TimeSpan": {
             "additionalProperties": false,
+            "description": "{@link https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-9.0}.",
             "type": "object"
         },
         "VisualVariableJson": {