PortalItemResource | API Reference | ArcGIS Maps SDK for JavaScript 4.31

A reference to a portal item resource.

See also

Constructors

PortalItemResource Constructor new PortalItemResource(properties)

Parameter

properties Object

optional

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

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
String	The name of the class.	Accessor
String	Path of the resource relative to `{ITEM}/resources/`.	PortalItemResource
PortalItem	The portal item that owns the resource.	PortalItemResource
String	The absolute url to the item resource.	PortalItemResource

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

path Property path String

Path of the resource relative to {ITEM}/resources/. Resource paths may include subfolders, but are always specified relative to the item resources endpoint.

See also

ArcGIS REST API - Item Resources

portalItem Property portalItem PortalItem

The portal item that owns the resource.

url Property url Stringreadonly

The absolute url to the item resource. This is computed from the portal item and the resource path.

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	Requests the PortalItemResource data in the format specified for the `responseType`.	PortalItemResource
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Promise	Updates an existing resource with new content.	PortalItemResource

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.

fetch Method fetch(responseType, options){Promise}

Requests the PortalItemResource data in the format specified for the responseType.

Parameters

Specification

responseType String

optional

Default Value: json

The format of the response.

options Object

optional

An object wih the following properties.

Specification

cacheBust Boolean

optional

Default Value: false

If true, the browser will send a request to the server instead of using the browser's local cache. If false, the browser's default cache handling will be used.

signal AbortSignal

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	When resolved, returns the requested data.

See also

ArcGIS REST API - Item Data

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");
}

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");

update Method update(content, options){Promise}

Updates an existing resource with new content.

Parameters

Specification

content Blob

The resource content.

options Object

optional

An object wih the following properties.

Specification

access String

optional

Default Value: "inherit"

Indicates the level of access to the resource. The default is "inherit" which causes the resource to have the same access level as the owning item.

Possible Values:"inherit"|"private"

signal AbortSignal

optional

Returns

Type	Description
Promise	When resolved, returns the `PortalItemResource`.

See also

ArcGIS REST API - Update Item