Guia de migração do SDK do driver 4.0 do Android

A versão 4.0 do SDK do Driver para Android exige que você atualize seu código para determinadas operações. Neste guia, descrevemos as mudanças você precisará fazer para migrar seu código.

Alteração do nome do pacote

O nome do pacote mudou de com.google.android.libraries.ridesharing.driver a com.google.android.libraries.mapsplatform.transportation.driver. Não se esqueça atualizar referências em seu código.

Initializing the SDK

Nas versões anteriores, você inicializava o SDK do Navigation e acessava uma referência à classe FleetEngine. No SDK do Driver v4, inicialize o SDK da seguinte maneira:

  1. Consiga um objeto Navigator do 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. Crie um objeto DriverContext, preenchendo os campos obrigatórios.

    DriverContext driverContext = DriverContext.builder(application)
        .setProviderId(providerId)
        .setVehicleId(vehicleId)
        .setAuthTokenFactory(authTokenFactory)
        .setNavigator(navigator)
        .setRoadSnappedLocationProvider(
            NavigationApi.getRoadSnappedLocationProvider(application))
        .build();
    
  3. Use o objeto DriverContext para inicializar o *DriverApi.

    RidesharingDriverApi ridesharingDriverApi = RidesharingDriverApi.createInstance(driverContext);
    
  4. Consiga o NavigationVehicleReporter do objeto da API. *VehicleReporter estende NavigationVehicleReporter.

    RidesharingVehicleReporter vehicleReporter = ridesharingDriverApi.getRidesharingVehicleReporter();
    

Ativação e desativação de atualizações de localização

Em versões anteriores, as atualizações de localização eram ativadas após a uma referência a FleetEngine. No SDK do Driver v4, ative atualizações de localização da seguinte forma:

RidesharingVehicleReporter reporter = ...;

reporter.enableLocationTracking();

Para atualizar o intervalo do relatório, use RidesharingVehicleReporter.setLocationReportingInterval(long, TimeUnit):

Quando o turno do motorista terminar, desative as atualizações de localização e marque o veículo como off-line chamando NavigationVehicleReporter.disableLocationTracking().

Definir o estado do veículo no servidor

Nas versões anteriores, você usaria o objeto FleetEngine para definir o estado do veículo. No SDK do Driver v4, use o Objeto RidesharingVehicleReporter para definir o estado do veículo:

RidesharingVehicleReporter reporter = ...;

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

Para definir o estado do veículo como OFFLINE, chame RidesharingVehicleReporter.disableLocationTracking(). Erros atualizar o estado do veículo são propagadas usando o método StatusListener definido no DriverContext.

Error Reporting com StatusListener

ErrorListener foi removido e combinado com StatusListener, que podem ser definidas assim:

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

Como autenticar com AuthTokenFactory

AuthTokenFactory agora tem apenas um método, getToken(), que leva AuthTokenContext como parâmetro. O uso de ServiceType foi descontinuado. Agora você só precisa receber uma reivindicação para o ID do veículo incluído, em vez de confiar na 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);
    }
  }
}