Feature/sup 9577 internal fix docs of fluttersdk #592
Conversation
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
Outdated
| /// Requests directions between two [Point]s using the given | ||
| /// [DirectionsRequest]. | ||
| /// Calculates and returns a [SitumRoute] between two [Point]s using the given | ||
| /// [DirectionsRequest]. This method will NOT show directions in the [MapView], |
There was a problem hiding this comment.
Está correcto, pero un detalle: o enlace a MapView non debería ser un enlace (non debería funcionar ademais):
En wayfinding.dart:
Sin embargo en sdk.dart non atoparás imports de wayfinding.
Podes facer mención á UI ou utilizar o formato "código" (MapView), pero o enlace creo que pode ser problemático.
|
Listo, ya no hace linkeo a [MapView], simplemente menciona el componente pero no está linkeado. |
| /// 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 component, it is meant to give users a way of generating a route and using it | ||
| /// for their own purposes. |
There was a problem hiding this comment.
Neste caso concreto non sei se o mapView lle chegara algun callback de navegación por postMessage que faga que se mostre información de navegación. Sería interesante probar por se acaso
There was a problem hiding this comment.
Si no recuerdo mal ya se había quitado la navegación del sdk del viewer así que no creo que haya problema
Improved documentation of requestDirections and requestNavigation functions of SitumSdk class, since it could lead to confusion on whether these methods actually started a navigation/directions in the MapView. It is now clear that they only create a SitumRoute using the given parameters that is returned for the user to utilize however they see fit.