Guide de migration du SDK Driver 3.0

La version 3.0 du SDK Driver pour Android nécessite la mise à jour de votre code pour certaines opérations. Ce guide décrit les modifications et la procédure à suivre pour migrer votre code.

Modification du nom du package

Le nom du package com.google.android.libraries.ridesharing.driver a été remplacé par com.google.android.libraries.mapsplatform.transportation.driver. Veuillez mettre à jour les références dans votre code.

Initialiser le SDK

Dans les versions précédentes, vous initialisiez le SDK Navigation, puis vous obteniez une référence à la classe FleetEngine. Dans Driver SDK v3, initialisez le SDK comme suit:

  1. Obtenez un objet Navigator à partir de NavigationApi.

    NavigationApi.getNavigator(
      this, // Activity
      new NavigationApi.NavigatorListener() {
        @Override
        public void onNavigatorReady(Navigator navigator) {
          // Keep a reference to the Navigator (used to configure and start nav)
          this.navigator = navigator;
        }
      }
);

  2. Créez un objet DriverContext en remplissant les champs obligatoires.

    DriverContext driverContext = DriverContext.builder(application)
             .setProviderId(providerId)
             .setVehicleId(vehicleId)
             .setAuthTokenFactory(authTokenFactory)
             .setNavigator(navigator)
             .setRoadSnappedLocationProvider(
                 NavigationApi.getRoadSnappedLocationProvider(application))
             .build()

  3. Utilisez l'objet DriverContext pour initialiser *DriverApi.

    RidesharingDriverApi ridesharingDriverApi = RidesharingDriverApi.createInstance(driverContext);

  4. Récupérez NavigationVehicleReporter à partir de l'objet d'API. *VehicleReporter étend NavigationVehicleReporter.

    RidesharingVehicleReporter vehicleReporter = ridesharingDriverApi.getRidesharingVehicleReporter();

Activer et désactiver les mises à jour de la position

Dans les versions antérieures, vous activez les mises à jour de la position après avoir obtenu une référence FleetEngine. Dans Driver SDK v3, activez les mises à jour de la position comme suit:

RidesharingVehicleReporter reporter = ...;

reporter.enableLocationTracking();

Pour mettre à jour l'intervalle de reporting, utilisez RidesharingVehicleReporter.setLocationReportingInterval(long, TimeUnit) ou DeliveryVehicleReporter.setLocationReportingInterval(long, TimeUnit).

Une fois le travail du conducteur terminé, désactivez les mises à jour de la position et marquez le véhicule comme hors connexion en appelant NavigationVehicleReporter.disableLocationTracking().

Définir l'état du véhicule sur le serveur

Dans les versions précédentes, vous deviez utiliser l'objet FleetEngine pour définir l'état du véhicule. Dans Driver SDK v3, utilisez l'objet RidesharingVehicleReporter pour définir l'état du véhicule:

  RidesharingVehicleReporter reporter = ...;

  reporter.enableLocationTracking();
  reporter.setVehicleState(VehicleState.ONLINE);

Pour définir l'état du véhicule sur OFFLINE, appelez RidesharingVehicleReporter.disableLocationTracking(). Les erreurs de mise à jour de l'état du véhicule sont propagées à l'aide du paramètre StatusListener éventuellement fourni dans DriverContext.

Error Reporting avec StatusListener

ErrorListener a été supprimé et combiné à StatusListener, qui peut être défini comme suit:

class MyStatusListener implements StatusListener {
  /** Called when background status is updated, during actions such as location reporting. */
  @Override
  public void updateStatus(
    StatusLevel statusLevel,
    StatusCode statusCode,
    String statusMsg) {
    // Status handling stuff goes here.
    // StatusLevel may be DEBUG, INFO, WARNING, or ERROR.
    // StatusCode may be DEFAULT, UNKNOWN_ERROR, VEHICLE_NOT_FOUND, 
    // BACKEND_CONNECTIVITY_ERROR, or PERMISSION_DENIED.
  }
}

Authentification avec AuthTokenFactory

AuthTokenFactory ne dispose désormais que d'une seule méthode, getToken(), qui accepte un AuthTokenContext comme paramètre. Les clients du partage de course doivent s'authentifier pour le type de service VEHICLE, qui active la mise à jour de la position et l'état des véhicules (en ligne/hors connexion).

class JsonAuthTokenFactory implements AuthTokenFactory {
  String vehicleServiceToken;  // initially null
  long expiryTimeMs = 0;

  // This method is called on a thread whose only responsibility is to send
  // location updates. Blocking is OK, but just know that no location updates
  // can occur until this method returns.
  @Override public String getToken(AuthTokenContext authTokenContext) {
    if (System.currentTimeMillis() > expiryTimeMs) {
      // The token has expired, go get a new one.
      fetchNewToken(vehicleId);
    }
    if (ServiceType.VEHICLE.equals(authTokenContext.getServiceType)) {
      return vehicleServiceToken;
    } else {
      throw new RuntimeException("Unsupported ServiceType: " + authTokenContext.getServiceType());
    }
  }

  private void fetchNewToken(String vehicleId) {
    String url = "https://yourauthserver.example/token/" + vehicleId;

    try (Reader r = new URL(url).openStream()) {
      com.google.gson.JsonObject obj
          = new com.google.gson.JsonParser().parse(r);
      vehicleServiceToken = obj.get("VehicleServiceToken").getAsString();
      expiryTimeMs = obj.getAsLong("TokenExpiryMs");

      // The expiry time could be an hour from now, but just to try and avoid
      // passing expired tokens, we subtract 10 minutes from that time.
      expiryTimeMs -= 10 * 60 * 1000;
    } catch (IOException e) {
      // It's OK to throw exceptions here, the StatusListener you passed to
      // create the FleetEngine class will be notified and pass along the failed
      // update warning.
      throw new RuntimeException("Could not get auth token", e);
    }
  }
}