require(["esri/tasks/support/DataFile"], function(DataFile) { /* code goes here */ });
Class: esri/tasks/support/DataFile
Inheritance: DataFile Accessor
Since: ArcGIS API for JavaScript 4.0

A geoprocessing data object containing a data source.

See also:
Example:
require([
 "esri/tasks/Geoprocessor", "esri/tasks/support/DataFile", ...
], function(Geoprocessor, DataFile, ... ) {
var gp = new Geoprocessor( ... );
 function requestSucceeded(result) {
   var itemID = result.item.itemID;
   var dataFile = new DataFile();
   dataFile.itemID = itemID;
   var params = {
     "Input_File": dataFile
   };
   gp.execute(params).then(function(gpResult){
     ...
   });
 }
});

Constructors

new DataFile(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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

The ID of the uploaded file returned as a result of the upload operation.

more details
more detailsDataFile
String

URL to the location of the data file.

more details
more detailsDataFile

Property Details

declaredClassStringreadonly inherited

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

itemIdString

The ID of the uploaded file returned as a result of the upload operation. For ArcGIS Server 10.1 and greater services that support uploads, this class can be used to specify an uploaded item as input by specifying the ItemID.

URL to the location of the data file.

Method Overview

NameReturn TypeSummaryClass
*

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

more details
more detailsDataFile
Object

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

more details
more detailsDataFile

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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:
TypeDescription
*Returns a new instance of this class.

toJSON(){Object}

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

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.