VersionManagementViewModel | References | ArcGIS Maps SDK for JavaScript

import VersionManagementViewModel from "@arcgis/core/widgets/VersionManagement/VersionManagementViewModel.js";

Inheritance:: VersionManagementViewModel→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.29

This class allows you to manage versions from a variety of feature services. The VersionManagementViewModel allows you to alter, create, delete versions etc. provided that a featureServiceUrl is provided for these operations.

See also

Example

const webMap = new WebMap({
    portalItem: {
    id: "webmapID"
  }
});

const view = new MapView({
    map: webMap
});

featureLayer = new FeatureLayer({
    url: "https://myHostName.domain.com/arcgis/rest/services/TestService_11_2/FeatureServer/0",
});

webMap.layers.add(featureLayer);

const viewModel = new VersionManagementViewModel({ view });
await whenOnce(() => viewModel.state === "ready");

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`VersionManagementViewModelProperties`

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

Properties

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

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`executionError` readonly	`VersionManagementViewModelExecutionError \| null \| undefined`
`featureServiceLookup`	`Map<string, FeatureServiceResourcesBundle>`
`loadError` readonly	`VersionManagementViewModelLoadError \| null \| undefined`
`serverVersionLookup`	`Map<string, number>`
`serviceNameLookup`	`Map<string, string>`
`state` readonly	`VersionManagementViewModelState`
`userLookup`	`Map<string, string>`
`versionAdministratorLookup`	`Map<string, boolean>`
`versioningStateLookup`	`Map<string, VersioningState>`
`versioningStates`	`Collection<VersioningState>`
`view`	`MapView`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

executionError

readonly Property

Type: VersionManagementViewModelExecutionError | null | undefined

Displays execution errors.

featureServiceLookup

Property

Type: Map<string, FeatureServiceResourcesBundle>

A key-value pair of FeatureServiceResourcesBundle.

loadError

readonly Property

Type: VersionManagementViewModelLoadError | null | undefined

Displays an error if loading fails.

serverVersionLookup

Property

Type: Map<string, number>

Map of Service URLs and enterprise versions.

serviceNameLookup

Property

Type: Map<string, string>

Map of Service URLs and service names. Keeps track of all the FeatureService instances in the VersionManagementService class instance.

state

readonly Property

Type: VersionManagementViewModelState

The viewModel's state.

userLookup

Property

Type: Map<string, string>

Map of Service URLs and logged in users .

versionAdministratorLookup

Property

Type: Map<string, boolean>

This property determines if a user has version admin privileges.

versioningStateLookup

Property

Type: Map<string, VersioningState>

This property contains metadata about the versioning state.

versioningStates

Property

Type: Collection<VersioningState>

view

Property

Type: MapView

The view from which the widget will operate.

Methods

Method	Signature	Class
`alterVersion`	`alterVersion(parameters: AlterVersionParameters): Promise<boolean>`
`changeVersion`	`changeVersion(featureServerUrl: string, toVersionName: string, toVersionGuid: string): Promise<Map<VersionAdapter, ServiceResult>>`
`createVersion`	`createVersion(parameters: CreateVersionParameters): Promise<VersionInfoExtendedJSON>`
`deleteVersion`	`deleteVersion(featureServerUrl: string, versionName: string, versionGuid: string): Promise<boolean>`
`getVersionInfos`	`getVersionInfos(featureServerUrl: string): Promise<VersionInfo[]>`

alterVersion

Method

Signature: alterVersion (parameters: AlterVersionParameters): 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.

Parameters

Parameter	Type	Description	Required
parameters	`AlterVersionParameters`	Parameters used to alter a version.

Returns: Promise<boolean>
When resolved, returns true if the alter operation completes successfully.

Example

await versionManagementViewModel.alterVersion({
  featureServiceUrl: "https://myHostName.domain.com/arcgis/rest/services/TestService_11_2/FeatureServer/0",
  versionIdentifier: {
  guid: myVersion.versionIdentifier.guid,
  name: myVersion.versionIdentifier.name,
},
  versionName: "updatedVersionName"
});

changeVersion

Method

Signature: changeVersion (featureServerUrl: string, toVersionName: string, toVersionGuid: string): Promise<Map<VersionAdapter, ServiceResult>>

Method used to change a version using a featureServerUrl, name, and guid of a version.

Parameters

Parameter	Type	Description
featureServerUrl	`string`	The url of a feature service.
toVersionName	`string`	Incoming version name.
toVersionGuid	`string`	Incoming version guid.

Returns: Promise<Map<VersionAdapter, ServiceResult>>
When resolved, returns a map of version adapter to result.

Example

await versionManagementViewModel.changeVersion(
   "https://myHostName.domain.com/arcgis/rest/services/TestService_11_2/FeatureServer/0",
   "incomingVersionName",
   "incomingVersionGuid"
 )

createVersion

Method

Signature: createVersion (parameters: CreateVersionParameters): Promise<VersionInfoExtendedJSON>

Creates a new version given the following parameters.

Parameters

Parameter	Type	Description	Required
parameters	`CreateVersionParameters`	Parameters used to create a new version.

Returns: Promise<VersionInfoExtendedJSON>
When the promise is resolved, the VersionInfoExtendedJSON will be returned once the create operation is successfully completed.

Example

await viewModel.createVersion({
    featureServerUrl: "https://myHostName.domain.com/arcgis/rest/services/TestService_11_2/FeatureServer/0",
    versionName: "NewVersionName",
    description: "New Version Description",
    access: "public",
});

deleteVersion

Method

Signature: deleteVersion (featureServerUrl: string, versionName: string, versionGuid: string): 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.

Parameters

Parameter	Type	Description
featureServerUrl	`string`	The url of a feature service.
versionName	`string`	The name of the version that is to be deleted.
versionGuid	`string`	The guid of the version that is to be deleted.

Returns: Promise<boolean>
When resolved, returns true if the delete operation completes successfully.

Example

await versionManagementViewModel.deleteVersion(
  "https://myHostName.domain.com/arcgis/rest/services/TestService_11_2/FeatureServer/0",
  "versionName",
  "{45A4CF5B-69FB-4D94-96F7-25F92EB4C0EC}"
);

getVersionInfos

Method

Signature: getVersionInfos (featureServerUrl: string): Promise<VersionInfo[]>

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

Parameters

Parameter	Type	Description	Required
featureServerUrl	`string`	The url of a feature service.

Returns: Promise<VersionInfo[]>
When resolved, returns an array of VersionInfo.

Example

const versionInfos = await versionManagementViewModel.getVersionInfos("https://myHostName.domain.com/arcgis/rest/services/TestService_11_2/FeatureServer/0");