AttachmentInfo

AMD: require(["esri/rest/query/support/AttachmentInfo"], (AttachmentInfo) => { /* code goes here */ });
ESM: import AttachmentInfo from "@arcgis/core/rest/query/support/AttachmentInfo.js";
Class: esri/rest/query/support/AttachmentInfo
Inheritance: AttachmentInfo Accessor
Since: ArcGIS Maps SDK for JavaScript 4.19

The AttachmentInfo class returns information about attachments associated with a feature. The contents of the attachment are streamed to the client. Attachments are available if the FeatureLayer.capabilities.data.supportsAttachment is true.

popuptemplate-attachments-element-list

See also

Constructors

AttachmentInfo

Constructor
new AttachmentInfo(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.
Show inherited properties Hide inherited properties
Name Type Summary Class

The content type of the attachment.

AttachmentInfo

The name of the class.

Accessor

An array of ExifInfo for the attachment.

AttachmentInfo

The global identifier for the attachment.

AttachmentInfo

The identifier for the attachment.

AttachmentInfo

Keywords used for the attachments.

AttachmentInfo

String value indicating the name of the file attachment.

AttachmentInfo

The OrientationInfo for the attachment.

AttachmentInfo

The parent or the feature global id of the attachment.

AttachmentInfo

The parent or the feature object id of the attachment.

AttachmentInfo

The file size of the attachment.

AttachmentInfo

The URL of the attachment.

AttachmentInfo

Property Details

contentType

Property
contentType String

The content type of the attachment. For example, 'image/jpeg'. See the ArcGIS REST API documentation for more information on supported attachment types.

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

exifInfo

Property
exifInfo ExifInfo[]

An array of ExifInfo for the attachment.

globalId

Property
globalId String

The global identifier for the attachment.

id

Property
id Number

The identifier for the attachment.

keywords

Property
keywords String

Keywords used for the attachments.

name

Property
name String

String value indicating the name of the file attachment.

orientationInfo

Property
orientationInfo OrientationInforeadonly

The OrientationInfo for the attachment. This is derived from the exifInfo. In order to read this, you must first set the attachment query's returnMetadata to true to get the exif info associated with the attachment.

parentGlobalId

Property
parentGlobalId Number

The parent or the feature global id of the attachment.

parentObjectId

Property
parentObjectId Number

The parent or the feature object id of the attachment.

size

Property
size Number

The file size of the attachment. This is specified in bytes.

url

Property
url String

The URL of the attachment.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

Creates a deep clone of the AttachmentInfo class.

AttachmentInfo
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

AttachmentInfo

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Converts an instance of this class to its ArcGIS portal JSON representation.

AttachmentInfo

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.

clone

Method
clone(){AttachmentInfo}

Creates a deep clone of the AttachmentInfo class.

Returns
Type Description
AttachmentInfo A deep clone of the AttachmentInfo instance.

fromJSON

Method
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns
Type Description
* Returns a new instance of this class.

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

toJSON

Method
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Type Definitions

ExifInfo

Type Definition
ExifInfo

An array of Exchangeable image file format information for the attachment. You must set the attachment query's returnMetadata to true to get the exif info associated with the attachment.

Properties
name String
optional

The file name.

tags Object[]
optional

Array of tag objects containing the following properties:

Specification
name String

The tag name.

description String

The tag description.

value *

The value of the tag.

OrientationInfo

Type Definition
OrientationInfo

An object containing properties specific to the orientation of an image attachment. This information is stored within the attachment's exifInfo. In order to read this, you must first set the attachment query's returnMetadata to true to get the exif info associated with the attachment.

Properties
id Number
optional

The identifier for the orientation info.

rotation Number
optional

The rotation value for the attached image.

mirrored Boolean
optional

Indicates whether the image displays mirrored.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.