Guía de migración del SDK de Android Driver 4.0

El SDK de Driver para Android 4.0 requiere que actualices el código para ciertas operaciones. En esta guía, se describen los cambios y lo que deberás hacer para migrar tu código.

Cambio de nombre del paquete

El nombre del paquete cambió de com.google.android.libraries.ridesharing.driver a com.google.android.libraries.mapsplatform.transportation.driver. Actualiza las referencias en tu código.

Inicializa el SDK

En versiones anteriores, inicializabas el SDK de Navigation y, luego, obtenías una referencia a la clase FleetEngine. En la versión 4 del SDK de Driver, inicializa el SDK como se indica a continuación:

1. Obtén un objeto Navigator 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. Crea un objeto DriverContext y propaga los campos obligatorios.

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

3. Usa el objeto DriverContext para inicializar *DriverApi.

   RidesharingDriverApi ridesharingDriverApi = RidesharingDriverApi.createInstance(driverContext);
   

4. Obtén el NavigationVehicleReporter del objeto de la API. *VehicleReporter extiende NavigationVehicleReporter.

   RidesharingVehicleReporter vehicleReporter = ridesharingDriverApi.getRidesharingVehicleReporter();
   

Cómo habilitar e inhabilitar actualizaciones de ubicación

En versiones anteriores, habilitabas las actualizaciones de ubicación después de obtener una referencia FleetEngine. En la versión 4 del SDK de Driver, habilita las actualizaciones de ubicación de la siguiente manera:

RidesharingVehicleReporter reporter = ...;

reporter.enableLocationTracking();

Para actualizar el intervalo de informes, usa RidesharingVehicleReporter.setLocationReportingInterval(long, TimeUnit).

Cuando finalice el turno del conductor, inhabilita las actualizaciones de ubicación y marca el vehículo como sin conexión llamando a NavigationVehicleReporter.disableLocationTracking().

Cómo configurar el estado del vehículo en el servidor

En versiones anteriores, se usaba el objeto FleetEngine para establecer el estado del vehículo. En la versión 4 del SDK de Driver, usa el objeto RidesharingVehicleReporter para establecer el estado del vehículo:

RidesharingVehicleReporter reporter = ...;

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

Para establecer el estado del vehículo en OFFLINE, llama a RidesharingVehicleReporter.disableLocationTracking(). Los errores de actualización del estado del vehículo se propagan mediante el conjunto StatusListener proporcionado de forma opcional en DriverContext.

Error Reporting con StatusListener

Se quitó ErrorListener y se combinó con StatusListener, que puede definirse de la siguiente manera:

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.
  }
}

Autenticando con AuthTokenFactory

AuthTokenFactory ahora tiene un solo método, getToken(), que toma AuthTokenContext como parámetro. ServiceType dejó de estar disponible. Ahora, solo debes obtener un reclamo para el ID de vehículo incluido, en lugar de depender de ServiceType.

class JsonAuthTokenFactory implements AuthTokenFactory {
  private String token;  // initially null
  private 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(authTokenContext.getVehicleId());
    }
    return token;
  }

  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();
      token = obj.get("Token").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 is notified, and passes along the failed
      // update warning.
      throw new RuntimeException("Could not get auth token", e);
    }
  }
}