Следите за путешествием в iOS

Выберите платформу: Android iOS JavaScript

Когда вы следите за поездкой, ваше потребительское приложение отображает потребителю местоположение соответствующего транспортного средства. Для этого вашему приложению необходимо начать отслеживать поездку, обновлять ход поездки и прекращать отслеживать поездку после ее завершения.

В этом документе описывается, как работает этот процесс.

Начните следить за поездкой

Вот как вы начинаете следить за поездкой:

  • Соберите все пользовательские данные, такие как места высадки и посадки, из ViewController .

  • Создайте новый ViewController , чтобы начать напрямую следить за поездкой.

В следующем примере показано, как начать отслеживать поездку сразу после загрузки представления.

Быстрый

/*
 * 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()
}

Цель-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];
}

Перестаньте следить за поездкой

Вы перестаете следить за поездкой, когда она завершена или отменена. В следующем примере показано, как прекратить делиться активной поездкой.

Быстрый

/*
 * 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)
}

Цель-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];
}

Обновить ход поездки

Во время поездки вы управляете ходом поездки следующим образом:

Когда поездка завершается или отменяется, перестаньте следить за обновлениями . Пример см. в разделе «Пример прекращения прослушивания обновлений» .

Пример начала прослушивания обновлений

В следующем примере показано, как зарегистрировать обратный вызов tripModel .

Быстрый

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

Цель-C

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

Пример прекращения прослушивания обновлений

В следующем примере показано, как отменить регистрацию обратного вызова tripModel .

Быстрый

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

Цель-C

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

Пример обработки обновлений о поездках

В следующем примере показано, как реализовать протокол GMTCTripModelSubscriber для обработки обратных вызовов при обновлении состояния отключения.

Быстрый

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

Цель-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.
}

Обработка ошибок в поездках

Если вы подписались на tripModel и возникла ошибка, вы можете получить обратный вызов tripModel , реализовав метод делегата tripModel(_:didFailUpdateTripWithError:) . Сообщения об ошибках соответствуют стандарту ошибок Google Cloud. Подробные определения сообщений об ошибках и все коды ошибок см. в документации Google Cloud Errors .

Вот некоторые распространенные ошибки, которые могут возникнуть во время мониторинга поездки:

HTTP ПКП Описание
400 INVALID_ARGUMENT Клиент указал неверное название поездки. Название поездки должно иметь формат providers/{provider_id}/trips/{trip_id} . Provider_id должен быть идентификатором облачного проекта, принадлежащего поставщику услуг.
401 НЕ АУТЕНТИФИЦИРОВАННЫЙ Вы получаете эту ошибку, если нет действительных учетных данных для аутентификации. Например, если токен JWT подписан без идентификатора поездки или срок действия токена JWT истек.
403 ДОСТУП ЗАПРЕЩЕН Вы получаете эту ошибку, если клиент не имеет достаточных разрешений (например, пользователь с ролью потребителя пытается вызвать updateTrip), если токен JWT недействителен или API не включен для клиентского проекта. Токен JWT может отсутствовать или токен подписан идентификатором поездки, который не соответствует запрошенному идентификатору поездки.
429 RESOURCE_EXHAUSTED Квота ресурса равна нулю или скорость трафика превышает лимит.
503 НЕДОСТУПНО Сервис недоступен. Обычно сервер не работает.
504 DEADLINE_EXCEEDED Срок запроса истек. Эта ошибка возникает только в том случае, если вызывающая сторона устанавливает крайний срок, который короче, чем крайний срок по умолчанию для метода (то есть запрошенного крайнего срока недостаточно для того, чтобы сервер обработал запрос), и запрос не был завершен в течение крайнего срока.

Обработка ошибок потребительского SDK

Consumer SDK отправляет ошибки обновления поездки потребительскому приложению с помощью механизма обратного вызова. Параметр обратного вызова — это возвращаемый тип, зависящий от платформы ( TripUpdateError в Android и NSError в iOS).

Извлечь коды состояния

Ошибки, передаваемые обратному вызову, обычно являются ошибками gRPC, и вы также можете извлечь из них дополнительную информацию в виде кода состояния. Полный список кодов состояния см. в разделе Коды состояния и их использование в gRPC .

Быстрый

NSError вызывается обратно в 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
    ...
  }
}

Цель-C

NSError вызывается обратно в 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;
    ...
  }
}

Интерпретация кодов состояния

Коды состояния охватывают два типа ошибок: ошибки сервера и сети, а также ошибки на стороне клиента.

Ошибки сервера и сети

Следующие коды состояния относятся к ошибкам сети или сервера, и вам не нужно предпринимать никаких действий для их устранения. Consumer SDK автоматически восстанавливается после них.

Код состояния Описание
ПРЕРВИРОВАНО Сервер перестал отправлять ответ. Обычно это вызвано проблемой сервера.
ОТМЕНЕНО Сервер прервал исходящий ответ. Обычно это происходит, когда
приложение отправляется в фоновый режим или когда происходит изменение состояния
Потребительское приложение.
ПРЕРЫВАНИЕ
DEADLINE_EXCEEDED Сервер отвечал слишком долго.
НЕДОСТУПНО Сервер был недоступен. Обычно это вызвано проблемой сети.

Ошибки клиента

Следующие коды состояния относятся к ошибкам клиента, и вам необходимо принять меры для их устранения. Consumer SDK продолжает повторять попытки обновить поездку, пока вы не прекратите совместное использование поездки, но не сможет восстановиться, пока вы не предпримете соответствующие действия.

Код состояния Описание
INVALID_ARGUMENT В потребительском приложении указано неверное название поездки; Название поездки должно иметь формат providers/{provider_id}/trips/{trip_id} .
НЕ НАЙДЕНО Поездка так и не была создана.
ДОСТУП ЗАПРЕЩЕН У потребительского приложения недостаточно разрешений. Эта ошибка возникает, когда:
  • У потребительского приложения нет разрешений
  • Consumer SDK не включен для проекта в Google Cloud Console.
  • Токен JWT либо отсутствует, либо недействителен.
  • Токен JWT подписан идентификатором поездки, который не соответствует запрошенной поездке.
RESOURCE_EXHAUSTED Квота ресурса равна нулю, или скорость трафика превышает ограничение скорости.
НЕ АУТЕНТИФИЦИРОВАННЫЙ Запрос не прошел аутентификацию из-за недопустимого токена JWT. Эта ошибка возникает либо в том случае, если токен JWT подписан без идентификатора поездки, либо когда срок действия токена JWT истек.