organicmaps/api-android
13
Fork 0
Code Issues 5 Pull requests Projects Releases Wiki Activity Actions

Updated API example

Browse source 
Signed-off-by: Alexander Borsuk <me@alex.bio>
This commit is contained in:
Alexander Borsuk 2022-06-05 15:56:20 +02:00 • committed by Roman Tsisyk
parent 2c38ec5edc
commit 80069e1acb
18 changed files with 153 additions and 331 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

174
README.html
View file

@ -1,174 +0,0 @@
<h1>maps.me Android API: Getting Started</h1>
<h2>Introduction</h2>
<p>NOTE: We have changed the name of our maps from MapsWithMe to MAPS.ME, but left all references below unchanged.</p>
<p>MapsWithMe Android API (hereinafter referred to as <em>&quot;API Library&quot;</em> or just <em>&quot;library&quot;</em>)
provides interface for client application to perform next tasks:</p>
<ul>
<li>Show one or more points on offline map of <a href="http://maps.me/" title="MAPS.ME">MapsWithMe Application</a></li>
<li>Come back to the client application after selecting specific point on the map, by sending <a href="http://developer.android.com/reference/android/app/PendingIntent.html" title="PendingIntent">PendingIntent</a> with point data when user asks for more information by pressing &quot;More Info&quot; button in MapsWithMe Application</li>
<li>Map screen branding : your application&#39;s icon and name (or custom title) will be placed at the top.</li>
</ul>
<p>Thus, you can provide <strong>two way communication between your application and MapsWithMe</strong>,
using MapsWithMe to show points of interest (POI) and providing more information in your app.</p>
<p>Please refer to <a href="https://github.com/mapswithme/api-android/tree/master/sample-app-capitals" title="Api Source Code">sample application</a> for demo or see
our <a href="http://www.guidewithme.com">travel guide apps</a> as an API integration example.</p>
<h2>Prerequisites</h2>
<p>It is supposed that you are familiar with Android Development, and you have Android SDK and Eclipse (or another IDE of your choice) installed.
You should be familiar with concept of <a href="http://developer.android.com/guide/components/intents-filters.html" title="Intents and Intent Filters">Intents</a>, <a href="http://developer.android.com/tools/projects/index.html#LibraryProjects" title="Android Library Project">library projects</a>, and <a href="http://developer.android.com/reference/android/app/PendingIntent.html" title="PendingIntent">PendingIntents</a> (recommended) as well.
Your application must target at least <em>android sdk version 9</em>.</p>
<h2>Integration</h2>
<p>First step is to clone <a href="https://github.com/mapswithme/api-android" title="GitHub Repository">repository</a> or download it as an archive.</p>
<p>When your are done you find two folders: <em>lib</em> and <em>sample-app-capitals</em>. First one is a library project that you should add to your project.
You don&#39;t need any additional permissions in your AndroidManifest.xml to use API library, so you can write real code straight away, calling for different <code>MapsWithMeApi</code> methods (more details below). </p>
<h2>Classes Overview and HOW TO</h2>
<p>Core classes you will work with are:</p>
<ul>
<li><a href="lib/src/com/mapswithme/maps/api/MapsWithMeApi.java" title="MapsWithMeApi.java">com.mapswithme.maps.api.MapsWithMeApi</a> - static class with methods such as <code>showPointOnMap(Activity, double, double, String)</code> etc.</li>
<li><a href="lib/src/com/mapswithme/maps/api/MWMPoint.java" title="MWMPoint.java">com.mapswithme.maps.api.MWMPoint</a> - model of POI, includes lat, lon, name, id, and style data.</li>
<li><a href="lib/src/com/mapswithme/maps/api/MWMResponse.java" title="MWMResponse.java">com.mapswithme.maps.api.MWMResponse</a> - helps you to extract response from MapsWithMe by applying <code>MWMResponse.extractFromIntent(Intent)</code> to Intent. Contains MWMPoint data.</li>
</ul>
<h3>Show Points on the Map</h3>
<p>The simplest usage:</p>
<pre><code>public class MyPerfectActivity extends Activity {
...
void showSomethingOnTheMap(SomeDomainObject arg)
{
// Do some work, create lat, lon, and name for point
final double lat = ...;
final double lon = ...;
final String name = ...;
// Ask MapsWithMe to show the point
MapsWithMeApi.showPointOnMap(this, lat, lon, name);
}
...
}
</code></pre>
<p>For multiple points use <a href="lib/src/com/mapswithme/maps/api/MWMPoint.java" title="MWMPoint.java">MWMPoint</a> class:</p>
<pre><code>void showMultiplePoints(List&lt;SomeDomainObject&gt; list)
{
// Convert objects to MMWPoints
final MWMPoint[] points = new MWMPoint[list.length];
for (int i = 0; i &lt; list.size; i++)
{
// Get lat, lon, and name from object and assign it to new MMWPoint
points[i] = new MWMPoint(lat, lon, name);
}
// Show all point on the map, you could also provide some title
MapsWithMeApi.showPointsOnMap(this, &quot;Look at my points, my points are amazing!&quot;, points);
}
</code></pre>
<h3>Ask MapsWithMe to Call my App</h3>
<p>We support PendingIntent interaction (just like Android native
NotificationManager does). You should specify ID for each point to
distinguish it later, and PentingIntent that MapsWithMe will send back to
your application when user press &quot;More Info&quot; button :</p>
<pre><code>// Here is how to pass points with ID ant PendingIntent
void showMultiplePointsWithPendingIntent(List&lt;SomeDomainObject&gt; list, PendingIntent pendingIntent)
{
// Convert objects to MWMPoints
final MWMPoint[] points = new MWMPoint[list.length];
for (int i = 0; i &lt; list.size; i++)
{
// ||
// ||
// \/
// Now you should specify string ID for each point
points[i] = new MWMPoint(lat, lon, name, id);
}
// Show all points on the map, you could also provide some title
MapsWithMeApi.showPointsOnMap(this, &quot;This title says that user should choose some point&quot;, pendingIntent, points);
}
//Code below shows general way to extract response data
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
// Handle intent you specified with PandingIntent
// Now it has additional information (MWMPoint).
handleIntent(getIntent());
}
@Override
protected void onNewIntent(Intent intent)
{
super.onNewIntent(intent);
// if defined your activity as &quot;SingleTop&quot;- you should use onNewIntent callback
handleIntent(intent);
}
void handleIntent(Intent intent)
{
// Apply MWMResponse extraction method to intent
final MWMResponse mwmResponse = MWMResponse.extractFromIntent(this, intent);
// Here is your point that user selected
final MWMPoint point = mwmResponse.getPoint();
// Now, for instance you can do some work depending on point id
processUserInteraction(point.getId());
}
</code></pre>
<h2>FAQ</h2>
<h4>How should I detect if user has MapsWithMe installed?</h4>
<p><code>MapsWithMeApi.isMapsWithMeInstalled(Context)</code> will return <code>true</code> if user has <em>Lite</em> or <em>Pro</em> version that supports API call installed.</p>
<h4>Which versions of MapsWithMe support API calls?</h4>
<p>All versions since 2.4.0 and above support API calls.</p>
<h4>What will happen if I call for <code>MapsWithMeApi.showPoint()</code> but MapsWithMe application is not installed?</h4>
<p>Nothing serious. API library will show simple dialog with gentle offer to download MapsWithMe. You can see how it looks like below. <img src="site/images/dlg.png" alt="Please install us"></p>
<h2>Sample Code and Application</h2>
<ul>
<li><a href="http://play.google.com/store/apps/details?id=com.mapswithme.capitals" title="Api Demo .apk">Sample Application at Google Play</a></li>
<li><a href="https://github.com/mapswithme/api-android/tree/master/sample-app-capitals" title="Api Source Code">Sample Application Source Code</a></li>
</ul>
<h2>Support</h2>
<p>If you have any questions please email to <a href="mailto:api@maps.me" title="MAPS.ME Support Contact">api@mapswith.me</a>.</p>
<hr>
<h2>API Code License</h2>
<p>Copyright (c) 2014, MapsWithMe GmbH
All rights reserved.</p>
<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p>
<ul>
<li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</li>
<li>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.</li>
</ul>
<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot; 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.</p>

80
README.md
View file

@ -1,40 +1,38 @@
# maps.me Android API: Getting Started
# Organic Maps Android API: Getting Started
## Introduction
NOTE: We have changed the name of our maps from MapsWithMe to MAPS.ME, but left all references below unchanged.
MapsWithMe Android API (hereinafter referred to as *"API Library"* or just *"library"*)
Organic Maps Android API (hereinafter referred to as *"API Library"* or just *"library"*)
provides interface for client application to perform next tasks:
* Show one or more points on offline map of [MapsWithMe Application][linkMwm]
* Come back to the client application after selecting specific point on the map, by sending [PendingIntent][linkPIntent] with point data when user asks for more information by pressing "More Info" button in MapsWithMe Application
* Show one or more points on offline map of [Organic Maps app][linkOM]
* Come back to the client application after selecting specific point on the map, by sending [PendingIntent][linkPIntent] with point data when user asks for more information by pressing "More Info" button in Organic Maps app
* Map screen branding : your application's icon and name (or custom title) will be placed at the top.
Thus, you can provide **two way communication between your application and MapsWithMe**,
using MapsWithMe to show points of interest (POI) and providing more information in your app.
Thus, you can provide **two way communication between your application and Organic Maps**,
using Organic Maps to show points of interest (POI) and providing more information in your app.
Please refer to [sample application][linkSampleSource] for demo or see
our [travel guide apps][linkTravelGuides] as an API integration example.
Please refer to [sample application][linkSampleSource] for demo.
## Prerequisites
It is supposed that you are familiar with Android Development, and you have Android SDK and Eclipse (or another IDE of your choice) installed.
It is supposed that you are familiar with Android Development.
You should be familiar with concept of [Intents][linkIntents], [library projects][linkLibProj], and [PendingIntents][linkPIntent] (recommended) as well.
Your application must target at least *android sdk version 9*.
Organic Maps works from *Android SDK version 21 (Android 5)* and above
## Integration
First step is to clone [repository][linkRepo] or download it as an archive.
When your are done you find two folders: *lib* and *sample-app-capitals*. First one is a library project that you should add to your project.
You don't need any additional permissions in your AndroidManifest.xml to use API library, so you can write real code straight away, calling for different `MapsWithMeApi` methods (more details below).
You don't need any additional permissions in your AndroidManifest.xml to use API library, so you can write real code straight away, calling for different `OrganicMapsApi` methods (more details below).
## Classes Overview and HOW TO
Core classes you will work with are:
* [com.mapswithme.maps.api.MapsWithMeApi][linkApiClass] - static class with methods such as `showPointOnMap(Activity, double, double, String)` etc.
* [com.mapswithme.maps.api.MWMPoint][linkPointClass] - model of POI, includes lat, lon, name, id, and style data.
* [com.mapswithme.maps.api.MWMResponse][linkRespClass] - helps you to extract response from MapsWithMe by applying `MWMResponse.extractFromIntent(Intent)` to Intent. Contains MWMPoint data.
* [app.organicmaps.api.OrganicMapsApi][linkApiClass] - static class with methods such as `showPointOnMap(Activity, double, double, String)` etc.
* [app.organicmaps.api.OMPoint][linkPointClass] - model of POI, includes lat, lon, name, id, and style data.
* [app.organicmaps.api.OMResponse][linkRespClass] - helps you to extract response from Organic Maps by applying `OMResponse.extractFromIntent(Intent)` to Intent. Contains OMPoint data.
### Show Points on the Map
@ -49,51 +47,51 @@ The simplest usage:
final double lat = ...;
final double lon = ...;
final String name = ...;
// Ask MapsWithMe to show the point
MapsWithMeApi.showPointOnMap(this, lat, lon, name);
// Ask Organic Maps to show the point
OrganicMapsApi.showPointOnMap(this, lat, lon, name);
}
...
}
For multiple points use [MWMPoint][linkPointClass] class:
For multiple points use [OMPoint][linkPointClass] class:
void showMultiplePoints(List<SomeDomainObject> list)
{
// Convert objects to MMWPoints
final MWMPoint[] points = new MWMPoint[list.length];
final OMPoint[] points = new OMPoint[list.length];
for (int i = 0; i < list.size; i++)
{
// Get lat, lon, and name from object and assign it to new MMWPoint
points[i] = new MWMPoint(lat, lon, name);
points[i] = new OMPoint(lat, lon, name);
}
// Show all point on the map, you could also provide some title
MapsWithMeApi.showPointsOnMap(this, "Look at my points, my points are amazing!", points);
OrganicMapsApi.showPointsOnMap(this, "Look at my points, my points are amazing!", points);
}
### Ask MapsWithMe to Call my App
### Ask Organic Maps to Call my App
We support PendingIntent interaction (just like Android native
NotificationManager does). You should specify ID for each point to
distinguish it later, and PentingIntent that MapsWithMe will send back to
distinguish it later, and PentingIntent that Organic Maps will send back to
your application when user press "More Info" button :
// Here is how to pass points with ID ant PendingIntent
void showMultiplePointsWithPendingIntent(List<SomeDomainObject> list, PendingIntent pendingIntent)
{
// Convert objects to MWMPoints
final MWMPoint[] points = new MWMPoint[list.length];
// Convert objects to OMPoints
final OMPoint[] points = new OMPoint[list.length];
for (int i = 0; i < list.size; i++)
{
// ||
// ||
// \/
// Now you should specify string ID for each point
points[i] = new MWMPoint(lat, lon, name, id);
points[i] = new OMPoint(lat, lon, name, id);
}
// Show all points on the map, you could also provide some title
MapsWithMeApi.showPointsOnMap(this, "This title says that user should choose some point", pendingIntent, points);
OrganicMapsApi.showPointsOnMap(this, "This title says that user should choose some point", pendingIntent, points);
}
//Code below shows general way to extract response data
@ -102,7 +100,7 @@ your application when user press "More Info" button :
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
// Handle intent you specified with PandingIntent
// Now it has additional information (MWMPoint).
// Now it has additional information (OMPoint).
handleIntent(getIntent());
}
@ -116,24 +114,24 @@ your application when user press "More Info" button :
void handleIntent(Intent intent)
{
// Apply MWMResponse extraction method to intent
final MWMResponse mwmResponse = MWMResponse.extractFromIntent(this, intent);
// Apply OMResponse extraction method to intent
final OMResponse mwmResponse = OMResponse.extractFromIntent(this, intent);
// Here is your point that user selected
final MWMPoint point = mwmResponse.getPoint();
final OMPoint point = mwmResponse.getPoint();
// Now, for instance you can do some work depending on point id
processUserInteraction(point.getId());
}
## FAQ
#### How should I detect if user has MapsWithMe installed?
`MapsWithMeApi.isMapsWithMeInstalled(Context)` will return `true` if user has *Lite* or *Pro* version that supports API call installed.
#### How should I detect if user has Organic Maps installed?
`OrganicMapsApi.isOrganicMapsInstalled(Context)` will return `true` if user has *Lite* or *Pro* version that supports API call installed.
#### Which versions of MapsWithMe support API calls?
#### Which versions of Organic Maps support API calls?
All versions since 2.4.0 and above support API calls.
#### What will happen if I call for `MapsWithMeApi.showPoint()` but MapsWithMe application is not installed?
Nothing serious. API library will show simple dialog with gentle offer to download MapsWithMe. You can see how it looks like below.
#### What will happen if I call for `OrganicMapsApi.showPoint()` but Organic Maps application is not installed?
Nothing serious. API library will show simple dialog with gentle offer to download Organic Maps. You can see how it looks like below.
![Please install us](site/images/dlg.png)
@ -154,14 +152,14 @@ Redistribution and use in source and binary forms, with or without modification,
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.
[linkMwm]: https://maps.me/ "MAPS.ME"
[linkOM]: https://organicmaps.app/ "Organic Maps"
[linkPIntent]: http://developer.android.com/reference/android/app/PendingIntent.html "PendingIntent"
[linkRepo]: https://github.com/mapswithme/api-android "GitHub Repository"
[linkLibProj]: http://developer.android.com/tools/projects/index.html#LibraryProjects "Android Library Project"
[linkIntents]: http://developer.android.com/guide/components/intents-filters.html "Intents and Intent Filters"
[linkApiClass]: lib/src/com/mapswithme/maps/api/MapsWithMeApi.java "MapsWithMeApi.java"
[linkPointClass]: lib/src/com/mapswithme/maps/api/MWMPoint.java "MWMPoint.java"
[linkRespClass]: lib/src/com/mapswithme/maps/api/MWMResponse.java "MWMResponse.java"
[linkApiClass]: lib/src/com/mapswithme/maps/api/OrganicMapsApi.java "OrganicMapsApi.java"
[linkPointClass]: lib/src/com/mapswithme/maps/api/OMPoint.java "OMPoint.java"
[linkRespClass]: lib/src/com/mapswithme/maps/api/OMResponse.java "OMResponse.java"
[linkSampleSource]: https://github.com/mapswithme/api-android/tree/master/sample-app-capitals "Api Source Code"
[linkSampleGooglePlay]: http://play.google.com/store/apps/details?id=com.mapswithme.capitals "Api Demo .apk"
[linkTravelGuides]: http://www.guidewithme.com

4
lib/AndroidManifest.xml
View file

@ -1,8 +1,8 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.mapwithme.maps.api"
package="app.organicmaps.api"
android:versionCode="1"
android:versionName="1.0" >
<application />
</manifest>
</manifest>

4
lib/res/layout/dlg_install_mwm.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright (c) 2013, MapsWithMe GmbH All rights reserved.
Copyright (c) 2022, Organic Maps OÜ. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
@ -56,4 +56,4 @@
</LinearLayout>
</ScrollView>
</ScrollView>

8
lib/res/values/strings.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string name="mwm_should_be_installed">Offline maps are required to proceed. We have partnered with MAPS.ME to provide you with offline maps of the entire world.\nTo continue please download the app:</string>
<string name="down_pro">Download MAPS.ME</string>
<string name="url_pro">http://maps.me/get</string>
</resources>
<string name="mwm_should_be_installed">Organic Maps app is required to proceed. We have integrated with Organic Maps to provide you with offline maps of the entire world.\nTo continue please download the app:</string>
<string name="download">Download Organic Maps</string>
<string name="url">https://omaps.app/get?api</string>
</resources>

18
lib/src/com/mapswithme/maps/api/Const.java
View file

@ -1,5 +1,5 @@
/******************************************************************************
Copyright (c) 2013, MapsWithMe GmbH All rights reserved.
Copyright (c) 2022, Organic Maps OÜ. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
@ -20,13 +20,13 @@
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
******************************************************************************/
package com.mapswithme.maps.api;
package app.organicmaps.api;
public class Const
{
/* Request extras */
static final String AUTHORITY = "com.mapswithme.maps.api";
static final String AUTHORITY = "app.organicmaps.api";
public static final String EXTRA_URL = AUTHORITY + ".url";
public static final String EXTRA_TITLE = AUTHORITY + ".title";
public static final String EXTRA_API_VERSION = AUTHORITY + ".version";
@ -40,14 +40,14 @@ public class Const
/* Response extras */
/* Point part-by-part*/
public static final String EXTRA_MWM_RESPONSE_POINT_NAME = AUTHORITY + ".point_name";
public static final String EXTRA_MWM_RESPONSE_POINT_LAT = AUTHORITY + ".point_lat";
public static final String EXTRA_MWM_RESPONSE_POINT_LON = AUTHORITY + ".point_lon";
public static final String EXTRA_MWM_RESPONSE_POINT_ID = AUTHORITY + ".point_id";
public static final String EXTRA_MWM_RESPONSE_ZOOM = AUTHORITY + ".zoom_level";
public static final String EXTRA_OM_RESPONSE_POINT_NAME = AUTHORITY + ".point_name";
public static final String EXTRA_OM_RESPONSE_POINT_LAT = AUTHORITY + ".point_lat";
public static final String EXTRA_OM_RESPONSE_POINT_LON = AUTHORITY + ".point_lon";
public static final String EXTRA_OM_RESPONSE_POINT_ID = AUTHORITY + ".point_id";
public static final String EXTRA_OM_RESPONSE_ZOOM = AUTHORITY + ".zoom_level";
public static final String ACTION_MWM_REQUEST = AUTHORITY + ".request";
public static final String ACTION_OM_REQUEST = AUTHORITY + ".request";
static final int API_VERSION = 2;
static final String CALLBACK_PREFIX = "mapswithme.client.";

12
lib/src/com/mapswithme/maps/api/DownloadMapsWithMeDialog.java
View file

@ -1,5 +1,5 @@
/******************************************************************************
Copyright (c) 2013, MapsWithMe GmbH All rights reserved.
Copyright (c) 2022, Organic Maps OÜ. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
@ -20,7 +20,7 @@
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
******************************************************************************/
package com.mapswithme.maps.api;
package app.organicmaps.api;
import android.app.Activity;
import android.app.Dialog;
@ -29,12 +29,12 @@ import android.net.Uri;
import android.view.View;
import android.view.Window;
import com.mapwithme.maps.api.R;
import app.organicmaps.api.R;
public class DownloadMapsWithMeDialog extends Dialog implements android.view.View.OnClickListener
public class DownloadOrganicMapsDialog extends Dialog implements android.view.View.OnClickListener
{
public DownloadMapsWithMeDialog(Activity activity)
public DownloadOrganicMapsDialog(Activity activity)
{
super(activity);
@ -58,7 +58,7 @@ public class DownloadMapsWithMeDialog extends Dialog implements android.view.Vie
@Override
public void onClick(View v)
{
String url = getContext().getString(R.string.url_pro);
String url = getContext().getString(R.string.url);
onDownloadButtonClicked(url);
}
}

27
lib/src/com/mapswithme/maps/api/MWMPoint.java
View file

@ -1,5 +1,5 @@
/******************************************************************************
Copyright (c) 2013, MapsWithMe GmbH All rights reserved.
Copyright (c) 2022, Organic Maps OÜ. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
@ -20,7 +20,7 @@
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
******************************************************************************/
package com.mapswithme.maps.api;
package app.organicmaps.api;
import java.io.Serializable;
@ -29,7 +29,7 @@ import java.io.Serializable;
* Has its <code>equals()</code> and <code>hashCode()</code> methods overloaded
* so could be used in Hash(Map/Set/etc) classes.
*/
public final class MWMPoint implements Serializable
public final class OMPoint implements Serializable
{
private static final long serialVersionUID = 1L;
@ -39,12 +39,12 @@ public final class MWMPoint implements Serializable
private String mId;
private Style mStyle;
public MWMPoint(double lat, double lon, String name)
public OMPoint(double lat, double lon, String name)
{
this(lat, lon, name, null);
}
public MWMPoint(double lat, double lon, String name, String id)
public OMPoint(double lat, double lon, String name, String id)
{
this.mLat = lat;
this.mLon = lon;
@ -52,7 +52,7 @@ public final class MWMPoint implements Serializable
this.mId = id;
}
public MWMPoint(double lat, double lon, String name, String id, Style style)
public OMPoint(double lat, double lon, String name, String id, Style style)
{
this.mLat = lat;
this.mLon = lon;
@ -89,7 +89,7 @@ public final class MWMPoint implements Serializable
@Override
public String toString()
{
return "MWMPoint [lat=" + mLat +
return "OMPoint [lat=" + mLat +
", lon=" + mLon +
", name=" + mName +
", id=" + mId +
@ -123,7 +123,7 @@ public final class MWMPoint implements Serializable
return false;
if (getClass() != obj.getClass())
return false;
final MWMPoint other = (MWMPoint) obj;
final OMPoint other = (OMPoint) obj;
if (Double.doubleToLongBits(mLat) != Double.doubleToLongBits(other.mLat))
return false;
if (Double.doubleToLongBits(mLon) != Double.doubleToLongBits(other.mLon))
@ -133,7 +133,7 @@ public final class MWMPoint implements Serializable
}
/**
* Supported styles for MAPS.ME. Each appears as a small flag of the appropriate colour.
* Supported styles for Organic Maps. Each appears as a small flag of the appropriate colour.
*/
public enum Style
{
@ -145,6 +145,15 @@ public final class MWMPoint implements Serializable
PlacemarkBrown("placemark-brown"),
PlacemarkGreen("placemark-green"),
PlacemarkOrange("placemark-orange");
// TODO: Add
// placemark-bluegray
// placemark-cyan
// placemark-deeporange
// placemark-deeppurple
// placemark-gray
// placemark-lightblue
// placemark-lime
// placemark-teal
private String name;

32
lib/src/com/mapswithme/maps/api/MWMResponse.java
View file

@ -1,5 +1,5 @@
/******************************************************************************
Copyright (c) 2013, MapsWithMe GmbH All rights reserved.
Copyright (c) 2022, Organic Maps OÜ. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
@ -20,28 +20,28 @@
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
******************************************************************************/
package com.mapswithme.maps.api;
package app.organicmaps.api;
import android.content.Context;
import android.content.Intent;
public class MWMResponse
public class OMResponse
{
private MWMPoint mPoint;
private OMPoint mPoint;
private double mZoomLevel;
/**
*
* @return point, for which user requested more information in MapsWithMe application.
* @return point, for which user requested more information in Organic Maps application.
*/
public MWMPoint getPoint() { return mPoint; }
public OMPoint getPoint() { return mPoint; }
public boolean hasPoint() { return mPoint != null; }
public double getZoomLevel() { return mZoomLevel; }
@Override
public String toString()
{
return "MWMResponse [SelectedPoint=" + mPoint + "]";
return "OMResponse [SelectedPoint=" + mPoint + "]";
}
/**
@ -51,20 +51,20 @@ public class MWMResponse
* @param intent
* @return
*/
public static MWMResponse extractFromIntent(Context context, Intent intent)
public static OMResponse extractFromIntent(Context context, Intent intent)
{
final MWMResponse response = new MWMResponse();
final OMResponse response = new OMResponse();
// parse point
final double lat = intent.getDoubleExtra(Const.EXTRA_MWM_RESPONSE_POINT_LAT, INVALID_LL);
final double lon = intent.getDoubleExtra(Const.EXTRA_MWM_RESPONSE_POINT_LON, INVALID_LL);
final String name = intent.getStringExtra(Const.EXTRA_MWM_RESPONSE_POINT_NAME);
final String id = intent.getStringExtra(Const.EXTRA_MWM_RESPONSE_POINT_ID);
final double lat = intent.getDoubleExtra(Const.EXTRA_OM_RESPONSE_POINT_LAT, INVALID_LL);
final double lon = intent.getDoubleExtra(Const.EXTRA_OM_RESPONSE_POINT_LON, INVALID_LL);
final String name = intent.getStringExtra(Const.EXTRA_OM_RESPONSE_POINT_NAME);
final String id = intent.getStringExtra(Const.EXTRA_OM_RESPONSE_POINT_ID);
// parse additional info
response.mZoomLevel = intent.getDoubleExtra(Const.EXTRA_MWM_RESPONSE_ZOOM, 9);
response.mZoomLevel = intent.getDoubleExtra(Const.EXTRA_OM_RESPONSE_ZOOM, 9);
if (lat != INVALID_LL && lon != INVALID_LL)
response.mPoint = new MWMPoint(lat, lon, name, id);
response.mPoint = new OMPoint(lat, lon, name, id);
else
response.mPoint = null;
@ -73,5 +73,5 @@ public class MWMResponse
private final static double INVALID_LL = Double.MIN_VALUE;
private MWMResponse() {}
private OMResponse() {}
}

34
lib/src/com/mapswithme/maps/api/MapsWithMeApi.java
View file

@ -1,5 +1,5 @@
/******************************************************************************
Copyright (c) 2013, MapsWithMe GmbH All rights reserved.
Copyright (c) 2022, Organic Maps OÜ. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
@ -20,7 +20,7 @@
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
******************************************************************************/
package com.mapswithme.maps.api;
package app.organicmaps.api;
import android.app.Activity;
import android.app.PendingIntent;
@ -30,7 +30,7 @@ import android.content.pm.ActivityInfo;
import android.net.Uri;
public final class MapsWithMeApi
public final class OrganicMapsApi
{
/**
@ -43,7 +43,7 @@ public final class MapsWithMeApi
public static final double ZOOM_MIN = 1;
public static void showMapsWithMeUrl(Activity caller, PendingIntent pendingIntent, double zoomLevel, String url)
public static void showOrganicMapsUrl(Activity caller, PendingIntent pendingIntent, double zoomLevel, String url)
{
final Uri uri = Uri.parse(url);
final String latlon[] = uri.getQueryParameter("ll").split(",");
@ -52,14 +52,14 @@ public final class MapsWithMeApi
final String name = uri.getQueryParameter("n");
final String id = uri.getQueryParameter("id");
showPointsOnMap(caller, name, zoomLevel, pendingIntent, new MWMPoint(lat, lon, name, id));
showPointsOnMap(caller, name, zoomLevel, pendingIntent, new OMPoint(lat, lon, name, id));
}
public static void sendRequest(Activity caller, MwmRequest request)
{
final Intent mwmIntent = request.toIntent(caller);
if (isMapsWithMeInstalled(caller))
if (isOrganicMapsInstalled(caller))
{
// Match activity for intent
final ActivityInfo aInfo = caller.getPackageManager().resolveActivity(mwmIntent, 0).activityInfo;
@ -67,7 +67,7 @@ public final class MapsWithMeApi
caller.startActivity(mwmIntent);
}
else
(new DownloadMapsWithMeDialog(caller)).show();
(new DownloadOrganicMapsDialog(caller)).show();
}
/**
@ -80,12 +80,12 @@ public final class MapsWithMeApi
*/
public static void showPointOnMap(Activity caller, double lat, double lon, String name)
{
showPointsOnMap(caller, (String) null, (PendingIntent) null, new MWMPoint(lat, lon, name));
showPointsOnMap(caller, (String) null, (PendingIntent) null, new OMPoint(lat, lon, name));
}
/**
* Shows single point on the map using specified zoom level in range from
* {@link MapsWithMeApi#ZOOM_MIN} to {@link MapsWithMeApi#ZOOM_MAX}.
* {@link OrganicMapsApi#ZOOM_MIN} to {@link OrganicMapsApi#ZOOM_MAX}.
*
* @param caller
* @param lat
@ -95,7 +95,7 @@ public final class MapsWithMeApi
*/
public static void showPointOnMap(Activity caller, double lat, double lon, String name, double zoomLevel)
{
showPointsOnMap(caller, (String) null, zoomLevel, (PendingIntent) null, new MWMPoint(lat, lon, name));
showPointsOnMap(caller, (String) null, zoomLevel, (PendingIntent) null, new OMPoint(lat, lon, name));
}
/**
@ -105,13 +105,13 @@ public final class MapsWithMeApi
* @param title
* @param points
*/
public static void showPointsOnMap(Activity caller, String title, MWMPoint... points)
public static void showPointsOnMap(Activity caller, String title, OMPoint... points)
{
showPointsOnMap(caller, title, null, points);
}
/**
* Shows set of points on the maps and allows MapsWithMeApplication to send
* Shows set of points on the maps and allows OrganicMapsApplication to send
* {@link PendingIntent} provided by client application.
*
* @param caller
@ -119,13 +119,13 @@ public final class MapsWithMeApi
* @param pendingIntent
* @param points
*/
public static void showPointsOnMap(Activity caller, String title, PendingIntent pendingIntent, MWMPoint... points)
public static void showPointsOnMap(Activity caller, String title, PendingIntent pendingIntent, OMPoint... points)
{
showPointsOnMap(caller, title, -1, pendingIntent, points);
}
private static void showPointsOnMap(Activity caller, String title, double zoomLevel, PendingIntent pendingIntent,
MWMPoint... points)
OMPoint... points)
{
final MwmRequest request = new MwmRequest()
.setTitle(title)
@ -145,15 +145,15 @@ public final class MapsWithMeApi
}
/**
* Detects if any version (Lite, Pro) of MapsWithMe, which supports API calls
* Detects if any version (Lite, Pro) of Organic Maps, which supports API calls
* are installed on the device.
*
* @param context
* @return
*/
public static boolean isMapsWithMeInstalled(Context context)
public static boolean isOrganicMapsInstalled(Context context)
{
final Intent intent = new Intent(Const.ACTION_MWM_REQUEST);
final Intent intent = new Intent(Const.ACTION_OM_REQUEST);
return context.getPackageManager().resolveActivity(intent, 0) != null;
}
}

24
lib/src/com/mapswithme/maps/api/MwmRequest.java
View file

@ -1,4 +1,4 @@
package com.mapswithme.maps.api;
package app.organicmaps.api;
import java.util.ArrayList;
import java.util.Arrays;
@ -16,7 +16,7 @@ public class MwmRequest
{
// **
private List<MWMPoint> mPoints = new ArrayList<MWMPoint>();
private List<OMPoint> mPoints = new ArrayList<OMPoint>();
private PendingIntent mPendingIntent;
private String mTitle;
private double mZoomLevel = 1;
@ -43,7 +43,7 @@ public class MwmRequest
return this;
}
public MwmRequest addPoint(MWMPoint point)
public MwmRequest addPoint(OMPoint point)
{
mPoints.add(point);
return this;
@ -51,12 +51,12 @@ public class MwmRequest
public MwmRequest addPoint(double lat, double lon, String name, String id)
{
return addPoint(new MWMPoint(lat, lon, name, id));
return addPoint(new OMPoint(lat, lon, name, id));
}
public MwmRequest setPoints(Collection<MWMPoint> points)
public MwmRequest setPoints(Collection<OMPoint> points)
{
mPoints = new ArrayList<MWMPoint>(points);
mPoints = new ArrayList<OMPoint>(points);
return this;
}
@ -80,7 +80,7 @@ public class MwmRequest
public Intent toIntent(Context context)
{
final Intent mwmIntent = new Intent(Const.ACTION_MWM_REQUEST);
final Intent mwmIntent = new Intent(Const.ACTION_OM_REQUEST);
// url
final String mwmUrl = createMwmUrl(context, mTitle, mZoomLevel, mPoints).toString();
@ -109,14 +109,14 @@ public class MwmRequest
* This method is internal only.
* Used for compatibility.
*/
MwmRequest setPoints(MWMPoint[] points)
MwmRequest setPoints(OMPoint[] points)
{
return setPoints(Arrays.asList(points));
}
// Below are utilities from MapsWithMeApi because we are not "Feature Envy"
// Below are utilities from OrganicMapsApi because we are not "Feature Envy"
private static StringBuilder createMwmUrl(Context context, String title, double zoomLevel, List<MWMPoint> points)
private static StringBuilder createMwmUrl(Context context, String title, double zoomLevel, List<OMPoint> points)
{
final StringBuilder urlBuilder = new StringBuilder("mapswithme://map?");
// version
@ -129,7 +129,7 @@ public class MwmRequest
appendIfNotNull(urlBuilder, "z", isValidZoomLevel(zoomLevel) ? String.valueOf(zoomLevel) : null);
// points
for (final MWMPoint point : points)
for (final OMPoint point : points)
{
if (point != null)
{
@ -168,7 +168,7 @@ public class MwmRequest
private static boolean isValidZoomLevel(double zoom)
{
return zoom >= MapsWithMeApi.ZOOM_MIN && zoom <= MapsWithMeApi.ZOOM_MAX;
return zoom >= OrganicMapsApi.ZOOM_MIN && zoom <= OrganicMapsApi.ZOOM_MAX;
}
}

11
readme_to_html.sh
View file

@ -1,11 +0,0 @@
#!/bin/bash
set -e -u -x
## This script converts .md file to .html and opens it in browser.
## Please install next gems to use it:
## gem install redcarpet
## gem install github-markup
github-markup README.md > README.html
open README.html

4
sample-app-capitals/AndroidManifest.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright (c) 2013, MapsWithMe GmbH All rights reserved.
Copyright (c) 2022, Organic Maps OÜ. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
@ -53,4 +53,4 @@
</application>
</manifest>
</manifest>

2
sample-app-capitals/res/layout/capitals_list_activity.xml
View file

@ -1,5 +1,5 @@
<!--
Copyright (c) 2013, MapsWithMe GmbH All rights reserved.
Copyright (c) 2022, Organic Maps OÜ. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

4
sample-app-capitals/res/layout/city_details_activity.xml
View file

@ -1,5 +1,5 @@
<!--
Copyright (c) 2013, MapsWithMe GmbH All rights reserved.
Copyright (c) 2022, Organic Maps OÜ. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
@ -189,4 +189,4 @@
</LinearLayout>
</LinearLayout>
</ScrollView>
</ScrollView>

18
sample-app-capitals/src/com/mapswithme/capitals/CapitalsListActivity.java
View file

@ -1,5 +1,5 @@
/******************************************************************************
Copyright (c) 2013, MapsWithMe GmbH All rights reserved.
Copyright (c) 2022, Organic Maps OÜ. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
@ -32,8 +32,8 @@ import android.widget.ArrayAdapter;
import android.widget.ListView;
import android.widget.TextView;
import com.mapswithme.maps.api.MWMPoint;
import com.mapswithme.maps.api.MapsWithMeApi;
import app.organicmaps.api.OMPoint;
import app.organicmaps.api.OrganicMapsApi;
public class CapitalsListActivity extends ListActivity
{
@ -51,7 +51,7 @@ public class CapitalsListActivity extends ListActivity
findViewById(R.id.btn_all).setOnClickListener(new OnClickListener()
{
@Override
public void onClick(View v) { showCityOnMWMMap(City.CAPITALS); }
public void onClick(View v) { showCityOnOMMap(City.CAPITALS); }
});
}
@ -59,17 +59,17 @@ public class CapitalsListActivity extends ListActivity
@Override
protected void onListItemClick(ListView l, View v, int position, long id)
{
showCityOnMWMMap(mCityAdapter.getItem(position));
showCityOnOMMap(mCityAdapter.getItem(position));
}
private void showCityOnMWMMap(City ... cities)
private void showCityOnOMMap(City ... cities)
{
MWMPoint[] points = new MWMPoint[cities.length];
OMPoint[] points = new OMPoint[cities.length];
for (int i = 0; i < cities.length; i++)
points[i] = cities[i].toMWMPoint();
points[i] = cities[i].toOMPoint();
final String title = cities.length == 1 ? cities[0].getName() : "Capitals of the World";
MapsWithMeApi.showPointsOnMap(this, title, CityDetailsActivity.getPendingIntent(this), points);
OrganicMapsApi.showPointsOnMap(this, title, CityDetailsActivity.getPendingIntent(this), points);
}
private static class CityAdapter extends ArrayAdapter<City>

8
sample-app-capitals/src/com/mapswithme/capitals/City.java
View file

@ -1,5 +1,5 @@
/******************************************************************************
Copyright (c) 2013, MapsWithMe GmbH All rights reserved.
Copyright (c) 2022, Organic Maps OÜ. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
@ -22,7 +22,7 @@
******************************************************************************/
package com.mapswithme.capitals;
import com.mapswithme.maps.api.MWMPoint;
import app.organicmaps.api.OMPoint;
import java.util.Arrays;
import java.util.Comparator;
@ -56,7 +56,7 @@ public class City
@Override
public String toString() { return name; }
public MWMPoint toMWMPoint() { return new MWMPoint(lat, lon, name, id); }
public OMPoint toOMPoint() { return new OMPoint(lat, lon, name, id); }
public String getId() { return id; }
public String getName() { return name; }
@ -69,7 +69,7 @@ public class City
public String getAltNames() { return altNames; }
public static City fromMWMPoint(MWMPoint point)
public static City fromOMPoint(OMPoint point)
{
City result = null;
final String id = point.getId();

20
sample-app-capitals/src/com/mapswithme/capitals/CityDetailsActivity.java
View file

@ -1,5 +1,5 @@
/******************************************************************************
Copyright (c) 2013, MapsWithMe GmbH All rights reserved.
Copyright (c) 2022, Organic Maps OÜ. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
@ -31,12 +31,12 @@ import android.view.View;
import android.view.View.OnClickListener;
import android.widget.TextView;
import com.mapswithme.maps.api.MWMResponse;
import com.mapswithme.maps.api.MapsWithMeApi;
import app.organicmaps.api.OMResponse;
import app.organicmaps.api.OrganicMapsApi;
public class CityDetailsActivity extends Activity
{
public static String EXTRA_FROM_MWM = "from-maps-with-me";
public static String EXTRA_FROM_OM = "from-maps-with-me";
private TextView mName;
private TextView mAltNames;
@ -54,7 +54,7 @@ public class CityDetailsActivity extends Activity
public static PendingIntent getPendingIntent(Context context)
{
final Intent i = new Intent(context, CityDetailsActivity.class);
i.putExtra(EXTRA_FROM_MWM, true);
i.putExtra(EXTRA_FROM_OM, true);
return PendingIntent.getActivity(context, 0, i, 0);
}
@ -80,9 +80,9 @@ public class CityDetailsActivity extends Activity
@Override
public void onClick(View v)
{
MapsWithMeApi
OrganicMapsApi
.showPointsOnMap(CityDetailsActivity.this,mCity.getName(),
CityDetailsActivity.getPendingIntent(CityDetailsActivity.this),mCity.toMWMPoint());
CityDetailsActivity.getPendingIntent(CityDetailsActivity.this),mCity.toOMPoint());
}
});
@ -98,10 +98,10 @@ public class CityDetailsActivity extends Activity
private void handleIntent(Intent intent)
{
if (intent.getBooleanExtra(EXTRA_FROM_MWM, false))
if (intent.getBooleanExtra(EXTRA_FROM_OM, false))
{
final MWMResponse response = MWMResponse.extractFromIntent(this, intent);
mCity = City.fromMWMPoint(response.getPoint());
final OMResponse response = OMResponse.extractFromIntent(this, intent);
mCity = City.fromOMPoint(response.getPoint());
if (mCity != null)
{