Apply scheduled updates to preplanned map area

View on GitHub
Sample viewer app

Apply scheduled updates to a downloaded preplanned map area.

Apply Scheduled Updates to Preplanned Map Area Sample

Use case

With scheduled updates, the author can update the features within the preplanned areas on the service once, and multiple end-users can request these updates to bring their local copies up to date with the most recent state. Importantly, any number of end-users can download the same set of cached updates which means that this workflow is extremely scalable for large operations where you need to minimize load on the server.

This workflow can be used by survey workers operating in remote areas where network connectivity is not available. The workers could download mobile map packages to their individual devices and perform their work normally. Once they regain Internet connectivity, the mobile map packages can be updated to show any new features that have been added to the online service.

How to use the sample

When the sample loads, it will display an offline map, check for available updates, and show update availability and size. Tap "Apply" to apply the updates to the local offline map and show the results.

How it works

  1. Create an AGSOfflineMapSyncTask object with your offline map.
  2. If desired, get an AGSOfflineMapUpdatesInfo instance from the task to check for update availability or update size.
  3. Get a set of default parameters (AGSOfflineMapSyncParameters) for the task.
  4. Set the parameters to download all available updates.
  5. Use the parameters to create an AGSOfflineMapSyncJob object.
  6. Start the job and get the results once it completes successfully.
  7. Check if the mobile map package needs to be reopened, and do so if necessary.
  8. Finally, display your offline map to see the changes.

Relevant API

  • AGSMobileMapPackage
  • AGSOfflineMapSyncJob
  • AGSOfflineMapSyncParameters
  • AGSOfflineMapSyncResult
  • AGSOfflineMapSyncTask
  • AGSOfflineMapUpdatesInfo

About the data

The data in this sample shows the roads and trails in the Canyonlands National Park, Utah. Data by U.S. National Parks Service. No claim to original U.S. Government works.

Additional information

Note: preplanned areas using the Scheduled Updates workflow are read-only. For preplanned areas that can be edited on the end-user device, see the Download preplanned map area sample. For more information about offline workflows, see Offline maps, scenes, and data in the ArcGIS Developers guide.

Tags

offline, pre-planned, preplanned, synchronize, update

Sample Code

ApplyScheduledUpdatesToPreplannedMapAreaViewController.swift
                                                                                                                                                                                         
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
//
// Copyright © 2019 Esri.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

import UIKit
import ArcGIS

/// A view controller that manages the interface of the Apply Scheduled Updates
/// to Preplanned Map Area sample.
class ApplyScheduledUpdatesToPreplannedMapAreaViewController: UIViewController {
    /// The map view managed by the view controller.
    @IBOutlet weak var mapView: AGSMapView!

    /// The mobile map package used by this sample.
    let mobileMapPackage: AGSMobileMapPackage!
    /// The sync task used to check for scheduled updates.
    var offlineMapSyncTask: AGSOfflineMapSyncTask!
    /// The sync job used to apply updates to the offline map.
    var offlineMapSyncJob: AGSOfflineMapSyncJob!

    required init?(coder: NSCoder) {
        let mobileMapPackageURL = Bundle.main.url(forResource: "canyonlands", withExtension: nil)!
        do {
            let temporaryDirectoryURL = try FileManager.default.url(
                for: .itemReplacementDirectory,
                in: .userDomainMask,
                appropriateFor: mobileMapPackageURL,
                create: true
            )
            let temporaryMobileMapPackageURL = temporaryDirectoryURL.appendingPathComponent(ProcessInfo.processInfo.globallyUniqueString)
            try FileManager.default.copyItem(at: mobileMapPackageURL, to: temporaryMobileMapPackageURL)
            mobileMapPackage = AGSMobileMapPackage(fileURL: temporaryMobileMapPackageURL)
        } catch {
            print("Error setting up mobile map package: \(error)")
            mobileMapPackage = nil
        }

        super.init(coder: coder)

        mobileMapPackage?.load { [weak self] (error) in
            let result: Result<Void, Error>
            if let error = error {
                result = .failure(error)
            } else {
                result = .success(())
            }
            self?.mobileMapPackageDidLoad(with: result)
        }
    }

    deinit {
        if let mobileMapPackage = mobileMapPackage {
            mobileMapPackage.close()
            try? FileManager.default.removeItem(at: mobileMapPackage.fileURL)
        }
    }

    /// Called in response to the mobile map package load operation completing.
    /// - Parameter result: The result of the load operation.
    func mobileMapPackageDidLoad(with result: Result<Void, Error>) {
        switch result {
        case .success:
            let map = self.mobileMapPackage.maps.first!
            loadViewIfNeeded()
            mapView.map = map
            let offlineMapSyncTask = AGSOfflineMapSyncTask(map: map)
            offlineMapSyncTask.checkForUpdates { [weak self] (updatesInfo, error) in
                if let updatesInfo = updatesInfo {
                    self?.offlineMapSyncTaskDidComplete(with: .success(updatesInfo))
                } else if let error = error {
                    self?.offlineMapSyncTaskDidComplete(with: .failure(error))
                }
            }
            self.offlineMapSyncTask = offlineMapSyncTask
        case .failure(let error):
            presentAlert(error: error)
        }
    }

    /// Called in response to the offline map sync task completing.
    /// - Parameter result: The result of the sync task.
    func offlineMapSyncTaskDidComplete(with result: Result<AGSOfflineMapUpdatesInfo, Error>) {
        switch result {
        case .success(let updatesInfo):
            let alertController: UIAlertController
            if updatesInfo.downloadAvailability == .available {
                let downloadSize = updatesInfo.scheduledUpdatesDownloadSize
                let measurement = Measurement(
                    value: Double(downloadSize),
                    unit: UnitInformationStorage.bytes
                )
                let downloadSizeString = ByteCountFormatter.string(from: measurement, countStyle: .file)
                alertController = UIAlertController(
                    title: "Scheduled Updates Available",
                    message: "A \(downloadSizeString) update is available. Would you like to apply it?",
                    preferredStyle: .alert
                )
                let applyAction = UIAlertAction(title: "Apply", style: .default) { (_) in
                    self.applyScheduledUpdates()
                }
                alertController.addAction(applyAction)
                let cancelAction = UIAlertAction(title: "Cancel", style: .cancel)
                alertController.addAction(cancelAction)
                alertController.preferredAction = applyAction
            } else {
                alertController = UIAlertController(
                    title: "Scheduled Updates Unavailable",
                    message: "There are no updates available.",
                    preferredStyle: .alert
                )
                let okayAction = UIAlertAction(title: "OK", style: .default)
                alertController.addAction(okayAction)
                alertController.preferredAction = okayAction
            }
            present(alertController, animated: true)
        case .failure(let error):
            presentAlert(error: error)
        }
    }

    /// Apply available updates to the offline map.
    func applyScheduledUpdates() {
        offlineMapSyncTask.defaultOfflineMapSyncParameters { [weak self] (parameters, error) in
            guard let self = self else { return }
            if let parameters = parameters {
                let offlineMapSyncJob = self.offlineMapSyncTask.offlineMapSyncJob(with: parameters)
                offlineMapSyncJob.start(statusHandler: nil) { [weak self] (result, error) in
                    if let result = result {
                        self?.offlineMapSyncJobDidComplete(with: .success(result))
                    } else if let error = error {
                        self?.offlineMapSyncJobDidComplete(with: .failure(error))
                    }
                }
                self.offlineMapSyncJob = offlineMapSyncJob
            } else if let error = error {
                self.presentAlert(error: error)
            }
        }
    }

    /// Called in response to the offline map sync job completing.
    /// - Parameter result: The result of the sync job.
    func offlineMapSyncJobDidComplete(with result: Result<AGSOfflineMapSyncResult, Error>) {
        switch result {
        case .success(let result):
            guard result.isMobileMapPackageReopenRequired else {
                break
            }
            mobileMapPackage.close()
            mobileMapPackage.load { [weak self] (error) in
                guard let self = self else { return }
                if let error = error {
                    self.presentAlert(error: error)
                } else {
                    self.mapView.map = self.mobileMapPackage.maps.first
                }
            }
        case .failure(let error):
            presentAlert(error: error)
        }
    }

    // MARK: UIViewController

    override func viewDidLoad() {
        super.viewDidLoad()

        // add the source code button item to the right of navigation bar
        (self.navigationItem.rightBarButtonItem as? SourceCodeBarButtonItem)?.filenames = [
            "ApplyScheduledUpdatesToPreplannedMapAreaViewController"
        ]
    }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.