Obserwowanie podróży na urządzeniu z iOS

Wybierz platformę: Android iOS JavaScript

Gdy śledzisz przejazd, aplikacja użytkownika wyświetla mu lokalizację odpowiedniego pojazdu. W tym celu aplikacja musi zacząć śledzić przejazd, aktualizować postępy i przestać śledzić przejazd po jego zakończeniu.

W tym dokumencie opisujemy, jak działa ten proces.

Rozpoczynanie śledzenia przejazdu

Aby zacząć obserwować przejazd:

  • Zbierz wszystkie dane wejściowe użytkownika, takie jak miejsca odbioru i wysiadania, z ViewController.

  • Utwórz nowy ViewController, aby zacząć bezpośrednio śledzić przejazd.

Poniższy przykład pokazuje, jak rozpocząć śledzenie przejazdu natychmiast po załadowaniu widoku.

Swift

/*
 * MapViewController.swift
 */
override func viewDidLoad() {
  super.viewDidLoad()
  ...
  self.mapView = GMTCMapView(frame: UIScreen.main.bounds)
  self.mapView.delegate = self
  self.view.addSubview(self.mapView)
}

func mapViewDidInitializeCustomerState(_: GMTCMapView) {
  self.mapView.pickupLocation = self.selectedPickupLocation
  self.mapView.dropoffLocation = self.selectedDropoffLocation

  self.startConsumerMatchWithLocations(
    pickupLocation: self.mapView.pickupLocation!,
    dropoffLocation: self.mapView.dropoffLocation!
  ) { [weak self] (tripName, error) in
    guard let strongSelf = self else { return }
    if error != nil {
      // print error message.
      return
    }
    let tripService = GMTCServices.shared().tripService
    // Create a tripModel instance for listening the update of the trip
    // specified by this trip name.
    let tripModel = tripService.tripModel(forTripName: tripName)
    // Create a journeySharingSession instance based on the tripModel
    let journeySharingSession = GMTCJourneySharingSession(tripModel: tripModel)
    // Add the journeySharingSession instance on the mapView for UI updating.
    strongSelf.mapView.show(journeySharingSession)
    // Register for the trip update events.
    tripModel.register(strongSelf)

    strongSelf.currentTripModel = tripModel
    strongSelf.currentJourneySharingSession = journeySharingSession
    strongSelf.hideLoadingView()
  }

  self.showLoadingView()
}

Objective-C

/*
 * MapViewController.m
 */
- (void)viewDidLoad {
  [super viewDidLoad];
  ...
  self.mapView = [[GMTCMapView alloc] initWithFrame:CGRectZero];
  self.mapView.delegate = self;
  [self.view addSubview:self.mapView];
}

// Handle the callback when the GMTCMapView did initialized.
- (void)mapViewDidInitializeCustomerState:(GMTCMapView *)mapview {
  self.mapView.pickupLocation = self.selectedPickupLocation;
  self.mapView.dropoffLocation = self.selectedDropoffLocation;

  __weak __typeof(self) weakSelf = self;
  [self startTripBookingWithPickupLocation:self.selectedPickupLocation
                           dropoffLocation:self.selectedDropoffLocation
                                completion:^(NSString *tripName, NSError *error) {
                                  __typeof(self) strongSelf = weakSelf;
                                  GMTCTripService *tripService = [GMTCServices sharedServices].tripService;
                                  // Create a tripModel instance for listening to updates to the trip specified by this trip name.
                                  GMTCTripModel *tripModel = [tripService tripModelForTripName:tripName];
                                  // Create a journeySharingSession instance based on the tripModel.
                                  GMTCJourneySharingSession *journeySharingSession =
                                    [[GMTCJourneySharingSession alloc] initWithTripModel:tripModel];
                                  // Add the journeySharingSession instance on the mapView for updating the UI.
                                  [strongSelf.mapView showMapViewSession:journeySharingSession];
                                  // Register for trip update events.
                                  [tripModel registerSubscriber:self];

                                  strongSelf.currentTripModel = tripModel;
                                  strongSelf.currentJourneySharingSession = journeySharingSession;
                                  [strongSelf hideLoadingView];
                                }];
    [self showLoadingView];
}

Zatrzymywanie śledzenia przejazdu

Przestajesz śledzić przejazd, gdy zostanie on zakończony lub anulowany. Poniższy przykład pokazuje, jak zatrzymać udostępnianie aktywnej podróży.

Swift

/*
 * MapViewController.swift
 */
func cancelCurrentActiveTrip() {
  // Stop the tripModel
  self.currentTripModel.unregisterSubscriber(self)

  // Remove the journey sharing session from the mapView's UI stack.
  self.mapView.hide(journeySharingSession)
}

Objective-C

/*
 * MapViewController.m
 */
- (void)cancelCurrentActiveTrip {
  // Stop the tripModel
  [self.currentTripModel unregisterSubscriber:self];

  // Remove the journey sharing session from the mapView's UI stack.
  [self.mapView hideMapViewSession:journeySharingSession];
}

Aktualizowanie postępów przejazdu

Podczas przejazdu możesz zarządzać jego postępem w ten sposób:

Po zakończeniu lub anulowaniu przejazdu przestań nasłuchiwać aktualizacji. Przykład znajdziesz w sekcji Przykład zatrzymania nasłuchiwania aktualizacji.

Przykład rozpoczęcia nasłuchiwania aktualizacji

Poniższy przykład pokazuje, jak zarejestrować wywołanie zwrotne tripModel.

Swift

/*
 * MapViewController.swift
 */
override func viewDidLoad() {
  super.viewDidLoad()
  // Register for trip update events.
  self.currentTripModel.register(self)
}

Objective-C

/*
 * MapViewController.m
 */
- (void)viewDidLoad {
  [super viewDidLoad];
  // Register for trip update events.
  [self.currentTripModel registerSubscriber:self];
  ...
}

Przykład zatrzymania nasłuchiwania aktualizacji

Z przykładu poniżej dowiesz się, jak anulować rejestrację wywołania zwrotnego tripModel.

Swift

/*
 * MapViewController.swift
 */
deinit {
  self.currentTripModel.unregisterSubscriber(self)
}

Objective-C

/*
 * MapViewController.m
 */
- (void)dealloc {
  [self.currentTripModel unregisterSubscriber:self];
  ...
}

Przykład obsługi aktualizacji przejazdu

Poniższy przykład pokazuje, jak wdrożyć protokół GMTCTripModelSubscriber do obsługi wywołań zwrotnych po zaktualizowaniu stanu przejazdu.

Swift

/*
 * MapViewController.swift
 */
func tripModel(_: GMTCTripModel, didUpdate trip: GMTSTrip?, updatedPropertyFields: GMTSTripPropertyFields) {
  // Update the UI with the new `trip` data.
  self.updateUI(with: trip)
}

func tripModel(_: GMTCTripModel, didUpdate tripStatus: GMTSTripStatus) {
  // Handle trip status did change.
}

func tripModel(_: GMTCTripModel, didUpdateActiveRouteRemainingDistance activeRouteRemainingDistance: Int32) {
  // Handle remaining distance of active route did update.
}

func tripModel(_: GMTCTripModel, didUpdateActiveRoute activeRoute: [GMTSLatLng]?) {
  // Handle trip active route did update.
}

func tripModel(_: GMTCTripModel, didUpdate vehicleLocation: GMTSVehicleLocation?) {
  // Handle vehicle location did update.
}

func tripModel(_: GMTCTripModel, didUpdatePickupLocation pickupLocation: GMTSTerminalLocation?) {
  // Handle pickup location did update.
}

func tripModel(_: GMTCTripModel, didUpdateDropoffLocation dropoffLocation: GMTSTerminalLocation?) {
  // Handle drop off location did update.
}

func tripModel(_: GMTCTripModel, didUpdatePickupETA pickupETA: TimeInterval) {
  // Handle the pickup ETA did update.
}

func tripModel(_: GMTCTripModel, didUpdateDropoffETA dropoffETA: TimeInterval) {
  // Handle the drop off ETA did update.
}

func tripModel(_: GMTCTripModel, didUpdateRemaining remainingWaypoints: [GMTSTripWaypoint]?) {
  // Handle updates to the pickup, dropoff or intermediate destinations of the trip.
}

func tripModel(_: GMTCTripModel, didFailUpdateTripWithError error: Error?) {
  // Handle the error.
}

func tripModel(_: GMTCTripModel, didUpdateIntermediateDestinations intermediateDestinations: [GMTSTerminalLocation]?) {
  // Handle the intermediate destinations being updated.
}

func tripModel(_: GMTCTripModel, didUpdateActiveRouteTraffic activeRouteTraffic: GMTSTrafficData?) {
  // Handle trip active route traffic being updated.
}

Objective-C

/*
 * MapViewController.m
 */
#pragma mark - GMTCTripModelSubscriber implementation

- (void)tripModel:(GMTCTripModel *)tripModel
            didUpdateTrip:(nullable GMTSTrip *)trip
    updatedPropertyFields:(enum GMTSTripPropertyFields)updatedPropertyFields {
  // Update the UI with the new `trip` data.
  [self updateUIWithTrip:trip];
  ...
}

- (void)tripModel:(GMTCTripModel *)tripModel didUpdateTripStatus:(enum GMTSTripStatus)tripStatus {
  // Handle trip status did change.
}

- (void)tripModel:(GMTCTripModel *)tripModel
    didUpdateActiveRouteRemainingDistance:(int32_t)activeRouteRemainingDistance {
   // Handle remaining distance of active route did update.
}

- (void)tripModel:(GMTCTripModel *)tripModel
    didUpdateActiveRoute:(nullable NSArray<GMTSLatLng *> *)activeRoute {
  // Handle trip active route did update.
}

- (void)tripModel:(GMTCTripModel *)tripModel
    didUpdateVehicleLocation:(nullable GMTSVehicleLocation *)vehicleLocation {
  // Handle vehicle location did update.
}

- (void)tripModel:(GMTCTripModel *)tripModel
    didUpdatePickupLocation:(nullable GMTSTerminalLocation *)pickupLocation {
  // Handle pickup location did update.
}

- (void)tripModel:(GMTCTripModel *)tripModel
    didUpdateDropoffLocation:(nullable GMTSTerminalLocation *)dropoffLocation {
  // Handle drop off location did update.
}

- (void)tripModel:(GMTCTripModel *)tripModel didUpdatePickupETA:(NSTimeInterval)pickupETA {
  // Handle the pickup ETA did update.
}

- (void)tripModel:(GMTCTripModel *)tripModel
    didUpdateRemainingWaypoints:(nullable NSArray<GMTSTripWaypoint *> *)remainingWaypoints {
  // Handle updates to the pickup, dropoff or intermediate destinations of the trip.
}

- (void)tripModel:(GMTCTripModel *)tripModel didUpdateDropoffETA:(NSTimeInterval)dropoffETA {
  // Handle the drop off ETA did update.
}

- (void)tripModel:(GMTCTripModel *)tripModel didFailUpdateTripWithError:(nullable NSError *)error {
  // Handle the error.
}

- (void)tripModel:(GMTCTripModel *)tripModel
    didUpdateIntermediateDestinations:
        (nullable NSArray<GMTSTerminalLocation *> *)intermediateDestinations {
  // Handle the intermediate destinations being updated.
}

- (void)tripModel:(GMTCTripModel *)tripModel
    didUpdateActiveRouteTraffic:(nullable GMTSTrafficData *)activeRouteTraffic {
  // Handle trip active route traffic being updated.
}

Obsługa błędów dotyczących przejazdów

Jeśli subskrybujesz tripModel i wystąpi błąd, możesz otrzymać wywołanie zwrotne tripModel, implementując metodę delegowaną tripModel(_:didFailUpdateTripWithError:). Komunikaty o błędach są zgodne ze standardem błędów Google Cloud. Szczegółowe definicje komunikatów o błędach i wszystkie kody błędów znajdziesz w dokumentacji błędów Google Cloud.

Oto kilka typowych błędów, które mogą wystąpić podczas monitorowania przejazdu:

HTTP RPC Opis
400 INVALID_ARGUMENT Klient podał nieprawidłową nazwę przejazdu. Nazwa przejazdu musi mieć format providers/{provider_id}/trips/{trip_id}. provider_id musi być identyfikatorem projektu w chmurze należącego do dostawcy usługi.
401 UNAUTHENTICATED Ten błąd występuje, gdy nie ma prawidłowych danych uwierzytelniających. Na przykład jeśli token JWT jest podpisany bez identyfikatora przejazdu lub token JWT wygasł.
403 PERMISSION_DENIED Ten błąd pojawia się, gdy klient nie ma wystarczających uprawnień (np. użytkownik z rolą konsumenta próbuje wywołać metodę updateTrip), token JWT jest nieprawidłowy lub interfejs API nie jest włączony w projekcie klienta. Może brakować tokena JWT lub token jest podpisany identyfikatorem przejazdu, który nie pasuje do żądanego identyfikatora przejazdu.
429 RESOURCE_EXHAUSTED Limit zasobów wynosi zero lub natężenie ruchu przekracza limit.
503 PRODUKT NIEDOSTĘPNY Usługa niedostępna Zwykle oznacza to, że serwer nie działa.
504 DEADLINE_EXCEEDED Przekroczono termin żądania. Ten błąd występuje tylko wtedy, gdy wywołujący ustawia termin krótszy niż domyślny termin metody (czyli żądany termin nie wystarcza serwerowi na przetworzenie żądania), a żądanie nie zostało zrealizowane w terminie.

Obsługa błędów pakietu Consumer SDK

Pakiet Consumer SDK wysyła błędy aktualizacji przejazdu do aplikacji użytkownika za pomocą mechanizmu wywołania zwrotnego. Parametr wywołania zwrotnego to zwracany typ zależny od platformy (TripUpdateError na Androidzie i NSError na iOS).

Wyodrębnianie kodów stanu

Błędy przekazywane do wywołania zwrotnego to zwykle błędy gRPC. Możesz też wyodrębnić z nich dodatkowe informacje w postaci kodu stanu. Pełną listę kodów stanu znajdziesz w artykule Kody stanu i ich użycie w gRPC.

Swift

Funkcja NSError jest wywoływana w tripModel(_:didFailUpdateTripWithError:).

// Called when there is a trip update error.
func tripModel(_ tripModel: GMTCTripModel, didFailUpdateTripWithError error: Error?) {
  // Check to see if the error comes from gRPC.
  if let error = error as NSError?, error.domain == "io.grpc" {
    let gRPCErrorCode = error.code
    ...
  }
}

Objective-C

Funkcja NSError jest wywoływana w tripModel:didFailUpdateTripWithError:.

// Called when there is a trip update error.
- (void)tripModel:(GMTCTripModel *)tripModel didFailUpdateTripWithError:(NSError *)error {
  // Check to see if the error comes from gRPC.
  if ([error.domain isEqualToString:@"io.grpc"]) {
    NSInteger gRPCErrorCode = error.code;
    ...
  }
}

Interpretowanie kodów stanu

Kody stanu obejmują 2 rodzaje błędów: błędy serwera i sieci oraz błędy po stronie klienta.

Błędy serwera i sieci

Poniższe kody stanu dotyczą błędów sieci lub serwera i nie musisz podejmować żadnych działań, aby je rozwiązać. Pakiet SDK klienta automatycznie je naprawia.

Kod stanuOpis
PRZERWANO Serwer przestał wysyłać odpowiedź. Zwykle jest to spowodowane problemem z serwerem.
ANULOWANO Serwer zakończył odpowiedź wychodzącą. Zwykle dzieje się tak, gdy
aplikacja jest wysyłana do działania w tle lub gdy zmienia się stan
aplikacji użytkownika.
INTERRUPTED
DEADLINE_EXCEEDED Oczekiwanie na odpowiedź serwera trwało zbyt długo.
PRODUKT NIEDOSTĘPNY Serwer był niedostępny. Zwykle jest to spowodowane problemem z siecią.

Błędy klienta

Poniższe kody stanu oznaczają błędy klienta, które wymagają podjęcia działań. Pakiet SDK klienta będzie próbował odświeżyć przejazd, dopóki nie zakończysz udostępniania podróży, ale nie zostanie przywrócony, dopóki nie podejmiesz działania.

Kod stanuOpis
INVALID_ARGUMENT Aplikacja użytkownika podała nieprawidłową nazwę przejazdu. Nazwa przejazdu musi mieć format providers/{provider_id}/trips/{trip_id}.
NOT_FOUND Przejazd nie został utworzony.
PERMISSION_DENIED Aplikacja użytkownika nie ma wystarczających uprawnień. Ten błąd występuje, gdy:
  • Aplikacja użytkownika nie ma uprawnień
  • Pakiet Consumer SDK nie jest włączony w projekcie w konsoli Google Cloud.
  • Brak tokena JWT lub jest on nieprawidłowy.
  • Token JWT jest podpisany identyfikatorem przejazdu, który nie pasuje do żądanego przejazdu.
RESOURCE_EXHAUSTED Limit zasobów wynosi zero lub natężenie ruchu przekracza limit prędkości.
UNAUTHENTICATED Uwierzytelnianie żądania nie powiodło się z powodu nieprawidłowego tokena JWT. Ten błąd występuje, gdy token JWT jest podpisany bez identyfikatora przejazdu lub gdy token JWT wygasł.