@vertigis/viewer-spec 56.24.0 → 56.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/analytics/AnalyticsContext.d.ts +29 -29
- package/analytics/AnalyticsContext.js +1 -1
- package/analytics/CommonAction.d.ts +90 -90
- package/analytics/CommonAction.js +1 -1
- package/analytics/MobileAction.d.ts +113 -113
- package/analytics/MobileAction.js +1 -1
- package/analytics/WebAction.d.ts +102 -102
- package/analytics/WebAction.js +1 -1
- package/app-config/AppConfig.d.ts +55 -55
- package/app-config/ItemConfig.d.ts +18 -18
- package/app-config/common/AnalyticsModelProperties.d.ts +10 -10
- package/app-config/common/ApplicationModelProperties.d.ts +15 -15
- package/app-config/common/BasemapPickerModelProperties.d.ts +6 -6
- package/app-config/common/BookmarksModelProperties.d.ts +17 -17
- package/app-config/common/BrandingColors.d.ts +102 -102
- package/app-config/common/BrandingModelProperties.d.ts +23 -23
- package/app-config/common/BrandingThemeProperties.d.ts +35 -35
- package/app-config/common/CompassModelProperties.d.ts +6 -6
- package/app-config/common/ComponentModelProperties.d.ts +14 -14
- package/app-config/common/CoordinateFormat.d.ts +4 -4
- package/app-config/common/CoordinateModelProperties.d.ts +43 -43
- package/app-config/common/DialogModelProperties.d.ts +6 -6
- package/app-config/common/EventListenerModelProperties.d.ts +44 -44
- package/app-config/common/ExpandModelProperties.d.ts +6 -6
- package/app-config/common/FeatureDetailsModelProperties.d.ts +27 -27
- package/app-config/common/GeolocationModelProperties.d.ts +6 -6
- package/app-config/common/HighlightModelProperties.d.ts +68 -68
- package/app-config/common/ImageModelProperties.d.ts +14 -14
- package/app-config/common/ItemRef.d.ts +4 -4
- package/app-config/common/LayerListModelProperties.d.ts +6 -6
- package/app-config/common/LayerPresetsModelProperties.d.ts +14 -14
- package/app-config/common/LayoutProperties.d.ts +33 -33
- package/app-config/common/LegendModelProperties.d.ts +6 -6
- package/app-config/common/LicensingModelProperties.d.ts +10 -10
- package/app-config/common/MapCoordinatesModelProperties.d.ts +6 -6
- package/app-config/common/MapModelProperties.d.ts +7 -7
- package/app-config/common/MenuModelProperties.d.ts +13 -13
- package/app-config/common/ModelProperties.d.ts +6 -6
- package/app-config/common/PanelModelProperties.d.ts +6 -6
- package/app-config/common/RegionModelProperties.d.ts +25 -25
- package/app-config/common/ResultsModelProperties.d.ts +13 -13
- package/app-config/common/ScalebarModelProperties.d.ts +6 -6
- package/app-config/common/SearchModelProperties.d.ts +26 -26
- package/app-config/common/ServiceModelProperties.d.ts +6 -6
- package/app-config/common/SplitModelProperties.d.ts +6 -6
- package/app-config/common/StackModelProperties.d.ts +6 -6
- package/app-config/common/TextModelProperties.d.ts +10 -10
- package/app-config/common/TranslatableText.d.ts +35 -35
- package/app-config/common/UserModelProperties.d.ts +6 -6
- package/app-config/common/WorkflowEventsProperties.d.ts +11 -11
- package/app-config/common/WorkflowModelProperties.d.ts +44 -44
- package/app-config/common/ZoomModelProperties.d.ts +6 -6
- package/app-config/common/colors.d.ts +6 -6
- package/app-config/index.d.ts +2 -2
- package/app-config/mobile/AddFeatureModelProperties.d.ts +6 -6
- package/app-config/mobile/AddRelatedFeatureModelProperties.d.ts +6 -6
- package/app-config/mobile/BasemapModelProperties.d.ts +11 -11
- package/app-config/mobile/CoordinateModelProperties.d.ts +10 -10
- package/app-config/mobile/FeatureDetailsModelProperties.d.ts +26 -26
- package/app-config/mobile/GeometryToolbarModelProperties.d.ts +6 -6
- package/app-config/mobile/GnssDeviceSelectionModelProperties.d.ts +6 -6
- package/app-config/mobile/GnssDeviceSettingsModelProperties.d.ts +6 -6
- package/app-config/mobile/GnssMetadataModelProperties.d.ts +6 -6
- package/app-config/mobile/MapModelProperties.d.ts +52 -52
- package/app-config/mobile/OfflineModelProperties.d.ts +48 -48
- package/app-config/mobile/PortalExtensionSettingsProperties.d.ts +27 -27
- package/app-config/mobile/ScrollModelProperties.d.ts +6 -6
- package/app-config/mobile/SearchModelProperties.d.ts +14 -14
- package/app-config/mobile/SelectLayerSettingsModelProperties.d.ts +11 -11
- package/app-config/mobile/TaskbarModelProperties.d.ts +6 -6
- package/app-config/mobile/UpdateFeatureModelProperties.d.ts +6 -6
- package/app-config/mobile/VertigisMobileModelProperties.d.ts +67 -67
- package/app-config/schema/common-app-config.schema.json +1 -1
- package/app-config/schema/web-app-config.schema.json +1 -1
- package/app-config/web/AddressModelProperties.d.ts +6 -6
- package/app-config/web/BasemapModelProperties.d.ts +10 -10
- package/app-config/web/BasemapPickerModelProperties.d.ts +7 -7
- package/app-config/web/BookmarksModelProperties.d.ts +7 -7
- package/app-config/web/BrandingModelProperties.d.ts +14 -14
- package/app-config/web/ChartModelProperties.d.ts +58 -58
- package/app-config/web/CompassModelProperties.d.ts +7 -7
- package/app-config/web/ComponentModelProperties.d.ts +12 -12
- package/app-config/web/CoordinateModelProperties.d.ts +50 -50
- package/app-config/web/DataLinkSourceProperties.d.ts +15 -15
- package/app-config/web/DialogModelProperties.d.ts +7 -7
- package/app-config/web/DrawModelProperties.d.ts +94 -94
- package/app-config/web/FeatureDetailsModelProperties.d.ts +19 -19
- package/app-config/web/FeatureInfoModelProperties.d.ts +38 -38
- package/app-config/web/FeatureListProperties.d.ts +12 -12
- package/app-config/web/FeatureSetProperties.d.ts +16 -16
- package/app-config/web/FeatureSummaryModelProperties.d.ts +27 -27
- package/app-config/web/GeolocationModelProperties.d.ts +7 -7
- package/app-config/web/GeometryModelProperties.d.ts +27 -27
- package/app-config/web/HasVisibilityFilters.d.ts +36 -36
- package/app-config/web/ImageModelProperties.d.ts +7 -7
- package/app-config/web/KpiCardModelProperties.d.ts +146 -146
- package/app-config/web/LayerListModelProperties.d.ts +18 -18
- package/app-config/web/LayerPresetsModelProperties.d.ts +7 -7
- package/app-config/web/LegendModelProperties.d.ts +7 -7
- package/app-config/web/Map3dToggleModelProperties.d.ts +6 -6
- package/app-config/web/MapCoordinatesModelProperties.d.ts +50 -50
- package/app-config/web/MapModelProperties.d.ts +87 -87
- package/app-config/web/MeasurementModelProperties.d.ts +36 -36
- package/app-config/web/MenuItemModelProperties.d.ts +7 -7
- package/app-config/web/MenuModelProperties.d.ts +13 -13
- package/app-config/web/ModelProperties.d.ts +7 -7
- package/app-config/web/PanelModelProperties.d.ts +7 -7
- package/app-config/web/PortalModelProperties.d.ts +11 -11
- package/app-config/web/PrintFormModelProperties.d.ts +42 -42
- package/app-config/web/PrintModelProperties.d.ts +11 -11
- package/app-config/web/ProjectModelProperties.d.ts +12 -12
- package/app-config/web/QueryBuilderModelProperties.d.ts +22 -22
- package/app-config/web/ReportModelProperties.d.ts +15 -15
- package/app-config/web/ResultsModelProperties.d.ts +101 -101
- package/app-config/web/ResultsServiceModelProperties.d.ts +48 -48
- package/app-config/web/ScaleInputModelProperties.d.ts +6 -6
- package/app-config/web/ScalebarModelProperties.d.ts +22 -22
- package/app-config/web/SearchModelProperties.d.ts +22 -22
- package/app-config/web/SearchServiceProperties.d.ts +25 -25
- package/app-config/web/SharedProjectsModelProperties.d.ts +53 -53
- package/app-config/web/SharedStorageModelProperties.d.ts +30 -30
- package/app-config/web/SnappingProperties.d.ts +101 -101
- package/app-config/web/SplitModelProperties.d.ts +7 -7
- package/app-config/web/StackModelProperties.d.ts +7 -7
- package/app-config/web/TabsModelProperties.d.ts +6 -6
- package/app-config/web/TextModelProperties.d.ts +7 -7
- package/app-config/web/UserModelProperties.d.ts +12 -12
- package/app-config/web/UserPreferencesModelProperties.d.ts +10 -10
- package/app-config/web/VertigisWebModelProperties.d.ts +74 -74
- package/app-config/web/WorkflowModelProperties.d.ts +13 -13
- package/app-config/web/ZoomModelProperties.d.ts +7 -7
- package/messaging/Command.d.ts +76 -76
- package/messaging/CommandRegistry.d.ts +25 -25
- package/messaging/CommandRegistry.js +1 -1
- package/messaging/DotNetTypes.d.ts +4 -4
- package/messaging/Event.d.ts +26 -26
- package/messaging/EventRegistry.d.ts +25 -25
- package/messaging/EventRegistry.js +1 -1
- package/messaging/Message.d.ts +50 -50
- package/messaging/MessageBus.d.ts +54 -54
- package/messaging/Operation.d.ts +77 -77
- package/messaging/OperationRegistry.d.ts +26 -26
- package/messaging/OperationRegistry.js +1 -1
- package/messaging/common.d.ts +354 -354
- package/messaging/mobile.d.ts +6 -6
- package/messaging/registry/Commands.d.ts +78 -78
- package/messaging/registry/Commands.js +1 -1
- package/messaging/registry/Events.d.ts +62 -62
- package/messaging/registry/Events.js +1 -1
- package/messaging/registry/Operations.d.ts +69 -69
- package/messaging/registry/Operations.js +1 -1
- package/messaging/registry/app-config.d.ts +12 -12
- package/messaging/registry/app-config.js +1 -1
- package/messaging/registry/app.d.ts +264 -264
- package/messaging/registry/app.js +1 -1
- package/messaging/registry/arcade.d.ts +115 -115
- package/messaging/registry/arcade.js +1 -1
- package/messaging/registry/auth.d.ts +151 -151
- package/messaging/registry/auth.js +1 -1
- package/messaging/registry/basemap.d.ts +74 -74
- package/messaging/registry/basemap.js +1 -1
- package/messaging/registry/bookmark.d.ts +42 -42
- package/messaging/registry/bookmark.js +1 -1
- package/messaging/registry/charts.d.ts +81 -81
- package/messaging/registry/charts.js +1 -1
- package/messaging/registry/debugConsole.d.ts +26 -26
- package/messaging/registry/debugConsole.js +1 -1
- package/messaging/registry/device.d.ts +28 -28
- package/messaging/registry/device.js +1 -1
- package/messaging/registry/display.d.ts +17 -17
- package/messaging/registry/display.js +1 -1
- package/messaging/registry/drawing.d.ts +149 -149
- package/messaging/registry/drawing.js +1 -1
- package/messaging/registry/edit.d.ts +371 -371
- package/messaging/registry/edit.js +1 -1
- package/messaging/registry/file.d.ts +156 -156
- package/messaging/registry/file.js +1 -1
- package/messaging/registry/filter-builder.d.ts +73 -73
- package/messaging/registry/filter-builder.js +1 -1
- package/messaging/registry/geocode.d.ts +87 -87
- package/messaging/registry/geocode.js +1 -1
- package/messaging/registry/geolocation.d.ts +499 -499
- package/messaging/registry/geolocation.js +1 -1
- package/messaging/registry/geometry-toolbar.d.ts +29 -29
- package/messaging/registry/geometry-toolbar.js +1 -1
- package/messaging/registry/geometry.d.ts +278 -278
- package/messaging/registry/geometry.js +1 -1
- package/messaging/registry/highlights.d.ts +86 -86
- package/messaging/registry/highlights.js +1 -1
- package/messaging/registry/input.d.ts +22 -22
- package/messaging/registry/input.js +1 -1
- package/messaging/registry/iwtm.d.ts +11 -11
- package/messaging/registry/iwtm.js +1 -1
- package/messaging/registry/kpi.d.ts +98 -98
- package/messaging/registry/kpi.js +1 -1
- package/messaging/registry/layer-comparison.d.ts +104 -104
- package/messaging/registry/layer-comparison.js +1 -1
- package/messaging/registry/layer-presets.d.ts +49 -49
- package/messaging/registry/layer-presets.js +1 -1
- package/messaging/registry/layers.d.ts +196 -196
- package/messaging/registry/layers.js +1 -1
- package/messaging/registry/layout.d.ts +49 -49
- package/messaging/registry/layout.js +1 -1
- package/messaging/registry/licensing.d.ts +38 -38
- package/messaging/registry/licensing.js +1 -1
- package/messaging/registry/location-marker.d.ts +171 -171
- package/messaging/registry/location-marker.js +1 -1
- package/messaging/registry/logViewer.d.ts +17 -17
- package/messaging/registry/logViewer.js +1 -1
- package/messaging/registry/map.d.ts +1275 -1275
- package/messaging/registry/map.js +1 -1
- package/messaging/registry/measurement.d.ts +168 -168
- package/messaging/registry/measurement.js +1 -1
- package/messaging/registry/messaging.d.ts +23 -23
- package/messaging/registry/messaging.js +1 -1
- package/messaging/registry/network.d.ts +46 -46
- package/messaging/registry/network.js +1 -1
- package/messaging/registry/offline.d.ts +508 -507
- package/messaging/registry/offline.js +1 -1
- package/messaging/registry/panel.d.ts +115 -115
- package/messaging/registry/panel.js +1 -1
- package/messaging/registry/photos.d.ts +47 -47
- package/messaging/registry/photos.js +1 -1
- package/messaging/registry/portal.d.ts +94 -94
- package/messaging/registry/portal.js +1 -1
- package/messaging/registry/printing.d.ts +166 -166
- package/messaging/registry/printing.js +1 -1
- package/messaging/registry/project.d.ts +144 -144
- package/messaging/registry/project.js +1 -1
- package/messaging/registry/query-builder.d.ts +83 -83
- package/messaging/registry/query-builder.js +1 -1
- package/messaging/registry/region.d.ts +23 -23
- package/messaging/registry/region.js +1 -1
- package/messaging/registry/reports.d.ts +135 -135
- package/messaging/registry/reports.js +1 -1
- package/messaging/registry/results.d.ts +671 -671
- package/messaging/registry/results.js +1 -1
- package/messaging/registry/search.d.ts +74 -74
- package/messaging/registry/search.js +1 -1
- package/messaging/registry/settings.d.ts +38 -38
- package/messaging/registry/settings.js +1 -1
- package/messaging/registry/shortcut.d.ts +41 -41
- package/messaging/registry/shortcut.js +1 -1
- package/messaging/registry/sketching.d.ts +960 -960
- package/messaging/registry/sketching.js +1 -1
- package/messaging/registry/studioAnalytics.d.ts +25 -25
- package/messaging/registry/studioAnalytics.js +1 -1
- package/messaging/registry/system.d.ts +277 -277
- package/messaging/registry/system.js +1 -1
- package/messaging/registry/tasks.d.ts +323 -323
- package/messaging/registry/tasks.js +1 -1
- package/messaging/registry/ui.d.ts +518 -518
- package/messaging/registry/ui.js +1 -1
- package/messaging/registry/viewer.d.ts +145 -145
- package/messaging/registry/viewer.js +1 -1
- package/messaging/registry/workflow.d.ts +170 -170
- package/messaging/registry/workflow.js +1 -1
- package/messaging/schema/common-action.schema.json +6437 -12158
- package/messaging/schema/common-event.schema.json +107 -803
- package/messaging/schema/mobile-action.schema.json +7719 -16138
- package/messaging/schema/mobile-event.schema.json +181 -2422
- package/messaging/schema/web-action.schema.json +8397 -23281
- package/messaging/schema/web-event.schema.json +183 -1937
- package/package.json +20 -20
- package/version.d.ts +4 -4
- package/version.js +4 -4
package/messaging/registry/ui.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{CommandRegistry as t}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as i}from"../OperationRegistry.js";export var NotificationCategory;!function(t){t.ERROR="error",t.INFO="info",t.SUCCESS="success",t.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(t){t.AUTO="auto",t.APP="app",t.SYSTEM="system"}(NotificationType||(NotificationType={}));export var Position;!function(t){t.BOTTOM="bottom",t.LEFT="left",t.RIGHT="right",t.TOP="top"}(Position||(Position={}));export class UICommands extends t{
|
|
1
|
+
import{CommandRegistry as t}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as i}from"../OperationRegistry.js";export var NotificationCategory;!function(t){t.ERROR="error",t.INFO="info",t.SUCCESS="success",t.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(t){t.AUTO="auto",t.APP="app",t.SYSTEM="system"}(NotificationType||(NotificationType={}));export var Position;!function(t){t.BOTTOM="bottom",t.LEFT="left",t.RIGHT="right",t.TOP="top"}(Position||(Position={}));export class UICommands extends t{_prefix="ui";get activate(){return this._get("activate")}get activeToggle(){return this._get("active-toggle")}get alert(){return this._get("alert")}get await(){return this._get("await")}get deactivate(){return this._get("deactivate")}get displayBusyState(){return this._get("display-busy-state")}get displayNotification(){return this._get("display-notification")}get pauseNotifications(){return this._get("pause-notifications")}get resumeNotifications(){return this._get("resume-notifications")}get focus(){return this._get("focus")}get hideBusyState(){return this._get("hide-busy-state")}get hideNotification(){return this._get("hide-notification")}get makeAvailable(){return this._get("make-available")}get makeUnavailable(){return this._get("make-unavailable")}get narrate(){return this._get("narrate")}get setDensity(){return this._get("set-density")}get setLocale(){return this._get("set-locale")}get setTheme(){return this._get("set-theme")}get setVisualState(){return this._get("set-visual-state")}}export class UIOperations extends i{_prefix="ui";get confirm(){return this._get("confirm")}get getComponentIds(){return this._get("get-component-ids")}get getLocale(){return this._get("get-locale")}get getTheme(){return this._get("get-theme")}get getThemes(){return this._get("get-themes")}get getVisualState(){return this._get("get-visual-state")}get prompt(){return this._get("prompt")}}export class UIEvents extends e{_prefix="ui";get activated(){return this._get("activated")}get added(){return this._get("added")}get ancestorActivated(){return this._get("ancestor-activated")}get ancestorDeactivated(){return this._get("ancestor-deactivated")}get deactivated(){return this._get("deactivated")}get densityChanged(){return this._get("density-changed")}get localeChanged(){return this._get("locale-changed")}get initializing(){return this._get("initializing")}get initialized(){return this._get("initialized")}get removed(){return this._get("removed")}get reordered(){return this._get("reordered")}get themeChanged(){return this._get("theme-changed")}get visualStateChanged(){return this._get("visual-state-changed")}}
|
|
@@ -1,145 +1,145 @@
|
|
|
1
|
-
import type { EntityProperties } from "@vertigis/arcgis-extensions/Entity";
|
|
2
|
-
import type { Command } from "../Command.js";
|
|
3
|
-
import { CommandRegistry } from "../CommandRegistry.js";
|
|
4
|
-
import type { Event } from "../Event.js";
|
|
5
|
-
import { EventRegistry } from "../EventRegistry.js";
|
|
6
|
-
import type { Operation } from "../Operation.js";
|
|
7
|
-
import { OperationRegistry } from "../OperationRegistry.js";
|
|
8
|
-
import type { Model } from "../common.js";
|
|
9
|
-
export declare class ViewerCommands extends CommandRegistry {
|
|
10
|
-
protected readonly _prefix = "viewer";
|
|
11
|
-
/**
|
|
12
|
-
* Loads a new layout. Can be a layout URL or layout XML, or a Layout
|
|
13
|
-
* object. Web only.
|
|
14
|
-
*
|
|
15
|
-
* @webOnly
|
|
16
|
-
*/
|
|
17
|
-
get loadLayout(): Command<string | Model>;
|
|
18
|
-
/**
|
|
19
|
-
* Writes the operation context object to the console or log viewer at the
|
|
20
|
-
* debug level.
|
|
21
|
-
*/
|
|
22
|
-
get logDebug(): Command<unknown>;
|
|
23
|
-
/**
|
|
24
|
-
* Post a message to the parent frame of the viewer. Web only.
|
|
25
|
-
*
|
|
26
|
-
* @webOnly
|
|
27
|
-
*/
|
|
28
|
-
get postMessage(): Command<unknown>;
|
|
29
|
-
/**
|
|
30
|
-
* Publish an event with specified parameters "name" and "arguments". This
|
|
31
|
-
* command supports sending custom events (i.e. you use your own namespaced
|
|
32
|
-
* eventname) as well as built-in events. Mobile only.
|
|
33
|
-
*
|
|
34
|
-
* @mobileOnly
|
|
35
|
-
*/
|
|
36
|
-
get publishEvent(): Command<PublishEventArgs>;
|
|
37
|
-
/**
|
|
38
|
-
* Turn the debug mode of the viewer on or off. This can also be done using
|
|
39
|
-
* the debug=true URL parameter. Web only.
|
|
40
|
-
*
|
|
41
|
-
* @webOnly
|
|
42
|
-
*/
|
|
43
|
-
get setDebugMode(): Command<boolean>;
|
|
44
|
-
}
|
|
45
|
-
export declare class ViewerEvents extends EventRegistry {
|
|
46
|
-
protected readonly _prefix = "viewer";
|
|
47
|
-
/**
|
|
48
|
-
* Raised when the viewer finishes loading a layout. Web only.
|
|
49
|
-
*
|
|
50
|
-
* @webOnly
|
|
51
|
-
*/
|
|
52
|
-
get layoutChanged(): Event;
|
|
53
|
-
}
|
|
54
|
-
export declare class ViewerOperations extends OperationRegistry {
|
|
55
|
-
protected readonly _prefix = "viewer";
|
|
56
|
-
/**
|
|
57
|
-
* Gets all Layout models from the application. Web only.
|
|
58
|
-
*
|
|
59
|
-
* @webOnly
|
|
60
|
-
*/
|
|
61
|
-
get getAllLayouts(): Operation<void, Model[]>;
|
|
62
|
-
/**
|
|
63
|
-
* Gets the current Layout model from the application. Web only.
|
|
64
|
-
*
|
|
65
|
-
* @webOnly
|
|
66
|
-
*/
|
|
67
|
-
get getCurrentLayout(): Operation<void, Model>;
|
|
68
|
-
/**
|
|
69
|
-
* Gets information about the current viewer instance. Web only.
|
|
70
|
-
*
|
|
71
|
-
* @webOnly
|
|
72
|
-
*/
|
|
73
|
-
get getCapabilities(): Operation<void, ViewerCapabilities>;
|
|
74
|
-
/**
|
|
75
|
-
* Get whether the viewer is in debug mode. Web only.
|
|
76
|
-
*
|
|
77
|
-
* @webOnly
|
|
78
|
-
*/
|
|
79
|
-
get getInDebugMode(): Operation<void, boolean>;
|
|
80
|
-
/**
|
|
81
|
-
* Gets the version of the viewer. (i.e. the current version of web). Web
|
|
82
|
-
* only.
|
|
83
|
-
*
|
|
84
|
-
* @webOnly
|
|
85
|
-
*/
|
|
86
|
-
get getVersion(): Operation<void, string>;
|
|
87
|
-
/**
|
|
88
|
-
* Post a message to the parent frame of the viewer and await the reply. Web
|
|
89
|
-
* only.
|
|
90
|
-
*
|
|
91
|
-
* @webOnly
|
|
92
|
-
*/
|
|
93
|
-
get postMessageAwaitReply(): Operation<unknown, unknown>;
|
|
94
|
-
}
|
|
95
|
-
/**
|
|
96
|
-
* Arguments for the 'viewer.publish-event' command.
|
|
97
|
-
*/
|
|
98
|
-
export interface PublishEventArgs {
|
|
99
|
-
/**
|
|
100
|
-
* The name of the event to be published.
|
|
101
|
-
*/
|
|
102
|
-
name: string;
|
|
103
|
-
/**
|
|
104
|
-
* The event arguments to be used when publishing the event.
|
|
105
|
-
*/
|
|
106
|
-
arguments: EntityProperties;
|
|
107
|
-
}
|
|
108
|
-
/**
|
|
109
|
-
* An orientation for the layout.
|
|
110
|
-
*/
|
|
111
|
-
export type Orientation = "portrait" | "landscape";
|
|
112
|
-
/**
|
|
113
|
-
* Result of the "viewer.get-capabilities" operation.
|
|
114
|
-
*/
|
|
115
|
-
export interface ViewerCapabilities {
|
|
116
|
-
/**
|
|
117
|
-
* The height of the viewer's host element in pixels.
|
|
118
|
-
*/
|
|
119
|
-
height: number;
|
|
120
|
-
/**
|
|
121
|
-
* The width of the viewer's host element in pixels.
|
|
122
|
-
*/
|
|
123
|
-
width: number;
|
|
124
|
-
/**
|
|
125
|
-
* The aspect ratio of the viewer's host element (width / height).
|
|
126
|
-
*/
|
|
127
|
-
aspectRatio: number;
|
|
128
|
-
/**
|
|
129
|
-
* The orientation of the viewer's host element. The orientation is portrait
|
|
130
|
-
* if height >= width.
|
|
131
|
-
*/
|
|
132
|
-
orientation: Orientation;
|
|
133
|
-
/**
|
|
134
|
-
* Whether the device supports touch.
|
|
135
|
-
*/
|
|
136
|
-
supportsTouch: boolean;
|
|
137
|
-
/**
|
|
138
|
-
* Whether the device supports a pointer (e.g. mouse).
|
|
139
|
-
*/
|
|
140
|
-
supportsPointer: boolean;
|
|
141
|
-
/**
|
|
142
|
-
* Whether the device supports hover.
|
|
143
|
-
*/
|
|
144
|
-
supportsHover: boolean;
|
|
145
|
-
}
|
|
1
|
+
import type { EntityProperties } from "@vertigis/arcgis-extensions/Entity";
|
|
2
|
+
import type { Command } from "../Command.js";
|
|
3
|
+
import { CommandRegistry } from "../CommandRegistry.js";
|
|
4
|
+
import type { Event } from "../Event.js";
|
|
5
|
+
import { EventRegistry } from "../EventRegistry.js";
|
|
6
|
+
import type { Operation } from "../Operation.js";
|
|
7
|
+
import { OperationRegistry } from "../OperationRegistry.js";
|
|
8
|
+
import type { Model } from "../common.js";
|
|
9
|
+
export declare class ViewerCommands extends CommandRegistry {
|
|
10
|
+
protected readonly _prefix = "viewer";
|
|
11
|
+
/**
|
|
12
|
+
* Loads a new layout. Can be a layout URL or layout XML, or a Layout
|
|
13
|
+
* object. Web only.
|
|
14
|
+
*
|
|
15
|
+
* @webOnly
|
|
16
|
+
*/
|
|
17
|
+
get loadLayout(): Command<string | Model>;
|
|
18
|
+
/**
|
|
19
|
+
* Writes the operation context object to the console or log viewer at the
|
|
20
|
+
* debug level.
|
|
21
|
+
*/
|
|
22
|
+
get logDebug(): Command<unknown>;
|
|
23
|
+
/**
|
|
24
|
+
* Post a message to the parent frame of the viewer. Web only.
|
|
25
|
+
*
|
|
26
|
+
* @webOnly
|
|
27
|
+
*/
|
|
28
|
+
get postMessage(): Command<unknown>;
|
|
29
|
+
/**
|
|
30
|
+
* Publish an event with specified parameters "name" and "arguments". This
|
|
31
|
+
* command supports sending custom events (i.e. you use your own namespaced
|
|
32
|
+
* eventname) as well as built-in events. Mobile only.
|
|
33
|
+
*
|
|
34
|
+
* @mobileOnly
|
|
35
|
+
*/
|
|
36
|
+
get publishEvent(): Command<PublishEventArgs>;
|
|
37
|
+
/**
|
|
38
|
+
* Turn the debug mode of the viewer on or off. This can also be done using
|
|
39
|
+
* the debug=true URL parameter. Web only.
|
|
40
|
+
*
|
|
41
|
+
* @webOnly
|
|
42
|
+
*/
|
|
43
|
+
get setDebugMode(): Command<boolean>;
|
|
44
|
+
}
|
|
45
|
+
export declare class ViewerEvents extends EventRegistry {
|
|
46
|
+
protected readonly _prefix = "viewer";
|
|
47
|
+
/**
|
|
48
|
+
* Raised when the viewer finishes loading a layout. Web only.
|
|
49
|
+
*
|
|
50
|
+
* @webOnly
|
|
51
|
+
*/
|
|
52
|
+
get layoutChanged(): Event;
|
|
53
|
+
}
|
|
54
|
+
export declare class ViewerOperations extends OperationRegistry {
|
|
55
|
+
protected readonly _prefix = "viewer";
|
|
56
|
+
/**
|
|
57
|
+
* Gets all Layout models from the application. Web only.
|
|
58
|
+
*
|
|
59
|
+
* @webOnly
|
|
60
|
+
*/
|
|
61
|
+
get getAllLayouts(): Operation<void, Model[]>;
|
|
62
|
+
/**
|
|
63
|
+
* Gets the current Layout model from the application. Web only.
|
|
64
|
+
*
|
|
65
|
+
* @webOnly
|
|
66
|
+
*/
|
|
67
|
+
get getCurrentLayout(): Operation<void, Model>;
|
|
68
|
+
/**
|
|
69
|
+
* Gets information about the current viewer instance. Web only.
|
|
70
|
+
*
|
|
71
|
+
* @webOnly
|
|
72
|
+
*/
|
|
73
|
+
get getCapabilities(): Operation<void, ViewerCapabilities>;
|
|
74
|
+
/**
|
|
75
|
+
* Get whether the viewer is in debug mode. Web only.
|
|
76
|
+
*
|
|
77
|
+
* @webOnly
|
|
78
|
+
*/
|
|
79
|
+
get getInDebugMode(): Operation<void, boolean>;
|
|
80
|
+
/**
|
|
81
|
+
* Gets the version of the viewer. (i.e. the current version of web). Web
|
|
82
|
+
* only.
|
|
83
|
+
*
|
|
84
|
+
* @webOnly
|
|
85
|
+
*/
|
|
86
|
+
get getVersion(): Operation<void, string>;
|
|
87
|
+
/**
|
|
88
|
+
* Post a message to the parent frame of the viewer and await the reply. Web
|
|
89
|
+
* only.
|
|
90
|
+
*
|
|
91
|
+
* @webOnly
|
|
92
|
+
*/
|
|
93
|
+
get postMessageAwaitReply(): Operation<unknown, unknown>;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Arguments for the 'viewer.publish-event' command.
|
|
97
|
+
*/
|
|
98
|
+
export interface PublishEventArgs {
|
|
99
|
+
/**
|
|
100
|
+
* The name of the event to be published.
|
|
101
|
+
*/
|
|
102
|
+
name: string;
|
|
103
|
+
/**
|
|
104
|
+
* The event arguments to be used when publishing the event.
|
|
105
|
+
*/
|
|
106
|
+
arguments: EntityProperties;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* An orientation for the layout.
|
|
110
|
+
*/
|
|
111
|
+
export type Orientation = "portrait" | "landscape";
|
|
112
|
+
/**
|
|
113
|
+
* Result of the "viewer.get-capabilities" operation.
|
|
114
|
+
*/
|
|
115
|
+
export interface ViewerCapabilities {
|
|
116
|
+
/**
|
|
117
|
+
* The height of the viewer's host element in pixels.
|
|
118
|
+
*/
|
|
119
|
+
height: number;
|
|
120
|
+
/**
|
|
121
|
+
* The width of the viewer's host element in pixels.
|
|
122
|
+
*/
|
|
123
|
+
width: number;
|
|
124
|
+
/**
|
|
125
|
+
* The aspect ratio of the viewer's host element (width / height).
|
|
126
|
+
*/
|
|
127
|
+
aspectRatio: number;
|
|
128
|
+
/**
|
|
129
|
+
* The orientation of the viewer's host element. The orientation is portrait
|
|
130
|
+
* if height >= width.
|
|
131
|
+
*/
|
|
132
|
+
orientation: Orientation;
|
|
133
|
+
/**
|
|
134
|
+
* Whether the device supports touch.
|
|
135
|
+
*/
|
|
136
|
+
supportsTouch: boolean;
|
|
137
|
+
/**
|
|
138
|
+
* Whether the device supports a pointer (e.g. mouse).
|
|
139
|
+
*/
|
|
140
|
+
supportsPointer: boolean;
|
|
141
|
+
/**
|
|
142
|
+
* Whether the device supports hover.
|
|
143
|
+
*/
|
|
144
|
+
supportsHover: boolean;
|
|
145
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export class ViewerCommands extends e{
|
|
1
|
+
import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export class ViewerCommands extends e{_prefix="viewer";get loadLayout(){return this._get("load-layout")}get logDebug(){return this._get("log-debug")}get postMessage(){return this._get("post-message")}get publishEvent(){return this._get("publish-event")}get setDebugMode(){return this._get("set-debug-mode")}}export class ViewerEvents extends t{_prefix="viewer";get layoutChanged(){return this._get("layout-changed")}}export class ViewerOperations extends r{_prefix="viewer";get getAllLayouts(){return this._get("get-all-layouts")}get getCurrentLayout(){return this._get("get-current-layout")}get getCapabilities(){return this._get("get-capabilities")}get getInDebugMode(){return this._get("get-in-debug-mode")}get getVersion(){return this._get("get-version")}get postMessageAwaitReply(){return this._get("post-message-await-reply")}}
|
|
@@ -1,170 +1,170 @@
|
|
|
1
|
-
import type { Command } from "../Command.js";
|
|
2
|
-
import { CommandRegistry } from "../CommandRegistry.js";
|
|
3
|
-
import type { Event } from "../Event.js";
|
|
4
|
-
import { EventRegistry } from "../EventRegistry.js";
|
|
5
|
-
import type { Operation } from "../Operation.js";
|
|
6
|
-
import { OperationRegistry } from "../OperationRegistry.js";
|
|
7
|
-
import type { MapsLike } from "../common.js";
|
|
8
|
-
interface ExecuteWorkflowArgs {
|
|
9
|
-
/**
|
|
10
|
-
* The ID of the workflow item in app config.
|
|
11
|
-
*/
|
|
12
|
-
id: string;
|
|
13
|
-
/**
|
|
14
|
-
* The title of the workflow.
|
|
15
|
-
*/
|
|
16
|
-
title?: string;
|
|
17
|
-
/**
|
|
18
|
-
* An icon to display for the workflow.
|
|
19
|
-
*/
|
|
20
|
-
icon?: string;
|
|
21
|
-
/**
|
|
22
|
-
* The inputs to be passed into the workflow.
|
|
23
|
-
*/
|
|
24
|
-
inputs?: {
|
|
25
|
-
[index: string]: unknown;
|
|
26
|
-
};
|
|
27
|
-
/**
|
|
28
|
-
* The workflow input that the command's context will map to.
|
|
29
|
-
*/
|
|
30
|
-
commandArgumentInput?: string;
|
|
31
|
-
/**
|
|
32
|
-
* A unique Id to identify an instance of this workflow running.
|
|
33
|
-
*/
|
|
34
|
-
instanceId?: string;
|
|
35
|
-
/**
|
|
36
|
-
* The map to target, if omitted Web will attempt to choose the best map for
|
|
37
|
-
* you. Web only.
|
|
38
|
-
*
|
|
39
|
-
* @webOnly
|
|
40
|
-
*/
|
|
41
|
-
maps?: MapsLike;
|
|
42
|
-
/**
|
|
43
|
-
* The layout ID of the workflow component to use for any workflow forms, or
|
|
44
|
-
* the ID of a container component like taskbar, panel, stack, etc. In the
|
|
45
|
-
* latter case, a new workflow component will be created dynamically as a
|
|
46
|
-
* child of the targeted container, and removed when the workflow finishes
|
|
47
|
-
* running.
|
|
48
|
-
*/
|
|
49
|
-
target?: string;
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Arguments for the workflow.run command.
|
|
53
|
-
*/
|
|
54
|
-
export interface RunWorkflowArgs extends ExecuteWorkflowArgs {
|
|
55
|
-
/**
|
|
56
|
-
* Whether or not the workflow should be executed asynchronously. If this
|
|
57
|
-
* property is true, the workflow will be executed but the command will not
|
|
58
|
-
* wait for it to finish. Defaults to false. Web only.
|
|
59
|
-
*
|
|
60
|
-
* @webOnly
|
|
61
|
-
*/
|
|
62
|
-
async?: boolean;
|
|
63
|
-
}
|
|
64
|
-
/**
|
|
65
|
-
* Arguments for the workflow.evaluate command.
|
|
66
|
-
*/
|
|
67
|
-
export interface EvaluateWorkflowArgs extends ExecuteWorkflowArgs {
|
|
68
|
-
}
|
|
69
|
-
interface WorkflowModel {
|
|
70
|
-
}
|
|
71
|
-
/**
|
|
72
|
-
* Base arguments for various Workflow-related events.
|
|
73
|
-
*/
|
|
74
|
-
export interface WorkflowEventBase {
|
|
75
|
-
/**
|
|
76
|
-
* The workflow pertaining to the event.
|
|
77
|
-
*/
|
|
78
|
-
workflow: WorkflowModel;
|
|
79
|
-
}
|
|
80
|
-
/**
|
|
81
|
-
* Arguments for the "workflow.workflow-error" event.
|
|
82
|
-
*/
|
|
83
|
-
export interface WorkflowErrorEventArgs extends WorkflowEventBase {
|
|
84
|
-
/**
|
|
85
|
-
* The human readable error message.
|
|
86
|
-
*/
|
|
87
|
-
errorMessage?: string;
|
|
88
|
-
/**
|
|
89
|
-
* The Error object containing detailed information about the error.
|
|
90
|
-
*/
|
|
91
|
-
exception?: Error;
|
|
92
|
-
}
|
|
93
|
-
/**
|
|
94
|
-
* Arguments for the "workflow.workflow-started" event.
|
|
95
|
-
*/
|
|
96
|
-
export interface WorkflowStartedEventArgs extends WorkflowEventBase {
|
|
97
|
-
}
|
|
98
|
-
/**
|
|
99
|
-
* Arguments for the "workflow.workflow-starting" event.
|
|
100
|
-
*/
|
|
101
|
-
export interface WorkflowStartingEventArgs extends WorkflowEventBase {
|
|
102
|
-
}
|
|
103
|
-
/**
|
|
104
|
-
* Arguments for the "workflow.workflow-finished" event.
|
|
105
|
-
*/
|
|
106
|
-
export interface WorkflowFinishedEventArgs extends WorkflowEventBase {
|
|
107
|
-
}
|
|
108
|
-
export declare class WorkflowCommands extends CommandRegistry {
|
|
109
|
-
protected readonly _prefix = "workflow";
|
|
110
|
-
/**
|
|
111
|
-
* Runs a workflow with the given arguments. See the `workflow.evaluate`
|
|
112
|
-
* operation if you want to run a workflow and expect output values to be
|
|
113
|
-
* returned.
|
|
114
|
-
*/
|
|
115
|
-
get run(): Command<RunWorkflowArgs>;
|
|
116
|
-
/**
|
|
117
|
-
* Refreshes (i.e. cancels and reruns) a workflow with the specified ID
|
|
118
|
-
* (corresponding to the workflow ID as configured in app.json, not the
|
|
119
|
-
* workflow's portal item ID). Mobile only.
|
|
120
|
-
*
|
|
121
|
-
* @mobileOnly
|
|
122
|
-
*/
|
|
123
|
-
get refresh(): Command<string>;
|
|
124
|
-
/**
|
|
125
|
-
* Cancels a workflow with the given ID. Mobile only.
|
|
126
|
-
*
|
|
127
|
-
* @mobileOnly
|
|
128
|
-
*/
|
|
129
|
-
get cancel(): Command<string>;
|
|
130
|
-
/**
|
|
131
|
-
* Cancels all running workflows. Mobile only.
|
|
132
|
-
*
|
|
133
|
-
* @mobileOnly
|
|
134
|
-
*/
|
|
135
|
-
get cancelAll(): Command;
|
|
136
|
-
}
|
|
137
|
-
export declare class WorkflowOperations extends OperationRegistry {
|
|
138
|
-
protected readonly _prefix = "workflow";
|
|
139
|
-
/**
|
|
140
|
-
* Runs a workflow with the given arguments and returns the workflow's
|
|
141
|
-
* output as the result of the operation. The output in the workflow is set
|
|
142
|
-
* using the "Set Workflow Output" activity. See the "workflow.run" command
|
|
143
|
-
* if you want to run a workflow without any output values.
|
|
144
|
-
*/
|
|
145
|
-
get evaluate(): Operation<EvaluateWorkflowArgs, Record<string, unknown>>;
|
|
146
|
-
}
|
|
147
|
-
export declare class WorkflowEvents extends EventRegistry {
|
|
148
|
-
protected readonly _prefix = "workflow";
|
|
149
|
-
/**
|
|
150
|
-
* Raised when a workflow has started running. Web only.
|
|
151
|
-
*
|
|
152
|
-
* @webOnly
|
|
153
|
-
*/
|
|
154
|
-
get workflowStarted(): Event<WorkflowStartedEventArgs>;
|
|
155
|
-
/**
|
|
156
|
-
* Raised when a workflow is about to start. Mobile only.
|
|
157
|
-
*
|
|
158
|
-
* @mobileOnly
|
|
159
|
-
*/
|
|
160
|
-
get starting(): Event<WorkflowStartingEventArgs>;
|
|
161
|
-
/**
|
|
162
|
-
* Raised when a workflow finishes running.
|
|
163
|
-
*/
|
|
164
|
-
get workflowFinished(): Event<WorkflowFinishedEventArgs>;
|
|
165
|
-
/**
|
|
166
|
-
* Raised when an error occurs while running a workflow.
|
|
167
|
-
*/
|
|
168
|
-
get workflowError(): Event<WorkflowErrorEventArgs>;
|
|
169
|
-
}
|
|
170
|
-
export {};
|
|
1
|
+
import type { Command } from "../Command.js";
|
|
2
|
+
import { CommandRegistry } from "../CommandRegistry.js";
|
|
3
|
+
import type { Event } from "../Event.js";
|
|
4
|
+
import { EventRegistry } from "../EventRegistry.js";
|
|
5
|
+
import type { Operation } from "../Operation.js";
|
|
6
|
+
import { OperationRegistry } from "../OperationRegistry.js";
|
|
7
|
+
import type { MapsLike } from "../common.js";
|
|
8
|
+
interface ExecuteWorkflowArgs {
|
|
9
|
+
/**
|
|
10
|
+
* The ID of the workflow item in app config.
|
|
11
|
+
*/
|
|
12
|
+
id: string;
|
|
13
|
+
/**
|
|
14
|
+
* The title of the workflow.
|
|
15
|
+
*/
|
|
16
|
+
title?: string;
|
|
17
|
+
/**
|
|
18
|
+
* An icon to display for the workflow.
|
|
19
|
+
*/
|
|
20
|
+
icon?: string;
|
|
21
|
+
/**
|
|
22
|
+
* The inputs to be passed into the workflow.
|
|
23
|
+
*/
|
|
24
|
+
inputs?: {
|
|
25
|
+
[index: string]: unknown;
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* The workflow input that the command's context will map to.
|
|
29
|
+
*/
|
|
30
|
+
commandArgumentInput?: string;
|
|
31
|
+
/**
|
|
32
|
+
* A unique Id to identify an instance of this workflow running.
|
|
33
|
+
*/
|
|
34
|
+
instanceId?: string;
|
|
35
|
+
/**
|
|
36
|
+
* The map to target, if omitted Web will attempt to choose the best map for
|
|
37
|
+
* you. Web only.
|
|
38
|
+
*
|
|
39
|
+
* @webOnly
|
|
40
|
+
*/
|
|
41
|
+
maps?: MapsLike;
|
|
42
|
+
/**
|
|
43
|
+
* The layout ID of the workflow component to use for any workflow forms, or
|
|
44
|
+
* the ID of a container component like taskbar, panel, stack, etc. In the
|
|
45
|
+
* latter case, a new workflow component will be created dynamically as a
|
|
46
|
+
* child of the targeted container, and removed when the workflow finishes
|
|
47
|
+
* running.
|
|
48
|
+
*/
|
|
49
|
+
target?: string;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Arguments for the workflow.run command.
|
|
53
|
+
*/
|
|
54
|
+
export interface RunWorkflowArgs extends ExecuteWorkflowArgs {
|
|
55
|
+
/**
|
|
56
|
+
* Whether or not the workflow should be executed asynchronously. If this
|
|
57
|
+
* property is true, the workflow will be executed but the command will not
|
|
58
|
+
* wait for it to finish. Defaults to false. Web only.
|
|
59
|
+
*
|
|
60
|
+
* @webOnly
|
|
61
|
+
*/
|
|
62
|
+
async?: boolean;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Arguments for the workflow.evaluate command.
|
|
66
|
+
*/
|
|
67
|
+
export interface EvaluateWorkflowArgs extends ExecuteWorkflowArgs {
|
|
68
|
+
}
|
|
69
|
+
interface WorkflowModel {
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Base arguments for various Workflow-related events.
|
|
73
|
+
*/
|
|
74
|
+
export interface WorkflowEventBase {
|
|
75
|
+
/**
|
|
76
|
+
* The workflow pertaining to the event.
|
|
77
|
+
*/
|
|
78
|
+
workflow: WorkflowModel;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Arguments for the "workflow.workflow-error" event.
|
|
82
|
+
*/
|
|
83
|
+
export interface WorkflowErrorEventArgs extends WorkflowEventBase {
|
|
84
|
+
/**
|
|
85
|
+
* The human readable error message.
|
|
86
|
+
*/
|
|
87
|
+
errorMessage?: string;
|
|
88
|
+
/**
|
|
89
|
+
* The Error object containing detailed information about the error.
|
|
90
|
+
*/
|
|
91
|
+
exception?: Error;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Arguments for the "workflow.workflow-started" event.
|
|
95
|
+
*/
|
|
96
|
+
export interface WorkflowStartedEventArgs extends WorkflowEventBase {
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Arguments for the "workflow.workflow-starting" event.
|
|
100
|
+
*/
|
|
101
|
+
export interface WorkflowStartingEventArgs extends WorkflowEventBase {
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Arguments for the "workflow.workflow-finished" event.
|
|
105
|
+
*/
|
|
106
|
+
export interface WorkflowFinishedEventArgs extends WorkflowEventBase {
|
|
107
|
+
}
|
|
108
|
+
export declare class WorkflowCommands extends CommandRegistry {
|
|
109
|
+
protected readonly _prefix = "workflow";
|
|
110
|
+
/**
|
|
111
|
+
* Runs a workflow with the given arguments. See the `workflow.evaluate`
|
|
112
|
+
* operation if you want to run a workflow and expect output values to be
|
|
113
|
+
* returned.
|
|
114
|
+
*/
|
|
115
|
+
get run(): Command<RunWorkflowArgs>;
|
|
116
|
+
/**
|
|
117
|
+
* Refreshes (i.e. cancels and reruns) a workflow with the specified ID
|
|
118
|
+
* (corresponding to the workflow ID as configured in app.json, not the
|
|
119
|
+
* workflow's portal item ID). Mobile only.
|
|
120
|
+
*
|
|
121
|
+
* @mobileOnly
|
|
122
|
+
*/
|
|
123
|
+
get refresh(): Command<string>;
|
|
124
|
+
/**
|
|
125
|
+
* Cancels a workflow with the given ID. Mobile only.
|
|
126
|
+
*
|
|
127
|
+
* @mobileOnly
|
|
128
|
+
*/
|
|
129
|
+
get cancel(): Command<string>;
|
|
130
|
+
/**
|
|
131
|
+
* Cancels all running workflows. Mobile only.
|
|
132
|
+
*
|
|
133
|
+
* @mobileOnly
|
|
134
|
+
*/
|
|
135
|
+
get cancelAll(): Command;
|
|
136
|
+
}
|
|
137
|
+
export declare class WorkflowOperations extends OperationRegistry {
|
|
138
|
+
protected readonly _prefix = "workflow";
|
|
139
|
+
/**
|
|
140
|
+
* Runs a workflow with the given arguments and returns the workflow's
|
|
141
|
+
* output as the result of the operation. The output in the workflow is set
|
|
142
|
+
* using the "Set Workflow Output" activity. See the "workflow.run" command
|
|
143
|
+
* if you want to run a workflow without any output values.
|
|
144
|
+
*/
|
|
145
|
+
get evaluate(): Operation<EvaluateWorkflowArgs, Record<string, unknown>>;
|
|
146
|
+
}
|
|
147
|
+
export declare class WorkflowEvents extends EventRegistry {
|
|
148
|
+
protected readonly _prefix = "workflow";
|
|
149
|
+
/**
|
|
150
|
+
* Raised when a workflow has started running. Web only.
|
|
151
|
+
*
|
|
152
|
+
* @webOnly
|
|
153
|
+
*/
|
|
154
|
+
get workflowStarted(): Event<WorkflowStartedEventArgs>;
|
|
155
|
+
/**
|
|
156
|
+
* Raised when a workflow is about to start. Mobile only.
|
|
157
|
+
*
|
|
158
|
+
* @mobileOnly
|
|
159
|
+
*/
|
|
160
|
+
get starting(): Event<WorkflowStartingEventArgs>;
|
|
161
|
+
/**
|
|
162
|
+
* Raised when a workflow finishes running.
|
|
163
|
+
*/
|
|
164
|
+
get workflowFinished(): Event<WorkflowFinishedEventArgs>;
|
|
165
|
+
/**
|
|
166
|
+
* Raised when an error occurs while running a workflow.
|
|
167
|
+
*/
|
|
168
|
+
get workflowError(): Event<WorkflowErrorEventArgs>;
|
|
169
|
+
}
|
|
170
|
+
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{CommandRegistry as
|
|
1
|
+
import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as r}from"../EventRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export class WorkflowCommands extends e{_prefix="workflow";get run(){return this._get("run")}get refresh(){return this._get("refresh")}get cancel(){return this._get("cancel")}get cancelAll(){return this._get("cancel-all")}}export class WorkflowOperations extends t{_prefix="workflow";get evaluate(){return this._get("evaluate")}}export class WorkflowEvents extends r{_prefix="workflow";get workflowStarted(){return this._get("workflow-started")}get starting(){return this._get("starting")}get workflowFinished(){return this._get("workflow-finished")}get workflowError(){return this._get("workflow-error")}}
|