@esri/hub.js
@esri/hub.js

updateVersion

Function

Updates the specified version with with the state of the supplied model throws an exception if the version is stale and force is not true

Parameters

Parameter Type Default Notes
model Required IModel
version Required IVersion
requestOptions Required IHubUserRequestOptions
force Optional boolean

Available requestOptions

Property Type Notes
authentication UserSession
credentials Optional Inherited RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.
headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.
hideToken Optional Inherited boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.
httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.
hubApiUrl Optional Inherited string
isPortal Optional Inherited boolean
maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
params Optional Inherited IParams

Additional parameters to pass in the request.
portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.
portalSelf Optional Inherited IHubRequestOptionsPortalSelf
rawResponse Optional Inherited boolean

Return the raw response

Returns

Promise<IVersion>
Property Type Notes
data Record<stringany>

The versioned data
created Inherited number

The created timestamp
creator Inherited string

The username of the creator
id Inherited string

The id of the version
path Inherited string

The full path to the version
updated Inherited number

The updated timestamp
access Optional Inherited string

The access level of the version resource
description Optional Inherited string

The description of the version
name Optional Inherited string

The name of the version
parent Optional Inherited string

The parent version id
size Optional Inherited number

The size of the version resource
Function defined in common/src/versioning/updateVersion.ts:38