ArcGIS Runtime SDK for iOS

Tasks and jobs

Tasks are bound to online or offline data or services, and provide methods to perform asynchronous operations using those resources. By using tasks you can:

Tasks either return their results directly from asynchronous methods on the task, or make use of jobs to provide status updates and results.

Tasks

Some operations return their results directly from asynchronous methods on the task, for example AGSLocatorTask.geocodeWithSearchText and AGSRouteTask.solveRouteWithParameters. For more complex or longer running operations, tasks make use of jobs instead.

To use tasks that return results directly:

  1. Create the task by initializing it to use the required data or service.
  2. Define the task inputs.
    • Some operations require only simple value inputs (for example a simple geocode operation may only require an address string as input).
    • Others require parameters to be defined (for example, to limit a geocode operation to a specific country).
  3. Call the async operation method, passing in the inputs you defined.
  4. Use the results from the operation as required, for example to display geocode results on a map.

The following code creates a AGSLocatorTask to geocode an address entered by the user. The best match is used to create a graphic to display on the map.

// Create a new LocatorTask from a geocode service endpoint
locatorTask = AGSLocatorTask(url: URL(string: "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer")!)

locatorTask?.geocode(withSearchText: "380 New York Street, Redlands, CA"){[weak self] (results, error) -> Void in
    if let error = error {
        print(error.localizedDescription)
        return
    }
    else if let bestResult = results?.first {
        let bestGraphic = AGSGraphic(geometry: bestResult.displayLocation, symbol: aSymbol, attributes: bestResult.attributes)
        self?.graphicsOverlay.graphics.add(bestGraphic)
    }
}

Some Tasks are loadable, and will load themselves when you call an asynchronous method (like that shown above) that requires the task to be in a loaded state. Loadable objects are generally required to be loaded before their properties are filled out.

Define input parameters

Tasks offer numerous options that allow you to tailor the operation to your requirements. For example, when geocoding you can restrict your search to a specific area, country, category of place, and/or number of results. When an author publishes a service or packages a resource, they can choose default values for these options that suit the specific data or the most common use case for the service.

To find these default parameter values, tasks provide async methods that create parameters objects, initialized with these service-specific values. You can then make any changes to the parameter values, before using to execute an operation. Creating parameter objects in this way can be especially useful for operations with many options, such as solving a route.

The code below gets the default parameters for a AGSRouteTask, and then ensures that results using these parameters will return both a route and directions, and also that the output spatial reference matches that of the AGSMapView.

self?.routeTask?.defaultRouteParameters(){ [weak self] (params, error) -> Void in
    if let error = error {
        print(error)
        return
    }

    // explicitly set values for some parameters
    if let routeParameters = params {
        routeParameters.returnDirections = true
        routeParameters.returnRoutes = true
        routeParameters.outputSpatialReference = self?.mapView.spatialReference
        // solve the route with these parameters
        self?.routeTask?.solveRoute(with: routeParameters) {(routeResult, error) -> Void in
            if let error = error{
                print(error)
                return
            }
            //work with the results...
        }
    }
     }

Alternatively, some parameters objects have constructors that you can use if you know the values of all the input parameters you want to use. This can be more efficient where parameter settings are simple.

For example, the following code creates a new AGSGeocodeParameters that restricts the search country to France and limits the results (matches) to a maximum of 5.

let geocodeParams = AGSGeocodeParameters()
geocodeParams.countryCode = "France"
geocodeParams.maxResults = 5

Work online or offline

Many tasks can work either online by using services, or offline by using local data and resources. For example, you can geocode an address by using the default Esri geocoding service, your own geocoding service, a locator file (.loc) or a mobile map package (.mmpk).

// create a locator task from a geocode service endpoint
let locatorURL = URL(string: "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer")!
locatorTask = AGSLocatorTask(url: locatorURL)
 // or create a locator task from a local .loc file
offlineLocatorTask = AGSLocatorTask(name: "locatorfilename.loc")
 // or create a locator task from mobile map packages (if it contains one)
self.mobileMapPackage.load {[weak self]  (error) -> Void in
    guard error == nil else {
        print(error!.localizedDescription)
        return
    }
    self?.locatorTask = self?.mobileMapPackage.locatorTask
}

Tasks and jobs

Some tasks expose operations that have multiple stages (like preparing and downloading a geodatabase), and can generate multiple progress messages (such as percentage complete). These types of tasks are always bound to ArcGIS Server or Local Server. An example is generateJobWithParameters on AGSGeodatabaseSyncTask.

Instead of returning results directly, these tasks make use of jobs to monitor status, return progress updates, and return their results. Each AGSJob represents a specific operation of a task. Jobs are useful for longer-running operations, because they can also be paused, resumed, and cancelled. Your app can support a user action or host OS terminating a running job object, and then re-create and resume the job later.

To use operations like these:

  1. Create the task by initializing it to use the required data or service.
  2. Define the input parameters for the task.
  3. Call the async operation method to get a job, passing in the input parameters you defined.
  4. Start the job.
  5. Optionally, listen for changes to the job status and check the job messages, for example to update a UI and report progress to the user.
  6. Listen for the job completion and get the results from the operation. Check for errors in the job, and if successful, use the results.

//create a sync task with the URL of the feature service to sync
geodatabaseSyncTask = AGSGeodatabaseSyncTask(url: URL(string: "")!)
// create sync parameters
let taskParameters = AGSSyncGeodatabaseParameters()
taskParameters.rollbackOnFailure = true
taskParameters.geodatabaseSyncDirection = .bidirectional
//instantiate a job to submit the sync job
//using the synchronization parameters and the geodatabase containing the edits
syncJob = geodatabaseSyncTask.syncJob(with: taskParameters, geodatabase: self.generatedGeodatabase)
//start the sync job
//the statusHandler block is invoked whenever the job's status changes
//the completion block is invoked with the result when the job succeeds, or an error if it fails
syncJob.start(statusHandler:
    { (status) in
        if status == .succeeded {print("Job succeeded")}
        else if status == .failed {print("Job failed")}
        else {print("Sync in progress")}
    })
    { (results, error) in
        if let error = error {
            print(error)
            return
        }
        //examine the results
    }

Calling AGSJob.status retrieves the current point in the job's workflow. Started jobs periodically receive job changed events; this happens with decreasingly frequency as a job progresses; more than one AGSJobMessage may have been added to the job for each call. The job done listener is called as soon as the job is complete, for both successes and failures. Completed jobs, whether they have succeeded or failed, cannot be restarted.

Report job progress

A job represents an asynchronously running operation that might take some time to finish. As described previously, you can monitor changes to job status for notification when a job has completed, failed, or been cancelled, but what about the time in-between? Users may become frustrated waiting for a long job to complete without getting feedback on it's progress. Fortunately, jobs provide a mechanism for reporting the current progress (percentage complete) for the running operation they represent.

As the job runs it provides a Progress property . You can get the current progress of the job from the job's Progress property, an integer representing the percentage of the operation that has been completed. This allows your app to provide more specific information about the status of a running job using UI elements like progress bars, for example.

Add an observer to the ongoing job to monitor the fractionCompleted. This code displays this fractionCompleted value in the status completion block. Alternatively, you could pass the observedProgress to the UIProgressView and the value will be automatically updated in the UI.

//instantiate the AGSOfflineMapTask
self.offlineMapTask = AGSOfflineMapTask(onlineMap: self.map)
let params = AGSGenerateOfflineMapParameters(areaOfInterest: geometry, minScale: 100000, maxScale: 1000)
 //generate an offline map job
self.offlineMapJob = self.offlineMapTask?.generateOfflineMapJob(with: params, downloadDirectory: url)
 //add an observer to display the % of the job completed
offlineMapJob.progress.addObserver(self, forKeyPath: #keyPath(Progress.fractionCompleted), options: .new, context: &myContext)
offlineMapJob.progress.removeObserver(self, forKeyPath: #keyPath(Progress.fractionCompleted), context: &myContext)
 //start the job add the offline map to the mapview when complete
offlineMapJob.start(statusHandler: {[weak self] (status) in
    print("Status [\(String(describing: self?.offlineMapJob.progress.fractionCompleted))]: \(status)")})
    {[weak self] (result, error) in
    //remove observer
    guard let strongSelf = self else {return}
    strongSelf.offlineMapJob.progress.removeObserver(strongSelf, forKeyPath: #keyPath(Progress.fractionCompleted), context: &myContext)
    //check for errors
    if let error = error {
        print(error)
        return
    }
    //display the offline map
    guard let result = result as? AGSGenerateOfflineMapResult else {return}
    self?.mapView.map = result.offlineMap
}
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?) {
    if let progress = object as? Progress, keyPath == #keyPath(Progress.fractionCompleted){
        DispatchQueue.main.async {
            //move this to the main thread because progress can proceed on a background thread
            print("progress changed: \(progress.fractionCompleted * 100)")
        }
    }
}
Remember to remove the observer when the job has completed.
Note:

The AGSJob conforms to the NSProgressReporting protocol. You can read more about in this overview.

Pause, resume, or cancel job

Jobs are designed to effectively handle a user exiting an app while the job is running, and to handle the app being terminated by the host operating system. Jobs also deal with explicit pausing and cancellation of the operation.

Cancel a job

Sometimes the results of a job are no longer required. For example, a user could change their mind about the area of a tile cache they want to download and want to cancel the job and start over.

Calling AGSJob.progress.cancel on a job immediately changes its status to failed and adds additional information to the job error object. The job completion listener will be called. The error object indicates the error domain and code, which allows you to identify when cancellation has occurred.

The following example shows you how to examine the AGSJob error once the job has failed. In this case the error code NSUserCancelledError would indicate that the job has been terminated by the user.

offlineMapJob.start(statusHandler: {(status) in})
 { (result, error) in
 if let error = error as NSError? {
  if error.domain == NSCocoaErrorDomain && error.code == NSUserCancelledError{
   print("User Cancelled")
  }
  return
 }
 else {
 //process the result
 }
}

Cancelled jobs cannot be restarted, although you can start a new job by re-using the same parameters. Cancelling a job does not necessarily stop any server-side processes, because not all services support cancellation on the server side.

Pause and resume a job

Jobs can be long running operations, so there is no guarantee that they will be completed while the app is running. You can pause a job explicitly using AGSJob.progress.pause. For example when an app is backgrounded and does not have permissions for background operation. Pausing may also be useful if a user wishes to temporarily stop network access for any reason.

Job changed messages will not be received for a paused job. Pausing a job does not stop any server-side processes from executing. While a job is paused, outstanding requests can complete, and therefore it's possible that a resuming a job will result in it having a different state to when it was paused.

You can serialize a job to JSON to persist it if your app is backgrounded, or the process is otherwise terminated. When you deserialize it again, the job will be in the AGSJobStatusPaused state regardless of its state when serialized, and should be restarted to resume listening for completion. The job changed listener can be a good place to update the job JSON for storage by your app.

Serialize the job to JSON with the following code:

if let jobJson = try? self.offlineMapJob.toJSON(){
 //save the JSON to disc or store in NSUserDefaults
}
}

Deserialize the job from JSON then restart the job:

//create the job from JSON
if let offlineMapJob = (try? AGSGenerateOfflineMapJob.fromJSON(jobJSON)) as? AGSGenerateOfflineMapJob{
            
 offlineMapJob.start(statusHandler: { (status) in
  //examine status
 })
 { (result, error) in
  //process the result and errors
 }
}

Loss of network connection

Additionally, jobs using services are designed to handle situations where network connectivity is temporarily lost without needing to be immediately paused. A started job will ignore errors such as network errors for a period of up to 10 minutes. If errors continue for longer, the job will fail and the message will indicate the loss of network connection.

To deal with partially-connected workflows, you can serialize and pause a job when your app detects that network connectivity has been lost for a few minutes to avoid job failure purely due to this lack of network connectivity (as failed jobs cannot be restarted). The job can then be deserialized and resumed when connectivity is reinstated.