Skip to content

Promote Search SDK as a replacement of Geocoder #1342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
friendoye merged 2 commits into from
Dec 8, 2021
Merged

Promote Search SDK as a replacement of Geocoder #1342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20076ae
Add `Geocoder` deprecation note
Dec 6, 2021
722e9ca
Establish ownership of `Geocoder`
Dec 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CODEOWNERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Transfer ownership over Geocoder related files to Search SDK Android team
services-geocoding/ @mapbox/search-sdk-android
11 changes: 11 additions & 0 deletions services-geocoding/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Geocoder

[The Mapbox Search SDK for Android](https://docs.mapbox.com/android/search/guides/) is the recommended way to access the [Mapbox Geocoding API](https://docs.mapbox.com/api/search/geocoding/) on the Android platform. If you've used `Geocoder` to integrate search functionality into an Android application, you should switch to Search SDK using the [Migrate from Geocoder](https://docs.mapbox.com/android/search/guides/geocoder-migration/) guide.

## Overview

`Geocoder` artifact provides a Java wrapper around [Mapbox Geocoding API](https://docs.mapbox.com/api/search/geocoding/) service.

[MapboxGeocoding](https://github.com/mapbox/mapbox-java/blob/main/services-geocoding/src/main/java/com/mapbox/api/geocoding/v5/MapboxGeocoding.java#L64) is used to request both forward and reverse geocoding information. **Forward geocoding** will take a `String`, such as a street address or point of interest, and transform it into a `Point` object. **Reverse geocoding** does the opposite, taking in a `Point` object and transforming it into an address. The amount of detail provided in the response varies. For example, one response might contain a full address while another response will only contain the city and country.

All of the documentation is available on a [Geocoder documentation page](https://docs.mapbox.com/android/java/guides/geocoder/).