Guide de migration du SDK Android Driver 4.0

La version 4.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.

Pour le modèle de chauffeur untrusted, les clients de livraison n'ont besoin de s'authentifier que pour le type de service VEHICLE, ce qui active la mise à jour de la position. Les clients disposant d'un modèle de conducteur de confiance doivent fournir une authentification pour le type de service TASK afin d'activer les méthodes de signalement des arrêts de véhicule dans DeliveryVehicleReporter.

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 v4, 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.

    DeliveryDriverApi deliveryDriverApi = DeliveryDriverApi.createInstance(driverContext);

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

    DeliveryVehicleReporter vehicleReporter = deliveryDriverApi.getDeliveryVehicleReporter();

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 v4, activez les mises à jour de la position comme suit:

DeliveryVehicleReporter reporter = ...;

reporter.enableLocationTracking();

Pour mettre à jour l'intervalle de reporting, utilisez 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().

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 utilise AuthTokenContext comme paramètre.

class JsonAuthTokenFactory implements AuthTokenFactory {
  // Initially null.
  private String vehicleServiceToken;
  // Initially null. Only used in the trusted driver model to authenticate
  // vehicle-stop reporting.
  private String taskServiceToken;
  private long expiryTimeMs = 0;

  // This method is called on a thread that only sends location updates (and
  // vehicle stop updates if you choose to report them). Blocking is OK, but just
  // know that no 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 if (ServiceType.TASK.equals(authTokenContext.getServiceType())) {
      // Only used for the trusted driver model to access vehicle-stop reporting
      // methods in DeliveryVehicleReporter.
      return taskServiceToken;
    } else {
      throw new RuntimeException("Unsupported ServiceType: " + authTokenContext.getServiceType());
    }
  }

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

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

      // 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 DriverContext class will be notified and passed along the failed
      // update warning.
      throw new RuntimeException("Could not get auth token", e);
    }
  }
}

La liste "Task" devient la liste "TaskInfo"

La liste Task a été remplacée par la liste TaskInfo dans VehicleStop. L'exemple de code suivant montre comment créer un objet VehicleStop.

VehicleStop vehicleStop = VehicleStop.builder()
    .setTaskInfoList(taskInfoList)
    .setWaypoint(waypoint)
    .setVehicleStopState(vehicleStopState)
    .build();