Skip To ContentArcGIS for DevelopersSign In Dashboard

PortalItemResource

require(["esri/portal/PortalItemResource"], function(PortalItemResource) { /* code goes here */ });
Class: esri/portal/PortalItemResource
Inheritance: PortalItemResource Accessor
Since: ArcGIS API for JavaScript 4.16

A reference to a portal item resource.

See also:

Constructors

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 Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

Path of the resource relative to {ITEM}/resources/.

more details
more detailsPortalItemResource
PortalItem

The portal item that owns the resource.

more details
more detailsPortalItemResource
String

The absolute url to the item resource.

more details
more detailsPortalItemResource

Property Details

declaredClass Stringreadonly inherited

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

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:
portalItem PortalItem

The portal item that owns the resource.

url Stringreadonly

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

Method Overview

NameReturn TypeSummaryClass
Promise

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

more details
more detailsPortalItemResource
Promise

Updates an existing resource with new content.

more details
more detailsPortalItemResource

Method Details

fetch(responseType, options){Promise}

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

Parameters:
responseType String
optional
Default Value: json

The format of the response.

Possible Values:"json"|"xml"|"text"|"blob"|"array-buffer"|"document"

options Object
optional

An object wih the following properties.

Specification:
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:
TypeDescription
PromiseWhen resolved, returns the requested data.
See also:
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"

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:
TypeDescription
PromiseWhen resolved, returns the PortalItemResource.
See also:

API Reference search results

NameTypeModule
Loading...