Offline Mapbook example app built with ArcGIS iOS Runtime SDK
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs/images
mapbook-iOS.xcodeproj
mapbook-iOS
.gitignore
CONTRIBUTING.md
LICENSE
README.md
sdk_build

README.md

Mapbook iOS

This repo is home to the mobile mapbook app, an example application using the ArcGIS Runtime SDK for iOS. Replace the paper maps you use for field work with offline maps.

Features

  • Mobile map packages
  • Feature layers
  • Identify
  • Table of Contents
  • Show a legend
  • Use a map view callout
  • Geocode addresses
  • Suggestion search
  • Bookmarks
  • Sign in to an ArcGIS account

Best Practices

The project also demonstrates some patterns for building real-world apps around the ArcGIS Runtime SDK.

  • Defining a modular, decoupled UI that operates alongside a map view
  • Asynchronous service and UI coding patterns
  • Internal application communication patterns

Get Started

You will need Xcode with Swift 4.2 and the ArcGIS Runtime SDK for iOS (v100.1 or later) installed locally.

Fork the repo

Fork the Mapbook App repo

Clone the repo

Once you have forked the repo, you can make a clone

Command line Git

  1. Clone the Mapbook App
  2. cd into the mapbook-ios folder
  3. Make your changes and create a pull request

Configuring a Remote for a Fork

If you make changes in the fork and would like to sync those changes with the upstream repository, you must first configure the remote. This will be required when you have created local branches and would like to make a pull request to your upstream branch.

  1. In the Terminal (for Mac users) or command prompt (fow Windows and Linus users) type git remote -v to list the current configured remote repo for your fork.
  2. git remote add upstream https://github.com/Esri/mapbook-ios.git to specify new remote upstream repository that will be synced with the fork. You can type git remote -v to verify the new upstream.

If there are changes made in the Original repository, you can sync the fork to keep it updated with upstream repository.

  1. In the terminal, change the current working directory to your local project
  2. Type git fetch upstream to fetch the commits from the upstream repository
  3. git checkout master to checkout your fork's local master branch.
  4. git merge upstream/master to sync your local master branch with upstream/master. Note: Your local changes will be retained and your fork's master branch will be in sync with the upstream repository.

Configure the app

Before running the app, it must be configured with application credentials. Follow the steps below to obtain application credentials used for browsing and downloading Portal content.

  1. Register an ArcGIS Portal Application.
  2. Configure the Mapbook App project to reference that application.
  3. License the app to remove the Developer Mode watermark.

1. Register an Application

For OAuth configuration, create a new Application in your ArcGIS Portal to obtain a Client ID and configure a Redirect URL. The Client ID configures the ArcGIS Runtime to show your users, during the log in process, that the application was built by you and can be trusted. The Redirect URL configures the OAuth process to then return to your app once authentication is complete.

  1. Log in to https://developers.arcgis.com with either your ArcGIS Organizational Account or an ArcGIS Developer Account.
  2. Register a new Application. Register new application
  3. In the Authentication tab, note the Client ID and add a Redirect URL, e.g. my-mapbook-app://auth. We will use this URL in the Configuring the project section below. Configure new application

2. Configuring the project

Configure Redirect URL

  1. Open the project in Xcode and browse to the mapbook-iOS target's Info panel and expand the AGSConfiguration dictionary (see steps 1-4 in the screenshot below).
  2. Set the AppURLScheme value to match the Redirect URL scheme (the part before the ://, e.g. my-mapbook-app) configured in "Register an Application" above. Note how the AppURLScheme and AuthURLPath combine to construct the Redirect URL. Configure the App URL Scheme
  3. Expand the URL Types section and modify the existing entry.
    1. The Identifier doesn't matter, but should be unique (e.g. com.my-org.my-mapbook-app).
    2. The URL Scheme should match the Redirect URL scheme (the part before the ://, e.g. my-mapbook-app) configured in "Register an Application" above.

Configure the App URL Scheme

Configure Client ID

  1. In the Navigator pane under the project, find the file named AppSettings.swift.
  2. Within AppSettings.swift set the value of the static variable clientID to the application's Client ID noted above.

3. License the app (Optional)

This step is optional during development, but required for deployment.

  1. Get your Runtime Lite License Key by clicking the Show my ArcGIS Runtime Lite license key at the top-right of the Licensing Your ArcGIS Runtime App page (you must be logged in).
  2. Open the project in Xcode and navigate to AppSettings.swift, the same file used to configure your applications client id.
  3. Set the value of the static variable licenseKey to the value from step 1.

Learn More

Learn more about the App Architecture and usage here.

Requirements

Contributing

Anyone and everyone is welcome to contribute. We do accept pull requests.

  1. Get involved
  2. Report issues
  3. Contribute code
  4. Improve documentation

Licensing

Copyright 2017 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.

A copy of the license is available in the repository's LICENSE file.

For information about licensing your deployed app, see License your app.