ArcGIS Runtime SDK for iOS
100.15
|
A job to download an offline map from an online map.
Use this job to download the map content of an offline map area to your device so that you can work offline without a network connection. Upon completion, the job's AGSDownloadPreplannedOfflineMapResult
provides the offline map along with the details of any errors incurred during the download process.
Instances of this class represent a long running job that can take an entire map offline based on its preplanned map area. This job is associated with a number of sub-jobs that take the map's layers and tables offline.
A job is dormant when it is created. It must be explicitly started using startWithStatusHandler:completion: (AGSDownloadPreplannedOfflineMapJob)
.
When the server accepts the job, it assigns a unique ID to the job which is available in AGSJob::serverJobID
. The client then periodically polls for the status of the job on the server and provides this information in the status handler. If the job completes successfully, the result of the job is downloaded and provided in the completion handler, otherwise an error is provided when the job fails.
Instance Methods | |
(BOOL) | - cancel |
(id< AGSCancelable >) | - cancelWithCompletion: |
(id< AGSCancelable >) | - checkStatusWithCompletion: |
(BOOL) | - pause |
(void) | - startWithStatusHandler:completion: |
(void) | - startWithStatusHandler:completion: |
(nullable id) | - toJSON: |
Class Methods | |
(nullable id< AGSJSONSerializable >) | + fromJSON:error: |
Properties | |
AGSCredential * | credential |
NSURL * | downloadDirectory |
NSError * | error |
BOOL | excludeBasemap |
AGSJobType | jobType |
NSArray< AGSJobMessage * > * | messages |
AGSMap * | onlineMap |
AGSDownloadPreplannedOfflineMapParameters * | parameters |
AGSPreplannedMapArea * | preplannedMapArea |
NSProgress * | progress |
AGSRequestConfiguration * | requestConfiguration |
AGSDownloadPreplannedOfflineMapResult * | result |
NSString * | serverJobID |
AGSJobStatus | status |
NSDictionary< NSString *, id > * | unknownJSON |
NSDictionary< NSString *, id > * | unsupportedJSON |
NSURL * | URL |
- (BOOL) cancel |
Cancels the job. Returns a value indicating whether the job was successfully canceled.
cancelWithCompletion:
. Provided by category AGSJob(AGSDeprecated).
- (id<AGSCancelable>) cancelWithCompletion: | (void(^)(NSError *_Nullable error)) | completion |
Cancels this AGSJob
and waits for any asynchronous, server-side operations to be canceled.
The job is canceled and will result in an AGSJobStatusFailed
status after all cancellation tasks have completed. For jobs running on a server, a cancel request is sent for the associated AGSJob::serverJobID
. You should always cancel unneeded jobs (for example when exiting your app) to avoid placing unnecessary load on the server. Examples of server-side jobs include:
In addition, the AGSGenerateOfflineMapJob
is composed of several server-side jobs, depending on the types of layers in your AGSMap
. Canceling this high-level job will also send a cancel request to the underlying server jobs.
Upon calling this method, the AGSJob::status
is immediately set to AGSJobStatusCanceling
.
completion | A block that is invoked when the operation completes successfully or encounters an error. |
- (id<AGSCancelable>) checkStatusWithCompletion: | (void(^)(NSError *__nullable error)) | completion |
Force status check. This method can be called from UIApplication::application:performFetchWithCompletionHandler:
.
|
staticrequiredinherited |
Initializes and returns an object from its JSON representation.
JSONObject | NSDictionary or NSArray containing the JSON. |
error | encountered during the operation, if any. |
- (BOOL) pause |
Pauses the job. Returns a value indicating whether the job was successfully paused.
pause
method through the NSProgress API (exposed via NSProgressReporting
through the progress
property). Provided by category AGSJob(AGSDeprecated).
- (void) startWithStatusHandler: | (nullable void(^)(AGSJobStatus status)) | statusHandler | |
completion: | (void(^)(AGSDownloadPreplannedOfflineMapResult *__nullable result, NSError *__nullable error)) | completion | |
Start the job by submitting it to the server.
statusHandler | is invoked periodically whenever the job's status changes. |
completion | block that is invoked with the result when the job succeeds, or an error if it fails. |
- (void) startWithStatusHandler: | (nullable void(^)(AGSJobStatus status)) | statusHandler | |
completion: | (void(^)(id __nullable result, NSError *__nullable error)) | completion | |
|
requiredinherited |
Returns JSON representation for this object.
error | encountered during the operation, if any. |
NSDictionary
or NSArray
containing the JSON. Reimplemented in AGSPortalItem.
|
readwritenonatomicstronginherited |
Security credentials to access the remote resource. Only applicable if the resource is secured.
|
readnonatomicstrong |
Directory to download the offline map to. The directory path is the path that was supplied as a parameter to the downloadPreplannedOfflineMapJobWithParameters:downloadDirectory: (AGSOfflineMapTask)
. The job will fail if the last directory in the path cannot be created or is not empty.
|
readnonatomicstronginherited |
Error encountered during job execution, if any.
|
readnonatomicassign |
Indicates whether or not to exclude the basemap in the offline map. Excluding the basemap will override the authored settings of preplanned map area and always exclude the basemap content.
|
readnonatomicassigninherited |
The type of job
|
readnonatomiccopyinherited |
Informational messages produced during execution of the job.
The messages can be monitored using Key-Value Observing (KVO).
|
readnonatomicstrong |
The map which is to be taken offline.
|
readnonatomicstrong |
The preplanned map parameters used to create this job.
|
readnonatomicstrong |
The preplanned map area for the onlineMap
which is to be downloaded.
|
readnonatomicstronginherited |
The progress for this job. As a consumer of this progress property, you can observe it's property changes and pause, cancel, resume. Do not, however, set the readwrite properties of this progress object. Those are reserved for internal use. Setting them externally will corrupt the state and lead to undefined behavior.
|
readwritenonatomicstronginherited |
The AGSRequestConfiguration object which defines the behavior and policies to use when accessing the remote resource. The default will be nil. If it is nil the [AGSRequestConfiguration globalConfiguration] will be used.
|
readnonatomicstrong |
Result of the job.
|
readnonatomiccopyinherited |
Unique ID of the job on the server on which it is executing.
|
readnonatomicassigninherited |
Current status of the job.
The status can be monitored using Key-Value Observing (KVO).
|
readrequirednonatomiccopyinherited |
A dictionary of values that was in the source JSON but was unparsed by API.
NSDictionary
containing the unknown JSON.
|
readnonatomiccopyinherited |
A dictionary of values that are supported by the REST API, but not exposed through the SDK API.
NSDictionary
containing the unsupported JSON.
|
readrequirednonatomicstronginherited |
The URL of the remote resource.