Skip to content

Commit 16139be

Browse files
author
Nikita Novik
authored
Promote Search SDK as a replacement of Geocoder (#1342)
Search SDK for Android now is the recommended way to access Geocoding API on Android platform. To promote Search SDK usage this PR: 1) Adds `Geocoder` deprecation note; 2) Assigns `services-geocoding` ownership to Search SDK Android team
1 parent 4f8916b commit 16139be

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

CODEOWNERS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Transfer ownership over Geocoder related files to Search SDK Android team
2+
services-geocoding/ @mapbox/search-sdk-android

services-geocoding/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Geocoder
2+
3+
[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.
4+
5+
## Overview
6+
7+
`Geocoder` artifact provides a Java wrapper around [Mapbox Geocoding API](https://docs.mapbox.com/api/search/geocoding/) service.
8+
9+
[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.
10+
11+
All of the documentation is available on a [Geocoder documentation page](https://docs.mapbox.com/android/java/guides/geocoder/).

0 commit comments

Comments
 (0)