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

A versão 4.0 do SDK do Driver para Android 4.0 exige que você atualize o código para determinadas operações. Este guia descreve as mudanças e o que você precisa fazer para migrar seu código.

Para o modelo de driver untrusted, os clientes de entrega só precisam fazer a autenticação para o tipo de serviço VEHICLE, que ativa os relatórios de localização. Os clientes com um modelo de motorista confiável precisam fornecer autenticação para o tipo de serviço TASK para ativar os métodos de relatório de parada de veículo em DeliveryVehicleReporter.

Mudança do nome do pacote

O nome do pacote mudou de com.google.android.libraries.ridesharing.driver para com.google.android.libraries.mapsplatform.transportation.driver. Atualize as referências no seu código.

Initializing the SDK

Em versões anteriores, você inicializaria o SDK do Navigation e, em seguida, receberia uma referência para a classe FleetEngine. No SDK do Driver v4, inicialize o SDK da seguinte maneira:

  1. Extraia 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.

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

    DeliveryVehicleReporter vehicleReporter = deliveryDriverApi.getDeliveryVehicleReporter();
    

Como ativar e desativar as atualizações de localização

Em versões anteriores, as atualizações de localização eram ativadas depois de receber uma referência FleetEngine. No SDK do Driver v4, ative as atualizações de localização da seguinte maneira:

DeliveryVehicleReporter reporter = ...;

reporter.enableLocationTracking();

Para atualizar o intervalo do relatório, use DeliveryVehicleReporter.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().

Error Reporting com StatusListener

ErrorListener foi removido e combinado com StatusListener, que pode ser definido da seguinte maneira:

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 usa AuthTokenContext como parâmetro.

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);
    }
  }
}

A lista Task se torna a lista TaskInfo

A lista Task foi substituída pela lista TaskInfo em VehicleStop. O exemplo de código a seguir demonstra como criar um objeto VehicleStop.

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