VersioningState | API Reference | ArcGIS Maps SDK for JavaScript

This class provides functionality for managing versions in a versioned geodatabase. It includes methods for starting and stopping editing, changing versions, undoing and redoing edits, and retrieving version information.

See also

Example

const [utils, WebMap] = await $arcgis.import([
  "@arcgis/core/versionManagement/versionAdapters/utils.js",
  "@arcgis/core/WebMap.js"
]);
const webmap = new WebMap({
  portalItem: { // autocasts as new PortalItem()
    id: "e691172598f04ea8881cd2a4adaa45ba"
  }
});
const versioningStates = await utils.createVersioningStates(webmap, false);

Constructors

VersioningState Constructor new VersioningState(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Type	Summary	Class
VersionIdentifier\|Date	The current version.	VersioningState
VersionInfo\|null\|undefined	Contains information on the current version.	VersioningState
VersionIdentifier	Contains the default version's name and guid.	VersioningState
String	The absolute URL of the REST endpoint for the feature service housing the version management service.	VersioningState
Boolean	If true, current version is the default version.	VersioningState
Error\|null\|undefined	The Error object returned if an error occurred while loading.	VersioningState
String	Represents the status of a load operation.	VersioningState
Object []	A list of warnings which occurred while loading.	VersioningState
Boolean	Indicates whether the instance has loaded.	VersioningState
String	The state of the current version.	VersioningState
String	The absolute URL of the REST endpoint for the version management service.	VersioningState
Boolean	If the set to `true`, the current version will have a read lock.	VersioningState
VersionInfo []	Contains list of all available versions.	VersioningState
VersionManagementService	Contains metadata about the version management service.	VersioningState
Collection<VersionAdapter>	Contains a collection of all versionable in the versioning state class.	VersioningState

Property Details

currentVersion Property currentVersion VersionIdentifier |Date

The current version.

currentVersionInfo Property currentVersionInfo VersionInfo |null |undefined

Contains information on the current version.

defaultVersionIdentifier Property defaultVersionIdentifier VersionIdentifierreadonly

Contains the default version's name and guid.

featureServiceUrl Property featureServiceUrl String

The absolute URL of the REST endpoint for the feature service housing the version management service. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online.

isDefault Property isDefault Booleanreadonly

If true, current version is the default version.

loadError Property loadError Error |null |undefinedreadonly

The Error object returned if an error occurred while loading.

Default Value:null

loadStatus Property loadStatus Stringreadonly

Represents the status of a load operation.

Value	Description
not-loaded	The object's resources have not loaded.
loading	The object's resources are currently loading.
loaded	The object's resources have loaded without errors.
failed	The object's resources failed to load. See loadError for more details.

Possible Values:"not-loaded" |"loading" |"failed" |"loaded"

Default Value:"not-loaded"

loadWarnings Property loadWarnings Object[]readonly

A list of warnings which occurred while loading.

loaded Property loaded Booleanreadonly

Indicates whether the instance has loaded. When true, the properties of the object can be accessed. A WebMap is considered loaded when its layers and basemap are created, but not yet loaded.

Default Value:false

state Property state String

The state of the current version.

Possible Values:"lock-none" |"lock-read" |"lock-write"

url Property url String

The absolute URL of the REST endpoint for the version management service. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online.

usePersistentReadSessions Property usePersistentReadSessions Boolean

If the set to true, the current version will have a read lock. Additionally, when switching versions, the new current version will also have a read lock.

versionInfos Property versionInfos VersionInfo[]

Contains list of all available versions.

versionManagementService Property versionManagementService VersionManagementService

Contains metadata about the version management service.

versionableItems Property versionableItems Collection<VersionAdapter>

Contains a collection of all versionable in the versioning state class.

Method Overview

Return Type	Summary	Class
Promise<Boolean>	The alter operation allows you to change the geodatabase version's name, description, owner, and access permissions.	VersioningState
	Cancels a load() operation if it is already in progress.	VersioningState
Promise<Map<VersionAdapter, ServiceResult>>	Method used to change a layer's version/moment or network's version/moment.	VersioningState
Promise<Boolean>	Deletes a version given the following parameters.	VersioningState
Promise<(VersionInfoExtendedJSON\|null\|undefined)>	Method used to get extended information about a version.	VersioningState
Promise<VersionInfo []>	Returns all versions accessible to the currently logged-in user.	VersioningState
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).	VersioningState
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected.	VersioningState
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved.	VersioningState
Promise	Loads the resources referenced by this class.	VersioningState
Promise	Triggers the loading of the version management service instance.	VersioningState
Promise<ServiceResult>	This method redos the last edit made while in an edit session.	VersioningState
Promise<ServiceResult>	Using the specified session ID an exclusive lock is obtained for the session on the version.	VersioningState
Promise<ServiceResult>	Using the specified session id, the exclusive lock for the version is downgraded to a shared lock.	VersioningState
Promise<ServiceResult>	This method undos the last edit made while in an edit session.	VersioningState
Promise	`when()` may be leveraged once an instance of the class is created.	VersioningState

Method Details

alterVersion Method alterVersion(versionIdentifier, props){Promise<Boolean>}

The alter operation allows you to change the geodatabase version's name, description, owner, and access permissions.

License

This method requires the feature service and version management service to be published with ArcGIS Enterprise version 11.2 or higher.
Organization members must be assigned a license for the ArcGIS Advanced Editing user type extension to use this method.

Parameters

Specification

versionIdentifier VersionIdentifier

Identifier for a version.

props Object

Contains properties that will be altered.

Specification

ownerName String

optional

The new owner name of the version.

versionName String

optional

The new name for the version.

description String

optional

The new description for the version.

access String

optional

The new access permissions of the version.

Possible Values:"hidden"|"private"|"protected"|"public"

Returns

Type	Description
Promise<Boolean>	Returns true if version was altered successfully.

Example

const result = await versioningState.alterVersion(
  { name: "newVersion", guid: "{49C6AC87-CDA8-46D4-A79B-449105981209}" },
  {
    versionName: "versionName",
    ownerName: "newOwner",
    description: "newDescription",
    access: "public"
  }
 );

cancelLoad Method cancelLoad()

Cancels a load() operation if it is already in progress.

changeVersion Method changeVersion(toVersion){Promise<Map<VersionAdapter, ServiceResult>>}

Method used to change a layer's version/moment or network's version/moment. Method allows changing version from named version to named version, or from default version to a moment and vice versa.

Parameter

toVersion Date|VersionIdentifier

Incoming Version or Date.

Returns

Type	Description
Promise<Map<VersionAdapter, ServiceResult>>	Returns a map of VersionAdapter and ServiceResult.

Example

await versioningState.changeVersion(
  { name: "admin.version", guid: "{422D1B63-D795-4478-A4B1-AD6109377074}"}
);

deleteVersion Method deleteVersion(versionIdentifier){Promise<Boolean>}

Deletes a version given the following parameters.

License

This method requires the feature service and version management service to be published with ArcGIS Enterprise version 11.2 or higher.
Organization members must be assigned a license for the ArcGIS Advanced Editing user type extension to use this method.

Parameter

versionIdentifier VersionIdentifier

Identifier for a version.

Returns

Type	Description
Promise<Boolean>	Specifies if the selected version was deleted.

Example

versioningState.deleteVersion({
  name: "versionName",
  guid: "{422D1B63-D795-4478-A4B1-AD6109377075}"
});

getVersionInfoExtended Method getVersionInfoExtended(){Promise<(VersionInfoExtendedJSON|null|undefined)>}

Method used to get extended information about a version.

Returns

Type	Description
Promise<(VersionInfoExtendedJSON\|null\|undefined)>	Contains extended info about given version.

getVersionInfos Method getVersionInfos(refresh){Promise<VersionInfo[]>}

Returns all versions accessible to the currently logged-in user.

Parameter

refresh Boolean

If refresh is true, a new REST call will be made to the server to get the available versions.

Returns

Type	Description
Promise<VersionInfo []>	Contains extended info about given version.

isFulfilled Method isFulfilled(){Boolean}

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected Method isRejected(){Boolean}

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved Method isResolved(){Boolean}

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

load Method load(options){Promise}

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

The load() method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.

It's possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.

Parameters

options Object|null|undefined

optional

Additional options.

Specification

signal AbortSignal|null|undefined

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns

Type	Description
Promise	Resolves when the resources have loaded.

load Method load(options){Promise}

Triggers the loading of the version management service instance.

Fully loads the Version Management Service definition.

Parameters

options Object|null|undefined

optional

Additional options.

Specification

signal AbortSignal|null|undefined

optional

Returns

Type	Description
Promise	Resolves when the Feature Service is loaded.

redo Method redo(){Promise<ServiceResult>}

This method redos the last edit made while in an edit session.

Returns

Type	Description
Promise<ServiceResult>	Specifies if redo was successful.

startEditing Method startEditing(){Promise<ServiceResult>}

Using the specified session ID an exclusive lock is obtained for the session on the version. The exclusive lock can only be obtained if no other shared or exclusive locks are present and the session currently holds a shared lock. The exclusive lock ensures read and write isolation for the session holding the lock. The exclusive lock is downgraded to a shared lock by using the stopEditing operation.

Returns

Type	Description
Promise<ServiceResult>	Specifies if start editing was successful.

Example

await versioningState.startEditing();

stopEditing Method stopEditing(saveEdits){Promise<ServiceResult>}

Using the specified session id, the exclusive lock for the version is downgraded to a shared lock. The saveEdits parameter specifies if the edits for the session should be saved (true) or discarded (false).

Parameter

saveEdits Boolean

If set to true edits will be saved, if false edits will not be saved.

Returns

Type	Description
Promise<ServiceResult>	Specifies if stop editing was successful.

Example

await versioningState.stopEditing(true);

undo Method undo(){Promise<ServiceResult>}

This method undos the last edit made while in an edit session.

Returns

Type	Description
Promise<ServiceResult>	Specifies if undo was successful.

when Method when(onFulfilled, onRejected){Promise}

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a onFulfilled function and an onRejected function. The onFulfilled executes when the instance of the class loads. The onRejected executes if the instance of the class fails to load.

Parameters

onFulfilled Function

optional

The function to call when the promise resolves.

onRejected Function

optional

The function to execute when the promise fails.

Returns

Type	Description
Promise	Returns a new promise for the result of `onFulfilled` that may be used to chain additional functions.

Example

// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Type Definitions

VersionInfo Type Definition VersionInfo Object

This contains basic information about a given version.

Properties

versionIdentifier Object

The identifier of a version.

Specification: name String

The name of the version.

guid String

The guid of a version.

description String

optional

Description of the version.

access String

optional

Access type accepts values of private, public, hidden, and protected.

versionId String

optional

The id of the version that was edited.

creationDate Number

optional

The date the version was created on.

modifiedDate Number

optional

The date when the version was last modified or changed.

reconcileDate Number

optional

The date when the version was last reconciled with the parent version or the default version.

evaluationDate Number

optional

The date when the version was last evaluated for conflicts or discrepancies during the reconciliation process.

previousAncestorDate Number

optional

The date of the most recent ancestor version, if applicable.

commonAncestorDate Number

optional

The date of the common ancestor version, which is the shared ancestor between two or more versions during the reconciliation process.

VersionInfoExtendedJSON Type Definition VersionInfoExtendedJSON Object

This contains extended information about a given version.

Properties

versionIdentifier Object

The identifier of a version.

Specification: name String

The name of the version.

guid String

The guid of a version.

description String

optional

Description of the version.

access String

optional

The access type permissions of the version.

Possible Values:"hidden"|"private"|"protected"|"public"

versionId String

optional

The id of the version that was edited.

creationDate Number

optional

The date the version was created on.

modifiedDate Number

optional

The date when the version was last modified or changed.

reconcileDate Number

optional

The date when the version was last reconciled with the parent version or the default version.

evaluationDate Number

optional

The date when the version was last evaluated for conflicts or discrepancies during the reconciliation process.

previousAncestorDate Number

optional

The date of the most recent ancestor version, if applicable.

commonAncestorDate Number

optional

The date of the common ancestor version, which is the shared ancestor between two or more versions during the reconciliation process.

isBeingEdited Boolean

optional

Specifies if the version is currently being edited.

isBeingRead Boolean

optional

Specifies if the version is currently being read.

hasConflicts Boolean

optional

Specifies if the version is has conflicts.

hasUninspectedConflicts Boolean

optional

Specifies if the version has UninspectedConflicts.

isLocked Boolean

optional

Specifies if the version currently has a lock.

lockOwner String

optional

Specifies which user is the current lock owner.

lockDate Number

optional

Specifies the date at which the version was locked.