GeoprocessingDataFile Class

Member Function Documentation

[explicit] GeoprocessingDataFile::GeoprocessingDataFile(QObject *parent = nullptr)

Constructor that accepts an optional parent object.

[explicit] GeoprocessingDataFile::GeoprocessingDataFile(const QUrl &url, QObject *parent = nullptr)

Constructor that accepts an initial URL to a data file (url) and an optional parent object.

[override virtual] GeoprocessingDataFile::~GeoprocessingDataFile()

Destructor.

Esri::ArcGISRuntime::TaskWatcher GeoprocessingDataFile::fetchFile(const QString &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.

[since Esri::ArcGISRuntime 200.2] QFuture<QString> GeoprocessingDataFile::fetchFileAsync(const QString &filePath)

The data file at the URL in the url property.

• filePath - Path to a directory or full file name.

If filePath is a directory, the file will be given the name of the file taken from the end of the 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.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

[signal] void GeoprocessingDataFile::fetchFileCompleted(const QUuid &taskId, const QString &filePath)

The signal emitted when the fetchFile task completes.

• taskId - The task ID.
• filePath - The full path to the output file.

[since Esri::ArcGISRuntime 100.1] QString GeoprocessingDataFile::inputFilePath() const

Returns the input file path of the data.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also setInputFilePath().

[since Esri::ArcGISRuntime 100.1] void GeoprocessingDataFile::setInputFilePath(const QString &path)

Sets the input file path of the data path.

Sets 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.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also inputFilePath().

[since Esri::ArcGISRuntime 100.1] void GeoprocessingDataFile::setUploadId(const QString &uploadId)

Sets the upload ID of this parameter to uploadId.

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

This function was introduced in Esri::ArcGISRuntime 100.1.

See also uploadId().

void GeoprocessingDataFile::setUrl(const QUrl &url)

Sets the URL of the data file to url.

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.

See also url().

[since Esri::ArcGISRuntime 100.1] QString GeoprocessingDataFile::uploadId() const

Returns the upload ID of this parameter.

This will match the ID of an item in the geoprocessing service's uploads resource.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also setUploadId().

QUrl GeoprocessingDataFile::url() const

Returns the URL of the data file.

See also setUrl().