Workflow

Property Overview

Property Details

data CreateWorkflowData|CreateFeaturesWorkflowData|UpdateWorkflowDatareadonly

The shared workflow data. This can be either CreateFeaturesWorkflowData (use this in place of the deprecated CreateWorkflowData) or UpdateWorkflowData.

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

hasNextStep Booleanreadonly

This property indicates whether there is a next step in the workflow.

hasPreviousStep Booleanreadonly

This property indicates if there is a previous step in the workflow.

started Booleanreadonly

Indicates whether the workflow is considered active.

Default Value:false

stepId Stringreadonly

The name of the current step in the workflow.

type Stringreadonly

Value indicating the workflow type.

Possible Value	Description
create	This allows the end user to create a new individual feature in the feature service. (deprecated as of 4.23, use create-features as noted below.)
create-features	This allows the end user to create either individual or continuous features in the feature service. (Since 4.23)
update	This allows the end user to update and/or delete features in the feature service.

These workflows are only enabled if the feature service allows these operations.

Possible Values:"create"|"create-features"|"update"

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

groupKey * optional Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

cancel(options){Promise<void>}

Cancels the active workflow.

Parameters

Specification

options Object optional An object with the following properties. Specification error Error optional The returned Error object. force Boolean optional Indicates whether to force cancel the active workflow. notify Boolean optional Indicates whether to display a prompt indicating canceling the active workflow.

Returns

Type	Description
Promise<void>	Resolves when the active workflow is canceled.

commit(){Promise<void>}

Since: ArcGIS Maps SDK for JavaScript 4.15

Call this method when the workflow is considered finished. This is used to help process the editing results.

Returns

Type	Description
Promise<void>	Resolves when the active workflow commits and processes the edited results.

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter

groupKey * optional A group key.

Returns

Type	Description
Boolean	Returns true if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

next(){Promise<void>}

Moves to the next step in the workflow.

Returns

Type	Description
Promise<void>	Resolves when moved to the next step within the active workflow.

previous(options){Promise<void>}

Moves to the previous step in the workflow.

Parameters

options Object optional Options when calling this method. Specification cancelCurrentStep Boolean Cancels the current workflow when calling this method. Default value is false.

Returns

Type	Description
Promise<void>	Resolves when moved to the previous step within the active workflow.

removeHandles(groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter

groupKey * optional A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

reset(){Promise<void>}

Resets the workflow.

Returns

Type	Description
Promise<void>	Resolves when the active workflow is reset.

start(){Promise<void>}

Starts the workflow.

Returns

Type	Description
Promise<void>	Resolves when the active workflow starts.