Add basic API methods showPoint(s)OnMap #7

2023-07-27T08:10:06Z

moving-bits commented

2023-07-27 08:10:06 +00:00

(Migrated from github.com)

Adds basic API methods

showPointOnMap
showPointsOnMap

Download dialog is displayed automatically on calling one of those methods, if OrganicMaps package could not be found.

Adds basic API methods - showPointOnMap - showPointsOnMap Download dialog is displayed automatically on calling one of those methods, if OrganicMaps package could not be found.

Jean-BaptisteC commented

2023-08-07 12:44:30 +00:00

(Migrated from github.com)

CC @biodranik

biodranik (Migrated from github.com) approved these changes 2023-08-07 19:54:20 +00:00

biodranik (Migrated from github.com) left a comment

Thanks! Are you using it in your app?

cc @rtsisyk

Thanks! Are you using it in your app? cc @rtsisyk

lib/src/main/java/app/organicmaps/api/OrganicMapsApi.java

biodranik (Migrated from github.com) commented

2023-08-07 19:53:41 +00:00

There are also .beta and .debug packages, may be useful too.

moving-bits commented

2023-08-07 20:19:25 +00:00

(Migrated from github.com)

Thanks! Are you using it in your app?

cc @rtsisyk

Yes, this is code I wrote for c:geo to be able to start navigation in OrganicMaps for a selected geocache from within c:geo. As those functions are mentioned in your readme (probably from mwm times) I thought I'll share it to be included in the API.

> Thanks! Are you using it in your app? > > cc @rtsisyk Yes, this is code I wrote for [c:geo](https://github.com/cgeo/cgeo) to be able to start navigation in OrganicMaps for a selected geocache from within c:geo. As those functions are mentioned in your readme (probably from mwm times) I thought I'll share it to be included in the API.

moving-bits (Migrated from github.com) reviewed 2023-08-07 20:22:34 +00:00

lib/src/main/java/app/organicmaps/api/OrganicMapsApi.java

moving-bits (Migrated from github.com) commented

2023-08-07 20:22:33 +00:00

Can you give me their package names? Then I'll add them to installation detection. Alternatively I could switch installation detection to intent resolver instead of package manager.

biodranik (Migrated from github.com) reviewed 2023-08-07 21:14:22 +00:00

lib/src/main/java/app/organicmaps/api/OrganicMapsApi.java

biodranik (Migrated from github.com) commented

2023-08-07 21:14:22 +00:00

app.organicmaps.debug
app.organicmaps.beta

Can the intent resolver display an "Open with app..." dialog to allow manual app selection?

app.organicmaps.debug app.organicmaps.beta Can the intent resolver display an "Open with app..." dialog to allow manual app selection?

moving-bits (Migrated from github.com) reviewed 2023-08-12 21:42:29 +00:00

lib/src/main/java/app/organicmaps/api/OrganicMapsApi.java

moving-bits (Migrated from github.com) commented

2023-08-12 21:42:29 +00:00

Cannot test it here, don't have the other two packages. Relevant code is in sendRequest().

With regard to installation check: I've changed it to use the intent.resolveActivity() instead of querying the packagemanager.getLaunchIntentForPackage() - this should find any of those package variants, as long as it accepts the intents created by new MapRequest().toIntent()

Cannot test it here, don't have the other two packages. Relevant code is in `sendRequest()`. With regard to installation check: I've changed it to use the `intent.resolveActivity()` instead of querying the `packagemanager.getLaunchIntentForPackage()` - this should find any of those package variants, as long as it accepts the intents created by `new MapRequest().toIntent()`

biodranik (Migrated from github.com) approved these changes 2023-08-12 22:20:41 +00:00

biodranik (Migrated from github.com) left a comment

Thanks! It would be great to test if it works with beta or debug (and how it works with 2+ OM versions installed at the same time, for easier debugging). You can install beta for example from here: https://cdn.organicmaps.app/apk/2023.08.07-10-Google-beta.apk

lib/src/main/AndroidManifest.xml

biodranik (Migrated from github.com) commented

2023-08-12 22:13:49 +00:00

This line should be removed, it's outdated and not relevant.

moving-bits (Migrated from github.com) reviewed 2023-08-12 22:50:09 +00:00

lib/src/main/AndroidManifest.xml

moving-bits (Migrated from github.com) commented

2023-08-12 22:50:09 +00:00

Ok, I thought they would be needed for intent resolution, but it looks like it does work without it. Have removed them.

moving-bits commented

2023-08-12 22:51:36 +00:00

(Migrated from github.com)

Thanks! It would be great to test if it works with beta or debug (and how it works with 2+ OM versions installed at the same time, for easier debugging). You can install beta for example from here: cdn.organicmaps.app/apk/2023.08.07-10-Google-beta.apk

Have tested with release and beta versions being installed at the same time (thanks for the link). Intent resolver dialog pops up in that case:

(Android 13, after having chosen "beta version" for the last call)

> Thanks! It would be great to test if it works with beta or debug (and how it works with 2+ OM versions installed at the same time, for easier debugging). You can install beta for example from here: [cdn.organicmaps.app/apk/2023.08.07-10-Google-beta.apk](https://cdn.organicmaps.app/apk/2023.08.07-10-Google-beta.apk) Have tested with release and beta versions being installed at the same time (thanks for the link). Intent resolver dialog pops up in that case: ![image](https://github.com/organicmaps/api-android/assets/3754370/8a4eaad0-0a84-424f-97b9-3caac7e84855) (Android 13, after having chosen "beta version" for the last call)

biodranik (Migrated from github.com) reviewed 2023-08-12 23:03:17 +00:00

lib/src/main/AndroidManifest.xml

biodranik (Migrated from github.com) commented

2023-08-12 23:03:16 +00:00

I meant com.mapswithme.maps, it should be removed :)

Are you sure that it will work without these lines in manifest? What documentation says?

I meant com.mapswithme.maps, it should be removed :) Are you sure that it will work without these lines in manifest? What documentation says?

moving-bits (Migrated from github.com) reviewed 2023-08-12 23:07:57 +00:00

lib/src/main/AndroidManifest.xml

moving-bits (Migrated from github.com) commented

2023-08-12 23:07:57 +00:00

c:geo does run without those lines. If I remember correctly they are only used when trying to get names of installed packages using the package manager (and only for targetSDK 30+), but not for checking if an intent can be resolved.

biodranik (Migrated from github.com) reviewed 2023-08-13 04:52:12 +00:00

lib/src/main/AndroidManifest.xml

					
				@ -2,3 +2,4 @@

				<manifest xmlns:android="http://schemas.android.com/apk/res/android">

				  <queries>

				    <!-- packages we want to see using the package manager need to be declared starting with targetSDK 30, and we need to use specific strings / cannot use @string/xxx notation -->

				    <package android:name="app.organicmaps"/>

biodranik (Migrated from github.com) commented

2023-08-13 04:52:04 +00:00

So is this line required to detect if the app is installed? How it can be done?

moving-bits (Migrated from github.com) reviewed 2023-08-13 06:33:22 +00:00

lib/src/main/AndroidManifest.xml

					
				@ -2,3 +2,4 @@

				<manifest xmlns:android="http://schemas.android.com/apk/res/android">

				  <queries>

				    <!-- packages we want to see using the package manager need to be declared starting with targetSDK 30, and we need to use specific strings / cannot use @string/xxx notation -->

				    <package android:name="app.organicmaps"/>

moving-bits (Migrated from github.com) commented

2023-08-13 06:33:22 +00:00

No longer needed by my API extension, but generally it can be done like this:

/**
 * This will find installed applications even without launch intent (e.g. the streetview plugin).
 *
 * Be aware:
 * Starting with Android 11 getInstalledPackages() will only return packages declared in AndroidManifest.xml
 * (Add a lint exception, as we have cross-checked our current usages for this method)
 */
@SuppressLint("QueryPermissionsNeeded")
private static boolean hasPackageInstalled(@NonNull final String packageName) {
    final List<PackageInfo> packs = getPackageManager().getInstalledPackages(0);
    for (final PackageInfo packageInfo : packs) {
        if (packageName.equals(packageInfo.packageName)) {
            return true;
        }
    }
    return false;
}

(Code excerpt from c:geos's ProcessUtils.java)

See also https://developer.android.com/training/package-visibility and https://developer.android.com/guide/topics/manifest/queries-element.

No longer needed by my API extension, but generally it can be done like this: ``` /** * This will find installed applications even without launch intent (e.g. the streetview plugin). * * Be aware: * Starting with Android 11 getInstalledPackages() will only return packages declared in AndroidManifest.xml * (Add a lint exception, as we have cross-checked our current usages for this method) */ @SuppressLint("QueryPermissionsNeeded") private static boolean hasPackageInstalled(@NonNull final String packageName) { final List<PackageInfo> packs = getPackageManager().getInstalledPackages(0); for (final PackageInfo packageInfo : packs) { if (packageName.equals(packageInfo.packageName)) { return true; } } return false; } ``` (Code excerpt from c:geos's ProcessUtils.java) See also https://developer.android.com/training/package-visibility and https://developer.android.com/guide/topics/manifest/queries-element.

biodranik (Migrated from github.com) reviewed 2023-08-13 08:54:38 +00:00

lib/src/main/AndroidManifest.xml

					
				@ -2,3 +2,4 @@

				<manifest xmlns:android="http://schemas.android.com/apk/res/android">

				  <queries>

				    <!-- packages we want to see using the package manager need to be declared starting with targetSDK 30, and we need to use specific strings / cannot use @string/xxx notation -->

				    <package android:name="app.organicmaps"/>

biodranik (Migrated from github.com) commented

2023-08-13 08:54:38 +00:00

So this line is actually needed to detect the package, right?
Can you please add this method (and test if it works) into OrganicMapsApi.java?

So this line is actually needed to detect the package, right? Can you please add this method (and test if it works) into OrganicMapsApi.java?

moving-bits (Migrated from github.com) reviewed 2023-08-13 16:36:57 +00:00

lib/src/main/AndroidManifest.xml

					
				@ -2,3 +2,4 @@

				<manifest xmlns:android="http://schemas.android.com/apk/res/android">

				  <queries>

				    <!-- packages we want to see using the package manager need to be declared starting with targetSDK 30, and we need to use specific strings / cannot use @string/xxx notation -->

				    <package android:name="app.organicmaps"/>

moving-bits (Migrated from github.com) commented

2023-08-13 16:36:57 +00:00

Detection can be done in two ways, by checking whether the OrganicMaps-specific intent can be resolved, or by checking installation state for OrganicMaps-related package names.

I've switched to the first option, as it covers all different package names for OrganicMaps variants in one go. For this option it is not necessary to add the package name of OrganicMaps in the <queries> section of AndroidManifest,xml. (It was already there, so I did not change it.)

Are you sure you want to have the second variant (checking package names) added as well?

Detection can be done in two ways, by checking whether the OrganicMaps-specific intent can be resolved, or by checking installation state for OrganicMaps-related package names. I've switched to the first option, as it covers all different package names for OrganicMaps variants in one go. For this option it is not necessary to add the package name of OrganicMaps in the `<queries>` section of `AndroidManifest,xml`. (It was already there, so I did not change it.) Are you sure you want to have the second variant (checking package names) added as well?

biodranik (Migrated from github.com) reviewed 2023-08-13 16:56:59 +00:00

lib/src/main/AndroidManifest.xml

					
				@ -2,3 +2,4 @@

				<manifest xmlns:android="http://schemas.android.com/apk/res/android">

				  <queries>

				    <!-- packages we want to see using the package manager need to be declared starting with targetSDK 30, and we need to use specific strings / cannot use @string/xxx notation -->

				    <package android:name="app.organicmaps"/>

biodranik (Migrated from github.com) commented

2023-08-13 16:56:59 +00:00

What are the pros and cons of both of them compared? Do they both work reliably from Android 5.0 and above? It may make sense to leave two implementations if they have different properties.

moving-bits (Migrated from github.com) reviewed 2023-08-13 18:04:00 +00:00

lib/src/main/AndroidManifest.xml

					
				@ -2,3 +2,4 @@

				<manifest xmlns:android="http://schemas.android.com/apk/res/android">

				  <queries>

				    <!-- packages we want to see using the package manager need to be declared starting with targetSDK 30, and we need to use specific strings / cannot use @string/xxx notation -->

				    <package android:name="app.organicmaps"/>

moving-bits (Migrated from github.com) commented

2023-08-13 18:04:00 +00:00

"intent" method checks whether there is any app that can resolve the intent. As the intent is OM-specific, there will probably only OM servicing this intent (but theoretically there may be others, leading to the chooser dialog).
"package name" method checks for a specific package name, so you can "guarantee" that OM is installed.

But the actual call to the API uses the intent anyway, so I see no real need to check package names upfront. (This would be different for other types of intents such as geo-uris, if you want to have a specific app receiving it.)

I could add the check anyway, but which of the two different methods should sendRequest use then? And what should it do if it gets different results?

My proposal is to stay with only the intent checking method.

"intent" method checks whether there is any app that can resolve the intent. As the intent is OM-specific, there will probably only OM servicing this intent (but theoretically there may be others, leading to the chooser dialog). "package name" method checks for a specific package name, so you can "guarantee" that OM is installed. But the actual call to the API uses the intent anyway, so I see no real need to check package names upfront. (This would be different for other types of intents such as geo-uris, if you want to have a specific app receiving it.) I could add the check anyway, but which of the two different methods should `sendRequest` use then? And what should it do if it gets different results? My proposal is to stay with only the intent checking method.

biodranik (Migrated from github.com) reviewed 2023-08-14 06:53:33 +00:00

lib/src/main/AndroidManifest.xml

					
				@ -2,3 +2,4 @@

				<manifest xmlns:android="http://schemas.android.com/apk/res/android">

				  <queries>

				    <!-- packages we want to see using the package manager need to be declared starting with targetSDK 30, and we need to use specific strings / cannot use @string/xxx notation -->

				    <package android:name="app.organicmaps"/>

biodranik (Migrated from github.com) commented

2023-08-14 06:53:33 +00:00

Agree about one method. The use-case I have in mind is to display a button "Open in Organic Maps" if it is installed. To do it, we first need to check if OM is present, before trying to use the API.

moving-bits (Migrated from github.com) reviewed 2023-08-14 19:13:14 +00:00

lib/src/main/AndroidManifest.xml

					
				@ -2,3 +2,4 @@

				<manifest xmlns:android="http://schemas.android.com/apk/res/android">

				  <queries>

				    <!-- packages we want to see using the package manager need to be declared starting with targetSDK 30, and we need to use specific strings / cannot use @string/xxx notation -->

				    <package android:name="app.organicmaps"/>

moving-bits (Migrated from github.com) commented

2023-08-14 19:13:14 +00:00

Currently a download popup is presented on calling one of the showPoint(s)OnMap methods, if no app can be found that can handle the OM intent. (Similar to what the old MWM API did.)

If you want to have a separate check available additionally, I can add something like isOrganicMapsPackageInstalled() which checks whether one of the three package variants is installed. Is that what you have in mind?

Currently a download popup is presented on calling one of the `showPoint(s)OnMap` methods, if no app can be found that can handle the OM intent. (Similar to what the old MWM API did.) If you want to have a separate check available additionally, I can add something like `isOrganicMapsPackageInstalled()` which checks whether one of the three package variants is installed. Is that what you have in mind?

biodranik (Migrated from github.com) reviewed 2023-08-14 20:55:48 +00:00

lib/src/main/AndroidManifest.xml

					
				@ -2,3 +2,4 @@

				<manifest xmlns:android="http://schemas.android.com/apk/res/android">

				  <queries>

				    <!-- packages we want to see using the package manager need to be declared starting with targetSDK 30, and we need to use specific strings / cannot use @string/xxx notation -->

				    <package android:name="app.organicmaps"/>

biodranik (Migrated from github.com) commented

2023-08-14 20:55:48 +00:00

Yes! Thank you!

moving-bits (Migrated from github.com) reviewed 2023-08-16 19:26:49 +00:00

lib/src/main/AndroidManifest.xml

					
				@ -2,3 +2,4 @@

				<manifest xmlns:android="http://schemas.android.com/apk/res/android">

				  <queries>

				    <!-- packages we want to see using the package manager need to be declared starting with targetSDK 30, and we need to use specific strings / cannot use @string/xxx notation -->

				    <package android:name="app.organicmaps"/>

moving-bits (Migrated from github.com) commented

2023-08-16 19:26:49 +00:00

have added isOrganicMapsPackageInstalled()

biodranik (Migrated from github.com) approved these changes 2023-08-16 20:17:36 +00:00

biodranik (Migrated from github.com) left a comment

Thank you very much for your help!

We recently got an email that one API scenario doesn't work anymore: points are shown on the map, but there is not way to select a point and return the selected one back to the caller app. Can you please take a look at it?

Maybe our API test page should be updated too?

Thank you very much for your help! We recently got an email that one API scenario doesn't work anymore: points are shown on the map, but there is not way to select a point and return the selected one back to the caller app. Can you please take a look at it? Maybe our API test page should be updated too?

moving-bits commented

2023-08-16 20:35:15 +00:00

(Migrated from github.com)

We recently got an email that one API scenario doesn't work anymore: points are shown on the map, but there is not way to select a point and return the selected one back to the caller app.

Yes, this was a feature supported by the old mwm API which seems not to be implemented yet in OrganicMaps lib functions. (At least I did not find them when I was scanning for integration in c:geo, which uses that function for maps.me integration as well.) That's why I left that out of OrganicMapsApi.java for the time being.

Can you please take a look at it?

I can give it a try, as time permits, but I cannot promise it. Work on c:geo already consumes much of my available spare time :-)

> We recently got an email that one API scenario doesn't work anymore: points are shown on the map, but there is not way to select a point and return the selected one back to the caller app. Yes, this was a feature supported by the old mwm API which seems not to be implemented yet in OrganicMaps lib functions. (At least I did not find them when I was scanning for integration in c:geo, which uses that function for maps.me integration as well.) That's why I left that out of `OrganicMapsApi.java` for the time being. > Can you please take a look at it? I can give it a try, as time permits, but I cannot promise it. Work on c:geo already consumes much of my available spare time :-)

biodranik commented

2023-08-16 21:09:22 +00:00

(Migrated from github.com)

I understand, thank you again for your time and contribution!

Sign in to join this conversation.

No reviewers

biodranik