UpdateWorkflow | API Reference | ArcGIS Maps SDK for JavaScript 4.33

A read-only class containing the logic used when updating and/or deleting features using the Editor widget.

This workflow is only enabled if the feature service allows this operation.

See also

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
UpdateWorkflowData	The shared workflow data.	UpdateWorkflow
String	The name of the class.	Accessor
Boolean	This property indicates whether there is a next step in the workflow.	Workflow
Boolean	This property indicates if there is a previous step in the workflow.	UpdateWorkflow
Boolean	Indicates whether the workflow is considered active.	Workflow
String	The name of the current step in the workflow.	Workflow
String	The type of workflow.	UpdateWorkflow

Property Details

data Property data UpdateWorkflowDatareadonly Since: ArcGIS Maps SDK for JavaScript 4.30 UpdateWorkflow since 4.15, data added at 4.30.

The shared workflow data.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

hasNextStep Inherited Property hasNextStep Booleanreadonly Inherited from Workflow

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

hasPreviousStep Property hasPreviousStep Booleanreadonly

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

started Inherited Property started Booleanreadonly Inherited from Workflow

Indicates whether the workflow is considered active.

Default Value:false

stepId Inherited Property stepId Stringreadonly Inherited from Workflow

The name of the current step in the workflow.

type Property type Stringreadonly

The type of workflow.

For UpdateWorkflow the type is always "update".

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Promise<void>	Cancels the active workflow.	Workflow
Promise<void>	Call this method when the workflow is considered finished.	Workflow
Boolean	Returns true if a named group of handles exist.	Accessor
Promise<void>	Moves to the next step in the workflow.	Workflow
Promise<void>	Moves to the previous step in the workflow.	Workflow
	Removes a group of handles owned by the object.	Accessor
Promise<void>	Resets the workflow.	Workflow
Promise<any>	Starts the workflow.	Workflow

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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 Inherited Method cancel(options){Promise<void>} Inherited from Workflow

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.

emitCancelEvent 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 Inherited Method commit(){Promise<void>} Inherited from Workflow

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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Inherited Method next(){Promise<void>} Inherited from Workflow

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 Inherited Method previous(options){Promise<void>} Inherited from Workflow

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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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 Inherited Method reset(){Promise<void>} Inherited from Workflow

Resets the workflow.

Returns

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

start Inherited Method start(){Promise<any>} Inherited from Workflow

Starts the workflow.

Returns

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