AttachmentInfo

Property Overview

Property Details

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 Stringreadonly inherited

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

exifInfo ExifInfo[]

An array of ExifInfo for the attachment.

globalId String

The global identifier for the attachment.

id Number

The identifier for the attachment.

keywords String

Keywords used for the attachments.

name String

String value indicating the name of the file attachment.

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 Number

The parent or the feature global id of the attachment.

parentObjectId Number

The parent or the feature object id of the attachment.

size Number

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

url String

The URL of the attachment.

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

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(){AttachmentInfo}

Creates a deep clone of the AttachmentInfo class.

Returns

Type	Description
AttachmentInfo	A deep clone of the AttachmentInfo instance.

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(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 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(groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 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(){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

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

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 identifer for the orientation info.

rotation Number optional The rotation value for the attached image.

mirrored Boolean optional Indicates whether the image displays mirrored.