AGSGeoprocessingDataFile Class Reference

Description

A geoprocessing parameter for files.

Instances of this class represent a parameter for files that can be used as input to a geoprocessing job or returned as the result of the job. The file can be on a remote server, or locally on disk. If the file is on a remote server and is intended to be used as an input to a geoprocessing job, make sure the geoprocessing service has access to the remote location.

Since

100

Inheritance diagram for AGSGeoprocessingDataFile:

Instance Methods
(id< AGSCancelable >)	- downloadToFileURL:completion:
(instancetype)	- initWithInputFileURL:
(instancetype)	- initWithUploadID:
(instancetype)	- initWithURL:

Class Methods
(instancetype)	+ geoprocessingDataFile
(instancetype)	+ geoprocessingDataFileWithInputFileURL:
(instancetype)	+ geoprocessingDataFileWithUploadID:
(instancetype)	+ geoprocessingDataFileWithURL:
(instancetype)	+ geoprocessingParameter

Properties
NSURL *	inputFileURL
AGSGeoprocessingParameterType	type
NSString *	uploadID
NSURL *	URL

Method Documentation

downloadToFileURL:completion:

- (id<AGSCancelable>) downloadToFileURL:		(NSURL *)	fileURL
completion:		(void(^)(NSURL *__nullable fileURL, NSError *__nullable error))	completion

Download the file to the specified location on disk. Only applicable when this parameter's URL represents a remote file on a server.

Parameters

fileURL	location on disk to where the remote file should be downloaded. If location is a directory, the file will be given the name of the file take from the end of URL. Alternatively the location 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.
completion	block that is invoked with the URL of where the file was downloaded to when the operation succeeds, or an error if it fails

Since

100

geoprocessingDataFile

+ (instancetype) geoprocessingDataFile

geoprocessingDataFileWithInputFileURL:

+ (instancetype) geoprocessingDataFileWithInputFileURL:

(NSURL *)

inputFileURL

geoprocessingDataFileWithUploadID:

+ (instancetype) geoprocessingDataFileWithUploadID:

(NSString *)

uploadID

geoprocessingDataFileWithURL:

+ (instancetype) geoprocessingDataFileWithURL:

(NSURL *)

URL

Initialize the parameter with the given URL representing a file either on a remote server, or locally on disk. If the parameter is intended to be used as an input to a geoprocessing job, and if it is created with URL to a remote file, make sure the geoprocessing service has access to the remote location.

Parameters

URL	value for the parameter

Since

100

geoprocessingParameter

+ (instancetype) geoprocessingParameter

Deprecated:

100.9. Do not use this method, it creates an invalid and incomplete object.

initWithInputFileURL:

- (instancetype) initWithInputFileURL:

(NSURL *)

inputFileURL

Implemented in AGSGeoprocessingRaster.

initWithUploadID:

- (instancetype) initWithUploadID:

(NSString *)

uploadID

Implemented in AGSGeoprocessingRaster.

initWithURL:

- (instancetype) initWithURL:

(NSURL *)

URL

Initialize the parameter with the given URL representing a file either on a remote server, or locally on disk. If the parameter is intended to be used as an input to a geoprocessing job, and if it is created with URL to a remote file, make sure the geoprocessing service has access to the remote location.

Parameters

URL	value for the parameter

Since

100

Implemented in AGSGeoprocessingRaster.

Property Documentation

inputFileURL

- (NSURL*) inputFileURL

readwritenonatomicstrong

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 is only for input parameters. Setting this will override a URL set with AGSGeoprocessingDataFile::URL. Note that this property will be ignored if AGSGeoprocessingDataFile::uploadID is set.

See also

AGSGeoprocessingDataFile::URL, AGSGeoprocessingDataFile::uploadID

Since

100.1

type

- (AGSGeoprocessingParameterType) type

readnonatomicassigninherited

The data type of the parameter.

Since

100

uploadID

- (NSString*) uploadID

readwritenonatomiccopy

The upload item id of this parameter. This should be the item id of an item in the geoprocessing service's uploads resource. This is only for input parameters. This will be the upload id of an item previously uploaded to the server. Note that if this property is set it will cause both the AGSGeoprocessingDataFile::inputFileURL and AGSGeoprocessingDataFile::URL properties to be ignored.

See also

AGSGeoprocessingDataFile::URL, AGSGeoprocessingDataFile::inputFileURL

Since

100.1

URL

- (NSURL*) URL

readwritenonatomicstrong

Value of the parameter representing a local or remote file

Since

100