PortalItemResource
require(["esri/portal/PortalItemResource"], function(PortalItemResource) { /* code goes here */ });esri/portal/PortalItemResourceA reference to a portal item resource.
Constructors
- new PortalItemResource(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| String | Path of the resource relative to | more details | PortalItemResource | |
| PortalItem | The portal item that owns the resource. more details | more details | PortalItemResource | |
| String | The absolute url to the item resource. more details | more details | PortalItemResource |
Property Details
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
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| Promise | Requests the PortalItemResource data in the format specified for the | more details | PortalItemResource | |
| Promise | Updates an existing resource with new content. more details | more details | PortalItemResource |
Method Details
- fetch(responseType, options){Promise}
Requests the PortalItemResource data in the format specified for the
responseType.Parameters:responseType StringoptionalDefault Value: jsonThe format of the response.
Possible Values:"json"|"xml"|"text"|"blob"|"array-buffer"|"document"
options ObjectoptionalAn object wih the following properties.
Specification: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.Returns:Type Description Promise When resolved, returns the requested data. - See also:
- update(content, options){Promise}
Updates an existing resource with new content.
Parameters:Specification:content BlobThe resource content.
options ObjectoptionalAn object wih the following properties.
Specification:access 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.Returns:Type Description Promise When resolved, returns the PortalItemResource.- See also: