require(["esri/portal/PortalItemResource"], (PortalItemResource) => { /* code goes here */ });
import PortalItemResource from "@arcgis/core/portal/PortalItemResource.js";
esri/portal/PortalItemResource
A reference to a portal item resource.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
The name of the class. | Accessor | ||
Path of the resource relative to | PortalItemResource | ||
The portal item that owns the resource. | PortalItemResource | ||
The absolute url to the item resource. | PortalItemResource |
Property Details
-
path
Propertypath 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
PropertyportalItem PortalItem -
The portal item that owns the resource.
-
url
Propertyurl Stringreadonly -
The absolute url to the item resource. This is computed from the portal item and the resource path.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Requests the PortalItemResource data in the format specified for the | PortalItemResource | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Updates an existing resource with new content. | PortalItemResource |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
Methodfetch(responseType, options){Promise} -
Requests the PortalItemResource data in the format specified for the
responseType.ParametersresponseType StringoptionalDefault Value: jsonThe format of the response.
Possible Values:"json"|"xml"|"text"|"blob"|"array-buffer"|"document"
options ObjectoptionalAn object wih the following properties.
Specificationsignal AbortSignaloptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortErrorwhen an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise When resolved, returns the requested data. - See also
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
update
Methodupdate(content, options){Promise} -
Updates an existing resource with new content.
ParametersSpecificationcontent BlobThe resource content.
options ObjectoptionalAn object wih the following properties.
Specificationaccess StringoptionalDefault 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 AbortSignaloptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortErrorwhen an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise When resolved, returns the PortalItemResource.- See also