GeoprocessingDataFile QML Type
A data file input or output parameter. More...
| Import Statement: | import Esri.ArcGISRuntime 100.13 |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: | |
| Inherited By: |
Properties
- fetchFileStatus : Enums.TaskStatus
- inputFilePath : url
- uploadId : string
- url : url
Signals
Methods
- bool cancelTask(string taskId)
- string fetchFile(url filePath)
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.
| Type | Default Property |
|---|---|
| RequestConfiguration | requestConfiguration (deprecated since Esri.ArcGISRuntime 100.13) |
| Credential | credential (deprecated since Esri.ArcGISRuntime 100.13) |
See also Cancelable and RemoteResource.
Property Documentation
Returns the Enums.TaskStatus of the fetchFile task (read-only).
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 property was introduced in Esri.ArcGISRuntime 100.1.
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 property was introduced in Esri.ArcGISRuntime 100.1.
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
Emitted when the fetchFileStatus property changes.
Note: The corresponding handler is onFetchFileStatusChanged.
Emitted when the url inputFilePath changes.
Note: The corresponding handler is onInputFilePathChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
Emitted when the uploadId property changes.
Note: The corresponding handler is onUploadIdChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
Emitted when the url property changes.
Note: The corresponding handler is onUrlChanged.
Method Documentation
Cancel the task with the ID taskId.
Returns false if the task cannot be cancelled or there is no task with the specified id taskId.
See also Cancelable.
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.