[location-plugin] Deprecate location plugin. #28
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pengdev
force-pushed
the
peng-deprecate-location-plugin
branch
2 times, most recently
from
e92927b to
dacb98a
Compare
Chaoba
approved these changes
Jan 25, 2021
kiryldz
approved these changes
Jan 25, 2021
pengdev
commented
Jan 25, 2021
Comment on lines
+1
to
+65
| ## Mapbox Maps Location Plugin for Android (Deprecated) | ||
|
|
||
| ### Overview | ||
|
|
||
| The Mapbox Maps Location Plugin for Android is an open source library that provides location awareness to your mobile application. This plugin is a direct port of the Location component from Mapbox Maps SDK v9. It is deprecated in favor of the decoupled Location Component Plugin(handles only the location puck rendering) and a new plugin that handles the camera updates(working in progress). | ||
|
|
||
| A full overview of classes and interfaces can be found in our [API documentation](https://docs.mapbox.com/android/maps/overview/). | ||
|
|
||
| ### Getting Started | ||
|
|
||
| This README is intended for developers who are interested in [contributing](https://github.com/mapbox/mapbox-maps-android/blob/master/CONTRIBUTING.md) to the Mapbox Maps Location Plugin for Android. Please visit [DEVELOPING.md](https://github.com/mapbox/mapbox-maps-android/blob/master/DEVELOPING.md) for general information and instructions on how to use the Mapbox Maps Plugin System. To add the location plugin to your project, you configure its dependency in your `build.gradle` files. | ||
|
|
||
| ```groovy | ||
| // In the root build.gradle file | ||
| // The Mapbox access token needs to a scope set to DOWNLOADS:READ | ||
| allprojects { | ||
| repositories { | ||
| maven { | ||
| url 'https://api.mapbox.com/downloads/v2/releases/maven' | ||
| authentication { | ||
| basic(BasicAuthentication) | ||
| } | ||
| credentials { | ||
| username = "mapbox" | ||
| password = "INSERT_MAPBOX_ACCESS_TOKEN_HERE" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // In the app build.gradle file | ||
| dependencies { | ||
| implementation 'com.mapbox.plugin:maps-location:10.0.0-beta.11' | ||
| } | ||
| ``` | ||
|
|
||
| ### Example | ||
|
|
||
| Initialisation and customizing Mapbox Maps Location Plugin for Android can be done as follows: | ||
|
|
||
| ```kotlin | ||
| val locationPlugin = mapView.getLocationPlugin() | ||
| // Activate with a built LocationComponentActivationOptions object | ||
| locationPlugin?.let { | ||
| it.activateLocationComponent( | ||
| LocationComponentActivationOptions | ||
| .builder(context, style) | ||
| .useDefaultLocationEngine(true) | ||
| .locationEngineRequest( | ||
| LocationEngineRequest.Builder(750) | ||
| .setFastestInterval(750) | ||
| .setPriority(LocationEngineRequest.PRIORITY_HIGH_ACCURACY) | ||
| .build() | ||
| ) | ||
| .build() | ||
| ) | ||
| it.enabled = true | ||
| it.cameraMode = cameraMode | ||
| } | ||
| ``` | ||
|
|
||
| More concrete examples of the location plugin can be found in our [test application](https://github.com/mapbox/mapbox-maps-android/tree/master/app/src/main/java/com/mapbox/maps/testapp). | ||
|
|
||
| #### Dependencies | ||
|
|
||
| View [LICENSE.md](LICENSE.md) for all dependencies used by this plugin. |
There was a problem hiding this comment.
Would like your review on the README.md for location plugin. cc @tobrun
There was a problem hiding this comment.
I will go ahead to merge this PR, we can iterate on the documentation after the code freeze.
pengdev
force-pushed
the
peng-deprecate-location-plugin
branch
2 times, most recently
from
9bcad08 to
f22f0bb
Compare
pengdev
force-pushed
the
peng-deprecate-location-plugin
branch
from
f22f0bb to
f2e11fd
Compare
Closed
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
<changelog>Deprecate location plugin in favour of the Location Component Plugin.</changelog>