@vertigis/viewer-spec 49.9.0 → 50.0.0

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

@@ -1,6 +1,10 @@
 {
     "$ref": "#/definitions/viewer-spec.Event",
     "definitions": {
+        "ArcGISPortalIdentity": {
+            "additionalProperties": false,
+            "type": "object"
+        },
         "AuthenticationType": {
             "description": "A type of authentication.",
             "enum": [
@@ -11,6 +15,25 @@
             ],
             "type": "string"
         },
+        "Error": {
+            "additionalProperties": false,
+            "properties": {
+                "message": {
+                    "type": "string"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "stack": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "message",
+                "name"
+            ],
+            "type": "object"
+        },
         "GeolocateAccuracyChangedEventArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"geolocation.accuracy-changed\" event.",
@@ -39,12 +62,25 @@
         "GeolocationStatusChangedEventArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"geolocation.status-changed\" event.",
+            "properties": {
+                "isEnabled": {
+                    "description": "Indicates whether the geolocation is now enabled.",
+                    "type": "boolean"
+                }
+            },
+            "required": [
+                "isEnabled"
+            ],
             "type": "object"
         },
         "GnssDeviceConnectionInfo": {
             "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"
@@ -59,6 +95,7 @@
                 }
             },
             "required": [
+                "deviceFullName",
                 "deviceName",
                 "deviceType",
                 "settings"
@@ -89,11 +126,41 @@
             "additionalProperties": false,
             "description": "Arguments for the various map events.",
             "properties": {
+                "mapExtension": {
+                    "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension",
+                    "description": "The map extension for which the event was generated."
+                },
                 "maps": {
                     "$ref": "#/definitions/MapsLike",
                     "description": "The map from which the event was generated."
                 }
             },
+            "required": [
+                "mapExtension"
+            ],
+            "type": "object"
+        },
+        "MapInitializedEvent": {
+            "additionalProperties": false,
+            "description": "Event args for the map.initialized event.",
+            "properties": {
+                "loadTime": {
+                    "$ref": "#/definitions/TimeSpan",
+                    "description": "The amount of time that the map took to load. Mobile only."
+                },
+                "mapExtension": {
+                    "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension",
+                    "description": "The map extension for which the event was generated."
+                },
+                "maps": {
+                    "$ref": "#/definitions/MapsLike",
+                    "description": "The map from which the event was generated."
+                }
+            },
+            "required": [
+                "loadTime",
+                "mapExtension"
+            ],
             "type": "object"
         },
         "MapsLike": {
@@ -175,6 +242,14 @@
             ],
             "description": "An operational layer in a web map/scene."
         },
+        "PortalType": {
+            "description": "The type of Portal.",
+            "enum": [
+                "AGOL",
+                "ArcGISEnterprise"
+            ],
+            "type": "string"
+        },
         "PrintErrorEventArgs": {
             "additionalProperties": false,
             "description": "Arguments for the printing.print-error event.",
@@ -265,20 +340,44 @@
             ],
             "type": "object"
         },
+        "SignInCompletedEventArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the auth.sign-in-completed and auth.portal-sign-in-completed events. Only available in VertiGIS Studio Mobile.",
+            "properties": {
+                "credential": {
+                    "$ref": "esriRuntimeSdk.Credential",
+                    "description": "The credential resulting from the sign in."
+                },
+                "identity": {
+                    "$ref": "#/definitions/ArcGISPortalIdentity",
+                    "description": "The identity that was obtained from the sign in."
+                }
+            },
+            "required": [
+                "credential",
+                "identity"
+            ],
+            "type": "object"
+        },
         "SignInEventArgs": {
             "additionalProperties": false,
-            "description": "Arguments for the auth.sign-in events. Only available in the Geocortex Mobile Viewer.",
+            "description": "Arguments for the auth.sign-in events. Only available in VertiGIS Studio Mobile.",
             "properties": {
                 "authenticationType": {
                     "$ref": "#/definitions/AuthenticationType",
-                    "description": "The authentication method used for the sign in process. Not available in Geocortex Web Viewer."
+                    "description": "The authentication method used for the sign in process. Not available in VertiGIS Studio Web."
+                },
+                "portalType": {
+                    "$ref": "#/definitions/PortalType",
+                    "description": "The type of Portal: AGOL or Enterprise."
                 },
                 "requestInfo": {
-                    "description": "Information about the resource that is required to sign in. Not available in Geocortex Web Viewer. Will be an instance of esri.security.CredentialRequestInfo for the Geocortex Mobile Viewer."
+                    "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."
                 }
             },
             "required": [
                 "authenticationType",
+                "portalType",
                 "requestInfo"
             ],
             "type": "object"
@@ -289,30 +388,82 @@
             "properties": {
                 "authenticationType": {
                     "$ref": "#/definitions/AuthenticationType",
-                    "description": "The authentication method used for the sign in process. Not available in Geocortex Web Viewer."
+                    "description": "The authentication method used for the sign in process. Not available in VertiGIS Studio Web."
                 },
                 "exception": {
-                    "description": "The exception that occurred during the sign in. Not available in Geocortex Web Viewer."
+                    "description": "The exception that occurred during the sign in. Not available in VertiGIS Studio Web."
+                },
+                "portalType": {
+                    "$ref": "#/definitions/PortalType",
+                    "description": "The type of Portal: AGOL or Enterprise."
                 },
                 "requestInfo": {
-                    "description": "Information about the resource that is required to sign in. Not available in Geocortex Web Viewer. Will be an instance of esri.security.CredentialRequestInfo for the Geocortex Mobile Viewer."
+                    "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."
                 }
             },
             "required": [
                 "authenticationType",
                 "exception",
+                "portalType",
                 "requestInfo"
             ],
             "type": "object"
         },
+        "TimeSpan": {
+            "additionalProperties": false,
+            "type": "object"
+        },
+        "WorkflowErrorEventArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"workflow.workflow-error\" event.",
+            "properties": {
+                "errorMessage": {
+                    "description": "The human readable error message.",
+                    "type": "string"
+                },
+                "exception": {
+                    "$ref": "#/definitions/Error",
+                    "description": "The Error object containing detailed information about the error."
+                },
+                "workflow": {
+                    "$ref": "WorkflowModel",
+                    "description": "The workflow pertaining to the event."
+                }
+            },
+            "required": [
+                "workflow"
+            ],
+            "type": "object"
+        },
+        "WorkflowFinishedEventArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"workflow.workflow-finished\" event.",
+            "properties": {
+                "workflow": {
+                    "$ref": "WorkflowModel",
+                    "description": "The workflow pertaining to the event."
+                }
+            },
+            "required": [
+                "workflow"
+            ],
+            "type": "object"
+        },
         "auth.sign-in-completed": {
-            "description": "Raised when successfully signed in.",
+            "description": "Raised when successfully signed in. Principal event type used in Web, SignInCompletedEventArgs used in Mobile.",
             "enum": [
                 "auth.sign-in-completed"
             ]
         },
         "auth.sign-in-completed:input": {
-            "$ref": "Principal"
+            "anyOf": [
+                {
+                    "$ref": "Principal"
+                },
+                {
+                    "$ref": "#/definitions/SignInCompletedEventArgs"
+                }
+            ]
         },
         "auth.sign-in-failed": {
             "description": "Raised when a sign-in attempt fails.",
@@ -359,7 +510,7 @@
             ]
         },
         "auth.token-refreshed": {
-            "description": "Raised when the user's token is refreshed. Will be the new token in the Geocortex Web Viewer, and a TokenCredential object in the Geocortex Mobile Viewer.",
+            "description": "Raised when the user's token is refreshed. Will be the new token in the VertiGIS Studio Web, and a TokenCredential object in VertiGIS Studio Mobile.",
             "enum": [
                 "auth.token-refreshed"
             ]
@@ -8933,13 +9084,20 @@
             "$ref": "#/definitions/GeolocationStatusChangedEventArgs"
         },
         "map.initialized": {
-            "description": "Raised when a map has completed initialization.",
+            "description": "Raised when a map has completed initialization. MapEvent used in Web, MapInitializedEvent used in Mobile.",
             "enum": [
                 "map.initialized"
             ]
         },
         "map.initialized:input": {
-            "$ref": "#/definitions/MapEvent"
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/MapEvent"
+                },
+                {
+                    "$ref": "#/definitions/MapInitializedEvent"
+                }
+            ]
         },
         "map.viewpoint-changed": {
             "description": "Raised when the a map extent is changed. This event is raised in extremely high frequency - for example, every few pixels the map is repositioned during a pan.",
@@ -9077,8 +9235,32 @@
                 },
                 {
                     "$ref": "#/definitions/ui.deactivated"
+                },
+                {
+                    "$ref": "#/definitions/workflow.workflow-error"
+                },
+                {
+                    "$ref": "#/definitions/workflow.workflow-finished"
                 }
             ]
+        },
+        "workflow.workflow-error": {
+            "description": "Raised when an error occurs while running a workflow.",
+            "enum": [
+                "workflow.workflow-error"
+            ]
+        },
+        "workflow.workflow-error:input": {
+            "$ref": "#/definitions/WorkflowErrorEventArgs"
+        },
+        "workflow.workflow-finished": {
+            "description": "Raised when a workflow finishes running.",
+            "enum": [
+                "workflow.workflow-finished"
+            ]
+        },
+        "workflow.workflow-finished:input": {
+            "$ref": "#/definitions/WorkflowFinishedEventArgs"
         }
     }
 }