ArcGIS Runtime SDK for iOS: AGSDownloadPreplannedOfflineMapJob Class Reference
ArcGIS Runtime SDK for iOS  100.14
AGSDownloadPreplannedOfflineMapJob Class Reference

Description

A job to download a map's preplanned area.

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

Since
100.2
Inheritance diagram for AGSDownloadPreplannedOfflineMapJob:
AGSJob AGSObject <AGSRemoteResource> <AGSJSONSerializable>

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

AGSCredentialcredential
 
NSURL * downloadDirectory
 
NSError * error
 
BOOL excludeBasemap
 
AGSJobType jobType
 
NSArray< AGSJobMessage * > * messages
 
AGSMaponlineMap
 
AGSDownloadPreplannedOfflineMapParametersparameters
 
AGSPreplannedMapAreapreplannedMapArea
 
NSProgress * progress
 
AGSRequestConfigurationrequestConfiguration
 
AGSDownloadPreplannedOfflineMapResultresult
 
NSString * serverJobID
 
AGSJobStatus status
 
NSDictionary< NSString *, id > * unknownJSON
 
NSDictionary< NSString *, id > * unsupportedJSON
 
NSURL * URL
 

Method Documentation

◆ cancel

- (BOOL) cancel

Cancels the job. Returns a value indicating whether the job was successfully canceled.

Since
100
Deprecated:
100.1. Replaced by cancelWithCompletion:.

Provided by category AGSJob(AGSDeprecated).

◆ cancelWithCompletion:

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

Parameters
completionA block that is invoked when the operation completes successfully or encounters an error.
Returns
An operation which can be canceled.
Since
100.14

◆ checkStatusWithCompletion:

- (id<AGSCancelable>) checkStatusWithCompletion: (void(^)(NSError *__nullable error))  completion

Force status check. This method can be called from UIApplication::application:performFetchWithCompletionHandler:.

Since
100.0

◆ fromJSON:error:

+ (nullable id<AGSJSONSerializable>) fromJSON: (id)  JSONObject
error: (NSError **)  error 
staticrequiredinherited

Initializes and returns an object from its JSON representation.

Parameters
JSONObjectNSDictionary or NSArray containing the JSON.
errorencountered during the operation, if any.
Since
100

◆ pause

- (BOOL) pause

Pauses the job. Returns a value indicating whether the job was successfully paused.

Since
100
Deprecated:
100.1. Please use the pause method through the NSProgress API (exposed via NSProgressReporting through the progress property).

Provided by category AGSJob(AGSDeprecated).

◆ startWithStatusHandler:completion: [1/2]

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

Parameters
statusHandleris invoked periodically whenever the job's status changes.
completionblock that is invoked with the result when the job succeeds, or an error if it fails.
Since
100.2

◆ startWithStatusHandler:completion: [2/2]

- (void) startWithStatusHandler: (nullable void(^)(AGSJobStatus status))  statusHandler
completion: (void(^)(id __nullable result, NSError *__nullable error))  completion 

◆ toJSON:

- (nullable id) toJSON: (NSError **)  error
requiredinherited

Returns JSON representation for this object.

Parameters
errorencountered during the operation, if any.
Returns
NSDictionary or NSArray containing the JSON.
Since
100

Reimplemented in AGSPortalItem.

Property Documentation

◆ credential

- (AGSCredential*) credential
readwritenonatomicstronginherited

Security credentials to access the remote resource. Only applicable if the resource is secured.

Since
100

◆ downloadDirectory

- (NSURL*) downloadDirectory
readnonatomicstrong

Directory to download the offline map to.

Since
100.2

◆ error

- (NSError*) error
readnonatomicstronginherited

Error encountered during job execution, if any.

Since
100

◆ excludeBasemap

- (BOOL) excludeBasemap
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.

Since
100.2

◆ jobType

- (AGSJobType) jobType
readnonatomicassigninherited

The type of job

Since
100

◆ messages

- (NSArray<AGSJobMessage*>*) messages
readnonatomiccopyinherited

Informational messages produced during execution of the job.

The messages can be monitored using Key-Value Observing (KVO).

Since
100

◆ onlineMap

- (AGSMap*) onlineMap
readnonatomicstrong

The map which is to be taken offline.

Since
100.2

◆ parameters

- (AGSDownloadPreplannedOfflineMapParameters*) parameters
readnonatomicstrong

The preplanned map parameters used to create this job.

Since
100.4

◆ preplannedMapArea

- (AGSPreplannedMapArea*) preplannedMapArea
readnonatomicstrong

The preplanned map area for the onlineMap which is to be downloaded.

Since
100.2

◆ progress

- (NSProgress*) progress
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.

Since
100.1

◆ requestConfiguration

- (AGSRequestConfiguration*) requestConfiguration
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.

Since
100

◆ result

- (AGSDownloadPreplannedOfflineMapResult*) result
readnonatomicstrong

Result of the job.

Since
100.2

◆ serverJobID

- (NSString*) serverJobID
readnonatomiccopyinherited

Unique ID of the job on the server on which it is executing.

Since
100

◆ status

- (AGSJobStatus) status
readnonatomicassigninherited

Current status of the job.

The status can be monitored using Key-Value Observing (KVO).

Since
100

◆ unknownJSON

- (NSDictionary<NSString*,id>*) unknownJSON
readrequirednonatomiccopyinherited

A dictionary of values that was in the source JSON but was unparsed by API.

Returns
NSDictionary containing the unknown JSON.
Since
100

◆ unsupportedJSON

- (NSDictionary<NSString*,id>*) unsupportedJSON
readnonatomiccopyinherited

A dictionary of values that are supported by the REST API, but not exposed through the SDK API.

Returns
NSDictionary containing the unsupported JSON.
Since
100

◆ URL

- (NSURL*) URL
readrequirednonatomicstronginherited

The URL of the remote resource.

Since
100