Skip To Content ArcGIS for Developers Sign In Dashboard

GeoprocessingDataFile QML Type

A data file input or output parameter. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.0
Inherits:

GeoprocessingParameter

Inherited By:

GeoprocessingRaster

Properties

Signals

Methods

Detailed Description

Corresponds to GPDataFile parameter type on the service.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

TypeDefault Property
RequestConfigurationrequestConfiguration (since Esri.ArcGISRuntime 100.1)
Credentialcredential (since Esri.ArcGISRuntime 100.1)

See also Cancelable and RemoteResource.

Property Documentation

[default] credential : Credential

The credential to be used for a secured online resource.

This QML property was introduced in Esri.ArcGISRuntime 100.1.


fetchFileStatus : Enums.TaskStatus

Returns the Enums.TaskStatus of the fetchFile task (read-only).


inputFilePath : url

The input file path of this parameter.

This should be the location on disk of a file that will be uploaded to the server that the geoprocessing task will run on.

Note: Set this only for input parameters. This property will be ignored if uploadId is set.

This QML property was introduced in Esri.ArcGISRuntime 100.1.


[default] requestConfiguration : RequestConfiguration

The configuration parameters used for network requests sent by this object.

This QML property was introduced in Esri.ArcGISRuntime 100.1.


uploadId : string

The upload ID of this parameter.

This should be the item ID of an item in the geoprocessing service's.

Note: Set this only for input parameters. This will be the upload ID of an item previously uploaded to the server. If this property is set it will cause both the inputFilePath and URL properties to be ignored.

This QML property was introduced in Esri.ArcGISRuntime 100.1.


url : url

The URL of the data file.

If this object represents an input parameter, set this to a URL of the input data file. Ensure this URL is accessible to the service. A geoprocessing service can have an uploads REST resource associated with it for placing inputs.

If this object represents an output parameter, this will be populated with the URL location of the output file on the service. The file can be retrieved by using fetchFile.

Note: If inputFilePath or uploadId are set the url property will be ignored.


Signal Documentation

credentialChanged()

Emitted when the credential property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


fetchFileStatusChanged()

Emitted when the fetchFileStatus property changes.


inputFilePathChanged()

Emitted when the url inputFilePath changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


requestConfigurationChanged()

Emitted when the requestConfiguration property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


uploadIdChanged()

Emitted when the uploadId property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


urlChanged()

Emitted when the url property changes.


Method Documentation

string fetchFile(url filePath)

Creates a task to fetch the file at url into a file or folder at filePath.

If filePath is a directory, the file will be given the name of the file taken from the end of url. The full file path will be available as the returned task's result. Alternatively filePath can be a destination filename within an existing directory. Note that any pre-existing file at that location with the same name will be deleted first.

Returns the ID of the task as a QString.



Feedback on this topic?