Skip to content

Commit

Permalink
updates documentation isPresent() (#222)
Browse files Browse the repository at this point in the history
* updates documentation isPresent()

* fixed typo

* Update geocoding/CHANGELOG.md

Co-authored-by: Maurits van Beusekom <[email protected]>

---------

Co-authored-by: Maurits van Beusekom <[email protected]>
  • Loading branch information
TimHoogstrate and mvanbeusekom authored Mar 13, 2024
1 parent f03dfb7 commit 81d9199
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 14 deletions.
5 changes: 5 additions & 0 deletions geocoding/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## 2.2.2

- Updates documentation for isPresent().
- Removes unused `LocaleIdentifier` parameter for isPresent().

## 2.2.1+1

- Reverts changes from version `2.2.1`, `2.2.1` should not be used. Use either version `2.2.1+1` or `3.0.0`.
Expand Down
18 changes: 5 additions & 13 deletions geocoding/lib/geocoding.dart
Original file line number Diff line number Diff line change
Expand Up @@ -45,18 +45,10 @@ Future<List<Placemark>> placemarkFromCoordinates(
longitude,
);

/// Returns a list of [Location] instances found for the supplied address.
/// Returns true if there is a geocoder implementation present that may return results.
/// If true, there is still no guarantee that any individual geocoding attempt will succeed.
///
/// In most situations the returned list should only contain one entry.
/// However in some situations where the supplied address could not be
/// resolved into a single [Location], multiple [Location] instances may be
/// returned.
///
/// Optionally you can specify a locale in which the results are returned.
/// When not supplied the currently active locale of the device will be used.
/// The `localeIdentifier` should be formatted using the syntax:
/// [languageCode]_[countryCode] (eg. en_US or nl_NL).
Future<bool> isPresent({
String? localeIdentifier,
}) =>
GeocodingPlatform.instance!.isPresent();
/// This method is only implemented on Android, calling this on iOS always
/// returns [true].
Future<bool> isPresent() => GeocodingPlatform.instance!.isPresent();
2 changes: 1 addition & 1 deletion geocoding/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: geocoding
description: A Flutter Geocoding plugin which provides easy geocoding and reverse-geocoding features.
version: 2.2.1+1
version: 2.2.2
repository: https://github.com/baseflow/flutter-geocoding/tree/main/geocoding
issue_tracker: https://github.com/Baseflow/flutter-geocoding/issues

Expand Down

0 comments on commit 81d9199

Please sign in to comment.