Add support for placemarkFromAddress in platform interface (#178)

Baseflow · Nov 21, 2023 · 58df334 · 58df334
1 parent 2a2dca8
commit 58df334
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/geocoding_platform_interface/CHANGELOG.md b/geocoding_platform_interface/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 3.1.0
+
+- Adds `placemarkFromAddress` method to the platform interface.
+
 ## 3.0.0
 
 - **Breaking Change** Changes to the platform interface calls, the locale is now set in a separate call.

diff --git a/geocoding_platform_interface/lib/src/geocoding_platform_interface.dart b/geocoding_platform_interface/lib/src/geocoding_platform_interface.dart
@@ -72,4 +72,17 @@ abstract class GeocodingPlatform extends PlatformInterface {
     throw UnimplementedError(
         'placemarkFromCoordinates() has not been implementated.');
   }
+
+  /// Returns a list of [Placemark] instances found for the supplied address.
+  ///
+  /// 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 [Placemark], multiple [Placemark] instances may be
+  /// returned.
+  Future<List<Placemark>> placemarkFromAddress(
+    String address,
+  ) {
+    throw UnimplementedError(
+        'placemarkFromAddress() has not been implementated.');
+  }
 }
diff --git a/geocoding_platform_interface/pubspec.yaml b/geocoding_platform_interface/pubspec.yaml
@@ -3,7 +3,7 @@ description: A common platform interface for the geocoding plugin.
 homepage: https://github.com/baseflow/flutter-geocoding/tree/main/geocoding_platform_interface
 # NOTE: We strongly prefer non-breaking changes, even at the expense of a
 # less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
-version: 3.0.0
+version: 3.1.0
 
 dependencies:
   flutter: