From 9bbee5cf4bd4f303f150f3e5b0e408688af891f9 Mon Sep 17 00:00:00 2001 From: GaMoSitum Date: Fri, 17 Oct 2025 16:38:23 +0200 Subject: [PATCH 1/3] Improved docs of SitumSdk class The methods requestDirections and requestNavigation could lead to confusion on whether they are used to start a directions/navigation action in the MapView, behaviour is now clear and does not mislead the user. --- lib/src/sdk_controller.dart | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/lib/src/sdk_controller.dart b/lib/src/sdk_controller.dart index 92eff527..6b094521 100644 --- a/lib/src/sdk_controller.dart +++ b/lib/src/sdk_controller.dart @@ -221,7 +221,7 @@ class SitumSdk { _onLocationErrorCallback = callback; } - /// Requests directions between two [Point]s using the given + /// Calculates and returns a [SitumRoute] between two [Point]s using the given /// [DirectionsRequest]. Future requestDirections( DirectionsRequest directionsRequest) async { @@ -231,8 +231,9 @@ class SitumSdk { return createRoute(response); } - /// Requests navigation between two [Point]s, using the given - /// [DirectionsRequest] and [NavigationRequest]. + /// Calculates and returns a [SitumRoute] between two [Point]s, using the given + /// [DirectionsRequest] and [NavigationRequest]. Does NOT start a navigation, it is + /// meant to give users a way of generating a route and using it for their own purposes. Future requestNavigation(DirectionsRequest directionsRequest, NavigationRequest navigationRequest) async { Map response = await methodChannel.invokeMethod('requestNavigation', { From eb9a6bc3006038789b20b87993052b5be0f56dd8 Mon Sep 17 00:00:00 2001 From: GaMoSitum Date: Fri, 17 Oct 2025 16:40:57 +0200 Subject: [PATCH 2/3] Made the comments a bit more clear. --- lib/src/sdk_controller.dart | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lib/src/sdk_controller.dart b/lib/src/sdk_controller.dart index 6b094521..ea25707e 100644 --- a/lib/src/sdk_controller.dart +++ b/lib/src/sdk_controller.dart @@ -222,7 +222,9 @@ class SitumSdk { } /// Calculates and returns a [SitumRoute] between two [Point]s using the given - /// [DirectionsRequest]. + /// [DirectionsRequest]. This method will NOT show directions in the [MapView], + /// it is meant to give users a way of generating a route and using it for their + /// own purposes. Future requestDirections( DirectionsRequest directionsRequest) async { Map response = await methodChannel.invokeMethod( @@ -232,8 +234,9 @@ class SitumSdk { } /// Calculates and returns a [SitumRoute] between two [Point]s, using the given - /// [DirectionsRequest] and [NavigationRequest]. Does NOT start a navigation, it is - /// meant to give users a way of generating a route and using it for their own purposes. + /// [DirectionsRequest] and [NavigationRequest]. This method does NOT start a navigation + /// in the [MapView], it is meant to give users a way of generating a route and using it + /// for their own purposes. Future requestNavigation(DirectionsRequest directionsRequest, NavigationRequest navigationRequest) async { Map response = await methodChannel.invokeMethod('requestNavigation', { From 78625ffa35cf4f7d0cdc2333e6e83880434abb33 Mon Sep 17 00:00:00 2001 From: GaMoSitum Date: Mon, 27 Oct 2025 13:01:32 +0100 Subject: [PATCH 3/3] Removed linked reference to MapView, left just the name of the component. --- lib/src/sdk_controller.dart | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/src/sdk_controller.dart b/lib/src/sdk_controller.dart index ea25707e..51550a17 100644 --- a/lib/src/sdk_controller.dart +++ b/lib/src/sdk_controller.dart @@ -222,7 +222,7 @@ class SitumSdk { } /// Calculates and returns a [SitumRoute] between two [Point]s using the given - /// [DirectionsRequest]. This method will NOT show directions in the [MapView], + /// [DirectionsRequest]. This method will NOT show directions in the MapView component, /// it is meant to give users a way of generating a route and using it for their /// own purposes. Future requestDirections( @@ -235,7 +235,7 @@ class SitumSdk { /// Calculates and returns a [SitumRoute] between two [Point]s, using the given /// [DirectionsRequest] and [NavigationRequest]. This method does NOT start a navigation - /// in the [MapView], it is meant to give users a way of generating a route and using it + /// in the MapView component, it is meant to give users a way of generating a route and using it /// for their own purposes. Future requestNavigation(DirectionsRequest directionsRequest, NavigationRequest navigationRequest) async {