Flutter Wayfinding migration guide

As a first step, you need to update the Situm dependency to use the new version

• Replace the library. Update your pubspec.yaml:

dependencies:
...
# From:
situm_flutter_wayfinding: x.y.z

# To:
situm_flutter: x.y.z

Flutter – iOS #

In iOS, you’ll just need to:

• Update pods. Run pod install or pod update if necessary.

Flutter – Dart #

• Update your imports. In the corresponding Dart file (e.g. main.dart or wherever you use our library):

// From:
import 'package:situm_flutter_wayfinding/situm_flutter_sdk.dart';
import 'package:situm_flutter_wayfinding/situm_flutter_wayfinding.dart';

// To:
import 'package:situm_flutter/sdk.dart';
import 'package:situm_flutter/wayfinding.dart';

• Rename SitumFlutterSDK. This has been renamed to SitumSdk, update your code accordingly.
• Rename SitumMapView. SitumMapView has been renamed to MapView.
• Rename the controller received in the onLoad callback to MapViewController. Update any reference in your code.
• Wrap the MapView configuration. All the parameters of the MapView widget have been encapsulated into a single MapViewConfiguration object. Additionally, you will notice that the number of parameters has decreased dramatically (since the new MapView can be configured remotely).

// Example:
MapView(
  key: const Key("situm_map"),
  mapViewConfiguration: MapViewConfiguration(
    // Your Situm credentials.
    situmUser: situmUser,
    situmApiKey: situmApiKey,
    buildingIdentifier: buildingIdentifier,
    // ...
  ),
  loadCallback: _loadCallback,
)

// ...
void _onLoad(MapViewController controller) {
  // Use MapViewController to communicate with the map: methods and callbacks
  // are available to perform actions and listen to events (e.g., set the user
  // location, listen to POI selections, intercept navigation options, etc.).
  // You need to wait until the map is properly loaded to do so.
  mapViewController = controller;
}

• Initialize geolocation and forward locations to the MapView. The new MapView is totally independent from the positioning system. Now, your are responsible of telling the widget where the user is. This means that you’ll need to start positioning by calling the method requestLocationUpdates. If you did use this method in the app in the past, you’ll need to migrate it slightly: this method has changed so that now it only receives a single LocationRequest parameter encapsulating positioning options.

// From:    
situmSdk.requestLocationUpdates(
  _MyLocationListener(echoer: _echo), // The LocationListener is not needed anymore.
  {"buildingIdentifier": buildingIdentifier},
);

// To:
situmSdk.requestLocationUpdates(LocationRequest(
  buildingIdentifier: buildingIdentifier
));

• Update the positioning callbacks. These callbacks have been refactored to be more idiomatic, so you no longer need to create a custom class implementing the LocationListener (it has been removed). Now you simply register the callbacks as bellow:

// Set up location callbacks:
situmSdk.onLocationUpdate((location) { 
  // ... 
}); 
situmSdk.onLocationStatus((status) {
  // ... 
});
situmSdk.onLocationError((error) {
  // ...
});