מדריך להעברה של Android Driver SDK 4.0

בגרסה של Driver SDK ל-Android 4.0 צריך לעדכן את הקוד לפעולות מסוימות. במדריך הזה מפורטים השינויים ומה צריך לעשות כדי להעביר את הקוד.

שינוי שם החבילה

שם החבילה השתנה מ-com.google.android.libraries.ridesharing.driver ל-com.google.android.libraries.mapsplatform.transportation.driver. צריך לעדכן את ההפניות בקוד.

אתחול ה-SDK

בגרסאות קודמות, הפעלתם את ה-SDK של הניווט ולאחר מכן קיבלתם הפניה למחלקה FleetEngine. ב-Driver SDK v4, מפעילים את ה-SDK באופן הבא:

מקבלים אובייקט Navigator מה-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;
      }
    }
);

יוצרים אובייקט DriverContext, ומאכלסים את שדות החובה.

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

משתמשים באובייקט DriverContext כדי לאתחל את *DriverApi.

RidesharingDriverApi ridesharingDriverApi = RidesharingDriverApi.createInstance(driverContext);

מקבלים את ה-NavigationVehicleReporter מאובייקט ה-API. תקופת הניסיון של *VehicleReporter נמשכת NavigationVehicleReporter.
```
RidesharingVehicleReporter vehicleReporter = ridesharingDriverApi.getRidesharingVehicleReporter();
```

הפעלה והשבתה של עדכוני מיקום

בגרסאות קודמות, הייתם מפעילים עדכוני מיקום אחרי שקיבלתם את ההפניה FleetEngine. ב-Driver SDK v4, מפעילים את עדכוני המיקום באופן הבא:

RidesharingVehicleReporter reporter = ...;

reporter.enableLocationTracking();

כדי לעדכן את מרווח הזמן לדיווח, משתמשים ב-RidesharingVehicleReporter.setLocationReportingInterval(long, TimeUnit).

בסיום משמרת הנהג, צריך להשבית את עדכוני המיקום ולסמן את הרכב כלא מקוון על ידי התקשרות ל-NavigationVehicleReporter.disableLocationTracking().

הגדרת מצב הרכב בשרת

בגרסאות קודמות צריך להשתמש באובייקט FleetEngine כדי להגדיר את מצב הרכב. בגרסה 4 של Driver SDK, משתמשים באובייקט RidesharingVehicleReporter כדי להגדיר את מצב הרכב:

RidesharingVehicleReporter reporter = ...;

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

כדי להגדיר את מצב הרכב לערך OFFLINE, מתקשרים אל RidesharingVehicleReporter.disableLocationTracking(). שגיאות בעדכון מצב הרכב מופצות באמצעות ה-StatusListener שמופיע במשתנה אופציונלי של DriverContext.

דיווח שגיאה באמצעות StatusListener

השדה ErrorListener הוסר ומשולב עם StatusListener. אפשר להגדיר אותו כך:

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

אימות מול `AuthTokenFactory`

עכשיו יש ב-AuthTokenFactory רק שיטה אחת, getToken(), שמקבלת את AuthTokenContext כפרמטר. האפשרות ServiceType הוצאה משימוש. עכשיו צריך רק לקבל תביעה עבור מזהה הרכב הכלול, במקום להסתמך על 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);
    }
  }
}