Когда вы отслеживаете поездку, в вашем приложении для пользователей показывается местоположение нужного транспортного средства. Для этого приложению необходимо начать отслеживать поездку, обновлять информацию о ее ходе и прекратить отслеживание, когда поездка завершится.
В этой статье рассказывается, как это происходит.
Как начать отслеживать поездку
Вот как начать отслеживать поездку:
Соберите все данные, введенные пользователем, например адреса отправки и получения, из
ViewController.Создайте новый объект
ViewController, чтобы начать отслеживать поездку.
В примере ниже показано, как начать отслеживание поездки сразу после загрузки представления.
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];
}
Как отменить подписку на маршрут
Вы перестанете отслеживать поездку, когда она завершится или будет отменена. В примере ниже показано, как прекратить делиться информацией об активной поездке.
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];
}
Обновить статус поездки
Во время поездки вы управляете ее ходом следующим образом:
Начать слушать обновления. Пример приведен в разделе Пример: запуск отслеживания обновлений.
Обрабатывайте изменения в поездке. Пример можно посмотреть в разделе Обработка уточнений рейсов.
Когда поездка завершается или отменяется, прекратите отслеживать обновления. Пример приведен в разделе Пример прекращения прослушивания обновлений.
Пример запуска прослушивания обновлений
В следующем примере показано, как зарегистрировать обратный вызов 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];
...
}
Пример прекращения прослушивания обновлений
В примере ниже показано, как отменить регистрацию обратного вызова tripModel.
Swift
/*
* MapViewController.swift
*/
deinit {
self.currentTripModel.unregisterSubscriber(self)
}
Objective-C
/*
* MapViewController.m
*/
- (void)dealloc {
[self.currentTripModel unregisterSubscriber:self];
...
}
Пример обработки обновлений о поездке
В примере ниже показано, как реализовать протокол GMTCTripModelSubscriber для обработки обратных вызовов при обновлении статуса поездки.
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.
}
Как устранять ошибки в поездках
Если вы подписались на tripModel и произошла ошибка, вы можете получить обратный вызов tripModel, реализовав метод делегата tripModel(_:didFailUpdateTripWithError:). Сообщения об ошибках соответствуют стандарту ошибок Google Cloud. Подробные описания сообщений об ошибках и все коды ошибок можно найти в документации по ошибкам Google Cloud.
Ниже перечислены распространенные ошибки, которые могут возникнуть при отслеживании поездки.
| HTTP | Доход от клика | Описание |
|---|---|---|
| 400 | INVALID_ARGUMENT | Клиент указал недопустимое название поездки. Название поездки должно соответствовать формату providers/{provider_id}/trips/{trip_id}. provider_id должен быть идентификатором облачного проекта, принадлежащего поставщику услуг. |
| 401 | UNAUTHENTICATED | Эта ошибка возникает, если нет действительных учетных данных для аутентификации. Например, если токен JWT подписан без идентификатора поездки или срок действия токена JWT истек. |
| 403 | PERMISSION_DENIED | Эта ошибка возникает, если у клиента недостаточно разрешений (например, пользователь с ролью потребителя пытается вызвать updateTrip), если токен JWT недействителен или если API не включен для клиентского проекта. Возможно, токен JWT отсутствует или подписан с идентификатором рейса, который не совпадает с запрошенным. |
| 429 | RESOURCE_EXHAUSTED | Квота ресурса равна нулю или частота трафика превышает лимит. |
| 503 | UNAVAILABLE | Сервис недоступен. Обычно это означает, что сервер не работает. |
| 504 | DEADLINE_EXCEEDED | Превышен срок выполнения запроса. Эта ошибка возникает только в том случае, если вызывающая сторона устанавливает срок, который короче срока по умолчанию для метода (то есть запрошенный срок недостаточен для обработки запроса сервером), и запрос не был выполнен в течение этого срока. |
Как устранять ошибки Consumer SDK
Consumer SDK отправляет ошибки обновления поездки в приложение для пользователей с помощью механизма обратного вызова. Параметр обратного вызова – это тип возвращаемого значения, зависящий от платформы (TripUpdateError на Android и NSError на iOS).
Извлечение кодов статуса
Ошибки, передаваемые обратному вызову, обычно являются ошибками gRPC. Вы также можете извлечь из них дополнительную информацию в виде кода статуса. Полный список кодов статуса приведен в статье Коды статуса и их использование в gRPC.
Swift
Функция 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
...
}
}
Objective-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 автоматически восстанавливает подключение.
| Код статуса | Описание |
|---|---|
| ABORTED | Сервер прекратил отправку ответа. Обычно это вызвано проблемой на сервере. |
| ОТМЕНЕН | Сервер завершил исходящий ответ. Обычно это происходит, когда приложение переходит в фоновый режим или когда меняется состояние приложения для пользователей. |
| INTERRUPTED | |
| DEADLINE_EXCEEDED | Сервер слишком долго отвечал. |
| UNAVAILABLE | Сервер был недоступен. Обычно это происходит из-за проблем с сетью. |
Ошибки клиента
Следующие коды статуса относятся к ошибкам клиента, и вам необходимо принять меры, чтобы устранить их. Consumer SDK будет продолжать попытки обновить информацию о поездке, пока вы не отключите функцию "Поделиться маршрутом", но восстановить данные не получится, пока вы не предпримете никаких действий.
| Код статуса | Описание |
|---|---|
| INVALID_ARGUMENT | Приложение для пользователей указало недопустимое название поездки. Название поездки должно соответствовать формату providers/{provider_id}/trips/{trip_id}.
|
| NOT_FOUND | Поездка не была создана. |
| PERMISSION_DENIED | У приложения для пользователей недостаточно разрешений. Эта ошибка возникает в следующих случаях:
|
| RESOURCE_EXHAUSTED | Квота ресурсов равна нулю или скорость трафика превышает ограничение. |
| UNAUTHENTICATED | Запрос не прошел аутентификацию из-за недопустимого токена JWT. Эта ошибка возникает, если токен JWT подписан без идентификатора поездки или если срок действия токена JWT истек. |