ESM: import PortalItemResource from "@arcgis/core/portal/PortalItemResource.js";
CDN: const PortalItemResource = await $arcgis.import("@arcgis/core/portal/PortalItemResource.js");
Class: @arcgis/core/portal/PortalItemResource
Since: ArcGIS Maps SDK for JavaScript 4.16
Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.Show inherited properties Hide inherited properties
Property DetailsInherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className
.
Path of the resource relative to {ITEM}/resources/
. Resource paths may include subfolders, but are always specified relative to the item resources endpoint.
Show inherited methods Hide inherited methods
Name Return Type Summary Class addHandles()Adds one or more handles which are to be tied to the lifecycle of the object.
Accessor fetch()Promise
Requests the PortalItemResource data in the format specified for the responseType
.
Returns true if a named group of handles exist.
Accessor removeHandles()Removes a group of handles owned by the object.
Accessor update()Promise
Updates an existing resource with new content.
PortalItemResource Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
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(responseType, options){Promise}
Requests the PortalItemResource data in the format specified for the responseType
.
Parameters
Specification
optionalDefault Value: json
The format of the response.
Possible Values:"json"|"xml"|"text"|"blob"|"array-buffer"|"document"
optionalAn object wih the following properties.
Specification
optionalDefault 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 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.Inherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue
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");
}
Inherited
Method removeHandles(groupKey)
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 *
optionalA 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(content, options){Promise}
Updates an existing resource with new content.
Parameters
Specification
The resource content.
optionalAn object wih the following properties.
Specification
optionalDefault 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"
optionalSignal 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 thePortalItemResource
.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4