MapsWithMe iOS API: Getting Started

Introduction

MapsWithMe offline maps API for iOS (hereinafter referred to as API) provides interface for client application to perform next tasks:

For version 1 (supported by MapsWithMe 2.4+)

• Open MapsWithMe Application
• Check that MapsWithMe is installed
• Show one or more points on offline map of MapsWithMe with Back button and client app name in the title
• Come back to the client application:
• after pressing Back button on the map
• after selecting specific point on the map if user asks for more information by pressing More Info button in MapsWithMe
• Open any given url or url scheme after selecting specific point on the map if user asks for more information by pressing More Info button in MapsWithMe
• Automatically display Download MapsWithMe dialog if MapsWithMe is not installed.

In general, you can provide one or two way communication between your appication and MapsWithMe.

Please refer to sample application for demo.

Prerequisites

• Your application must target at least iOS version 4.3
• For two way communication, you should add unique URL scheme to your app (see below)

Integration

First step is to clone repository or download it as an archive.

When your are done you find two folders: api and capitals-example. First one contains .h and .m files which you need to include into your project. You can always modify them according to your needs.

If you want to get results of API calls, please add unique URL scheme to your app. You can do it with XCode or by editing Info.plist file in your project. To make things simple, use mapswithme keyword in scheme ID, like my_mapswithme_scheme, and create an unique scheme name (or use your existing one). mapswithme keyword in scheme ID simply helps API code to detect it automatically. See more details in Apple's documentation.

capitals-example folder contains sample application which demonstrates part of API features.

API Calls Overview and HOW TO

• All methods are static for MWMApi class, BOOL methods return NO if call is failed.
• If id for given pin contains valid url, it will be opened from MapsWithMe after selecting More Info button. For any other content, id will be simply passed back to the caller's AppDelegate application:openURL:sourceApplication:annotation: method

Open MapsWithMe Application

Simply opens MapsWithMe app:

+ (BOOL) showMap;

Example:

[MWMApi showMap];

Show specified location on the map

Displays given point on a map:

+ (BOOL) showLat:(double)lat lon:(double)lon title:(NSString *)title and:(NSString *)idOrUrl;

The same as above but using pin wrapper:

+ (BOOL) showPin:(MWMPin *)pin;

Pin wrapper is a simple helper to wrap pins displayed on the map:

@interface MWMPin : NSObject
  @property (nonatomic, assign) double lat;
  @property (nonatomic, assign) double lon;
  @property (nonatomic, retain) NSString * title;
  @property (nonatomic, retain) NSString * idOrUrl;
  - (id) initWithLat:(double)lat lon:(double)lon title:(NSString *)title and:(NSString *)idOrUrl;
@end

Example:

[MWMApi showLat:53.9 lon:27.56667 title:@"Minsk - the capital of Belarus" and:@"http://wikipedia.org/wiki/Minsk"];
…
MWMPin * goldenGate = [[MWMPin alloc] init] autorelease];
goldenGate.lat = 37.8195;
goldenGate.lon = -122.4785;
goldenGate.title = @"Golden Gate in San Francisco";
goldenGate.idOrUrl = @"any number or string here you want to receive back in your app, or any url you want to be opened from MapsWithMe";
[MWMApi showPin:goldenGate];

Show any number of pins on the map

+ (BOOL) showPins:(NSArray *)pins;

Receiving results of API calls

When users presses Back button in MapsWithMe, or selects More Info button, he is redirected back to your app. Here are helper methods to obtain API call results:

Returns YES if url is received from MapsWithMe and can be parsed:

+ (BOOL) isMapsWithMeUrl:(NSURL *)url;

Returns nil if user didn't select any pin and simply pressed Back button:

+ (MWMPin *) pinFromUrl:(NSURL *)url;

Example:

if ([MWMApi isMapsWithMeUrl:url])
{
  // Good, here we know that your app was opened from MapsWithMe
  MWMPin * pin = [MWMApi pinFromUrl:url];
  if (pin)
  {
    // User selected specific pin, and we can get it's properties
  }
  else
  {
    // User pressed "Back" button and didn't select any pin
  }
}

Check that MapsWithMe is installed

Returns NO if MapsWithMe is not installed or outdated version doesn't support API calls:

+ (BOOL) isApiSupported;

With this method you can check that user needs to install MapsWithMe and display your custom UI. Alternatively, you can do nothing and use built-in dialog which will offer users to install MapsWithMe.

Sample Code

Support

Have a bug or feature request? Please open a new issue.

If you have any questions, suggestions or feedbacks, please drop us a line to api@mapswith.me.

Under the hood

If you prefer to use API on your own, here are some details about the implementation.

Applications "talk" to each other using URL Scheme. API v1 supports the following parameters to the URL Scheme:

mapswithme://map?v=1&ll=54.32123,12.34562&n=Point%20Name&id=AnyStringOrEncodedUrl&backurl=UrlToCallOnBackButton&appname=TitleToDisplayInNavBar

• v - API version, currently 1
• ll - pin latitude and longitude, comma-separated
• n - pin title
• id - any string you want to receive back in your app, OR alternatively, any valid URL which will be opened on More Info button click
• backurl - usually, your unique app scheme to open back your app
• appname - string to display in navigation bar on top of the map in MapsWithMe

Note that you can display as many pins as you want, the only rule is that ll parameter comes before n and id for each point.

When user selects a pin, your app is called like this:

YourAppUniqueUrlScheme://pin?ll=lat,lon&n=PinName&id=PinId

---

API Code is licensed under the BSD 2-Clause License

Copyright (c) 2013, MapsWithMe GmbH All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.