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

O SDK do Driver para Android 3.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.

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

    RidesharingDriverApi ridesharingDriverApi = RidesharingDriverApi.createInstance(driverContext);

  4. Consiga o NavigationVehicleReporter do objeto da API. *VehicleReporter estende NavigationVehicleReporter.

    RidesharingVehicleReporter vehicleReporter = ridesharingDriverApi.getRidesharingVehicleReporter();

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 v3, ative as atualizações de localização da seguinte maneira:

RidesharingVehicleReporter reporter = ...;

reporter.enableLocationTracking();

Para atualizar o intervalo do relatório, use RidesharingVehicleReporter.setLocationReportingInterval(long, TimeUnit) ou 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().

Como definir o estado do veículo no servidor

Nas versões anteriores, o objeto FleetEngine era usado para definir o estado do veículo. No SDK do Driver v3, 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(). Os erros ao atualizar o estado do veículo são propagados usando o StatusListener fornecido opcionalmente, definido no DriverContext.

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 um AuthTokenContext como parâmetro. Os clientes de serviço de transporte por aplicativo precisam fazer a autenticação para o tipo de serviço VEHICLE, que permite os relatórios de localização e de estado (on-line/off-line) do veículo.

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