Справочник классов GMSNavigator

Открытые функции-члены | Недвижимость | Связанные функции
Справочник классов GMSNavigator

Обзор

Это основной класс Google Navigation SDK для iOS, предоставляющий методы для управления навигацией к пункту назначения и доступа к информации о маршруте и ходе выполнения.

Этот класс не поддерживает подклассы.

Этот класс не является потокобезопасным. Все методы должны вызываться из основного потока.

Открытые функции-члены

(пустота) - добавить прослушиватель:
Добавляет слушателя.
(БУЛ) - удалить прослушиватель:
Удаляет прослушиватель.
(пустота) - setDestinations: обратный вызов:
Устанавливает несколько пунктов назначения для навигации, отменяя любые ранее установленные пункты назначения.
(пустота) - setDestinations:routingOptions:callback:
Устанавливает несколько пунктов назначения для навигации, отменяя любые ранее установленные пункты назначения.
(пустота) - setDestinations:routeToken:callback:
Устанавливает несколько пунктов назначения для навигации, используя токен маршрута для навигации по заранее рассчитанному маршруту.
(пустота) - getRouteInfoForDestination:withRoutingOptions:callback:
Возвращает информацию о маршруте на основе стратегии маршрутизации: лучший или более короткий маршрут по умолчанию.
(обнуляемый GMSNavigationWaypoint *) - continueToNextDestination
Устарело.
(пустота) - очиститьПункты назначения
Очищает все ранее установленные пункты назначения и удаляет все рассчитанные маршруты с карты.
(НСтимеинтервал) - времяToWaypoint:
Возвращает расчетное время до заданной путевой точки или CLTimeIntervalMax, если путевая точка не является частью текущего маршрута.
(CLLocationDistance) - расстояние до путевой точки:
Возвращает расчетное расстояние до заданной путевой точки или CLLocationDistanceMax, если путевая точка не является частью текущего маршрута.
(пустота) - setTransactionIDs: errorHandler:
Устанавливает и регистрирует на сервере идентификаторы текущих транзакций, которые применяются к событиям навигации во время текущего сеанса навигации.

Характеристики

БООЛ избегает шоссе
Следует ли избегать автомагистралей при создании маршрутов к пунктам назначения.
БООЛ избегает дорожных сборов
Следует ли избегать платных дорог при создании маршрутов к пунктам назначения.
БООЛ избегает паромов
Следует ли избегать паромов при создании маршрутов до пунктов назначения.
GMSNavigationLicensePlateRestriction * лицензияТаблицаОграничение
Установите ограничение номерного знака, указав последнюю цифру номерного знака текущего водителя и код страны.
БООЛ руководствоАктивный
Включено ли в настоящее время пошаговое руководство.
БООЛ стопРуководство по прибытии
Должно ли наведение автоматически прекращаться при вызове -navigator :didArriveAtWaypoint:.
НСтимеинтервал времяUpdateThreshold
Минимальное изменение расчетного времени до следующего пункта назначения, которое приведет к вызову метода navigator:didUpdateRemainingTime: :.
CLLationDistance расстояниеUpdateThreshold
Минимальное изменение предполагаемого расстояния до следующего пункта назначения, которое приведет к вызову метода navigator:didUpdateRemainingDistance: :.
НСтимеинтервал времяToNextDestination
Возвращает расчетное время до следующего пункта назначения.
CLLationDistance расстояниеToNextDestination
Возвращает расчетное расстояние до следующего пункта назначения.
GMSNavigationDelayCategory DelayCategoryToNextDestination
Возвращает категорию задержки к следующему пункту назначения.
GMSRouteLeg * currentRouteLeg
Текущий этап пути.
NSArray< GMSRouteLeg * > * маршрутНоги
Массив участков маршрута, где каждый участок соответствует заданному пункту назначения.
ГМСПуть * пройденныйПуть
Путь, пройденный устройством с момента последнего использования GuideActive, был установлен на YES.
GMSNНавигацияГолосовое руководство голосовое руководство
Определяет, следует ли включать голосовые подсказки для оповещений о дорожном движении и пошаговых оповещениях.
GMSVoiceGuidanceAudioDeviceType аудиодевицетипе
Определяет, через какие аудиоустройства можно воспроизводить голосовые указания.
БООЛ вибрация включена
Определяет, должно ли устройство также вибрировать при воспроизведении голосовых оповещений.
БООЛ отправляет фоновые уведомления
Определяет, будут ли отображаться UILocalNotifications, содержащие справочную информацию, когда приложение находится в фоновом режиме.
GMSNНавигацияОсвещениеРежим предложенный режим освещения
Предлагаемый режим освещения в зависимости от времени суток и местоположения устройства.
БООЛ долженDisplayPrompts
Определяет, следует ли отображать подсказки о пробках, лучших маршрутах и ​​происшествиях.
GMSNavigationSpeedAlertOptions * параметры скоростиAlertOptions
GMSNavigationSpeedAlertOptions для настройки порогов срабатывания GMSNavigationSpeedAlertSeverity.

(Обратите внимание, что это не функции-члены.)

typedef void(^ GMSRouteStatusCallback )( GMSRouteStatusrouteStatus )
Вызывается, когда маршрут от местоположения устройства до указанных пунктов назначения найден или не найден по причине, указанной в RouteStatus.
typedef void(^ GMSRouteInfoCallback )( GMSNavigationRouteInfo *_NullablerouteInfo)
Вызывается, когда рассчитывается информация о маршруте (расчетное время прибытия и расстояние) до указанной путевой точки.
typedef void(^ GMSNavigationTransactionIDErrorHandler )(NSError *error)
Вызывается, если установка идентификаторов транзакций через setTransactionIDs не удалась.

Документация по функциям-членам

- (недействительно) addListener: (id <GMSNavigatorListener> ) слушатель

Добавляет слушателя.

Слушатель удерживается слабой ссылкой.

Параметры:
слушатель Объект, соответствующий протоколу GMSNavigatorListener .
- (BOOL) удалить прослушиватель: (id <GMSNavigatorListener> ) слушатель

Удаляет прослушиватель.

Параметры:
слушатель Объект, соответствующий протоколу GMSNavigatorListener .
Возврат:
Возвращает YES, если прослушиватель был удален. Возвращает NO, если объект не был прослушивателем.
- (void) setDestinations: (NSArray< GMSNavigationWaypoint * > *) направления
перезвонить: ( GMSRouteStatusCallback ) перезвонить

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

Предоставленный обратный вызов будет вызван с GMSRouteStatusOK, если будет найден маршрут от местоположения устройства до заданного пункта назначения. Если новый пункт назначения установлен до того, как маршрут найден, запрос будет отменен, а обратный вызов будет вызван с GMSRouteStatusCanceled. Если маршрут не может быть найден по какой-либо другой причине, обратный вызов будет вызван с соответствующим статусом ошибки.

Обратный вызов всегда будет отправляться асинхронно в основной очереди.

- (void) setDestinations: (NSArray< GMSNavigationWaypoint * > *) направления
Параметры маршрутизации: ( GMSNavigationRoutingOptions *) Параметры маршрутизации
перезвонить: ( GMSRouteStatusCallback ) перезвонить

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

Возвращенные маршруты рассчитываются с использованием параметров маршрутизации.

Параметры:
направления Массив точек назначения.
Параметры маршрутизации Опции, влияющие на логику маршрутизации (стратегию маршрутизации).
перезвонить Вызывается, когда маршрут от местоположения потребителя до заданных пунктов назначения найден или не найден по причине, указанной в RouteStatus.
- (void) setDestinations: (NSArray< GMSNavigationWaypoint * > *) направления
маршрутТокен: (НСтрока *) маршрутТокен
перезвонить: ( GMSRouteStatusCallback ) перезвонить

Устанавливает несколько пунктов назначения для навигации, используя токен маршрута для навигации по заранее рассчитанному маршруту.

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

При использовании токена маршрута для запуска сеанса навигации поддерживаются только GMSNavigationTravelModeDriving и GMSNavigationTravelModeTwoWheeler . Настройте режим путешествия, установив travelMode . Вызов завершится неудачно, если текущий режим передвижения не поддерживается, и в обратном вызове будет возвращено значение GMSRouteStatusTravelModeUnsupported .

Параметры:
направления Массив маршрутных точек назначения должен совпадать с пунктами назначения, указанными API RoutesPreferred для получения токена маршрута.
маршрутТокен Строка токена маршрута, возвращаемая API RoutesPreferred. Параметры маршрутизации, указанные в API RoutesPreferred, закодированы в этом токене маршрута и будут использоваться для повторного создания заранее рассчитанного маршрута или нового маршрута при изменении маршрута.
перезвонить Вызывается, когда маршрут от местоположения потребителя до заданных пунктов назначения найден или не найден по причине, указанной в RouteStatus.
- (недействительно) getRouteInfoForDestination: ( GMSNavigationWaypoint *) место назначения
с параметрами маршрутизации: ( GMSNavigationRoutingOptions *) Параметры маршрутизации
перезвонить: ( GMSRouteInfoCallback ) перезвонить

Возвращает информацию о маршруте на основе стратегии маршрутизации: лучший или более короткий маршрут по умолчанию.

Возвращает nil значение, если у проекта нет разрешения на вызов этого API.

Параметры:
место назначения Маршрутная точка назначения.
Параметры маршрутизации Параметры, используемые для получения информации о маршруте. Стратегия маршрутизации и стратегия альтернативных маршрутов игнорируются, поскольку этот метод возвращает информацию о маршруте для всех стратегий маршрутизации.
перезвонить Обратный вызов, вызываемый при получении информации о маршрутах.
- (обнуляемый GMSNavigationWaypoint *) continueToNextDestination

Устарело.

Вызовите один из методов -setDestinations :... с новым списком пунктов назначения вместо вызова этого метода.

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

Возврат:
направление по путевой точке теперь приближается к нулю или к нулю, если путевых точек больше не осталось.
Примечание:
Это устарело. Вместо этого используйте один из методов -setDestinations:...
- (void) clearDestinations

Очищает все ранее установленные пункты назначения и удаляет все рассчитанные маршруты с карты.

Если наведение активно, оно автоматически остановится.

- (NSTimeInterval) timeToWaypoint: ( GMSNavigationWaypoint *) путевая точка

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

Оно обновляется на основе текущего положения устройства, пока активна навигация.

Возвращает CLTimeIntervalMax, если указанная путевая точка не является пунктом назначения текущего маршрута.

- (CLLocationDistance) distanceToWaypoint: ( GMSNavigationWaypoint *) путевая точка

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

Оно будет обновляться в зависимости от текущего положения устройства, пока навигация активна.

Возвращает CLLocationDistanceMax, если указанная путевая точка не является пунктом назначения на текущем маршруте.

- (недействительно) setTransactionIDs: (NSArray< NSString * > *) идентификаторы транзакций
обработчик ошибок: (обнуляемый GMSNavigationTransactionIDErrorHandler ) обработчик ошибок

Устанавливает и регистрирует на сервере идентификаторы текущих транзакций, которые применяются к событиям навигации во время текущего сеанса навигации.

Идентификаторы транзакций будут удалены в конце сеанса навигации.

Параметры:
идентификаторы транзакций Идентификаторы транзакций, которые применяются к текущему сеансу навигации. Идентификатор транзакции должен быть уникальным для каждой оплачиваемой транзакции. Идентификатор отдельной транзакции должен содержать от одного до 64 символов. Список может быть пустым, если транзакция завершилась (но сеанс все еще продолжается).
обработчик ошибок Блок, который будет вызываться асинхронно в основном потоке в случае возникновения ошибки, когда идентификаторы транзакций недействительны.
- (typedef void(^ GMSRouteStatusCallback )( GMSRouteStatusrouteStatus )) [related]

Вызывается, когда маршрут от местоположения устройства до указанных пунктов назначения найден или не найден по причине, указанной в RouteStatus.

- (typedef void(^ GMSRouteInfoCallback )( GMSNavigationRouteInfo *_NullablerouteInfo)) [related]

Вызывается, когда рассчитывается информация о маршруте (расчетное время прибытия и расстояние) до указанной путевой точки.

Параметры:
информация о маршруте Информация о маршруте до указанного пункта назначения. Будет равно нулю, если расчет не удался.
- (typedef void(^ GMSNavigationTransactionIDErrorHandler )(NSError *error)) [related]

Вызывается, если установка идентификаторов транзакций через setTransactionIDs не удалась.

Более подробную информацию можно найти в документации по API.

Документация на недвижимость

- (BOOL) избегает шоссе [read, write, assign]

Следует ли избегать автомагистралей при создании маршрутов к пунктам назначения.

По умолчанию НЕТ.

- (BOOL) избегаетTolls [read, write, assign]

Следует ли избегать платных дорог при создании маршрутов к пунктам назначения.

По умолчанию НЕТ.

- (BOOL) избегает паромов [read, write, assign]

Следует ли избегать паромов при создании маршрутов до пунктов назначения.

По умолчанию ДА.

- ( GMSNavigationLicensePlateRestriction *) LicensePlateRestriction [read, write, assign]

Установите ограничение номерного знака, указав последнюю цифру номерного знака текущего водителя и код страны.

Это позволяет нам обходить определенные типы дорожных ограничений, основанные на номерном знаке. Это будет применяться только к вызовам setDestinations, выполненным после установки этого значения. В идеале вы должны установить это сразу после получения навигатора.

Установите значение ноль, если нет ограничений по номерным знакам. По умолчанию ноль.

- (BOOL) наведениеАктивно [read, write, assign]

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

Если для параметра GuidActive установлено значение YES, но в данный момент маршрут недоступен, то наведение начнется, когда маршрут станет доступным. Для этого свойства будет установлено значение NO, если будет вызвана функция ClearDestinations или мы прибудем в точку маршрута.

- (BOOL) stopGuidanceAtArrival [read, write, assign]

Должно ли наведение автоматически прекращаться при вызове -navigator :didArriveAtWaypoint:.

Если НЕТ, верхний и нижний колонтитулы навигации будут продолжать отображаться после прибытия. В заголовке навигации будет по-прежнему отображаться последний этап навигации, а в нижнем колонтитуле навигации будет продолжать обновляться оставшееся время и расстояние до тех пор, пока время/расстояние не будет равно 0. Кроме того, -navigator :didUpdateRemainingTime и -navigator :didUpdateRemainingDistance будут продолжаться. Явно установите для guidanceActive NO, чтобы остановить обновление навигации и оставшегося времени/расстояния.

Если ДА, для guidanceActive автоматически будет установлено значение НЕТ по прибытии.

По умолчанию ДА.

- (NSTimeInterval) timeUpdateThreshold [read, write, assign]

Минимальное изменение расчетного времени до следующего пункта назначения, которое приведет к вызову метода navigator:didUpdateRemainingTime: :.

Если для этого параметра установлено значение NSTimeIntervalMax, обратные вызовы обновления времени будут отключены. Если для этого параметра установлено отрицательное значение, будет использоваться пороговое значение по умолчанию, равное одной секунде. По умолчанию одна секунда.

Примечание:
Это значение игнорируется, если ни один прослушиватель не реализует navigator:didUpdateRemainingTime: .
- (CLLocationDistance) distanceUpdateThreshold [read, write, assign]

Минимальное изменение предполагаемого расстояния до следующего пункта назначения, которое приведет к вызову метода navigator:didUpdateRemainingDistance: :.

Если для этого параметра установлено значение CLLocationDistanceMax, обратные вызовы обновления расстояния будут отключены. Если для этого параметра установлено отрицательное значение, будет использоваться пороговое значение по умолчанию в один метр. По умолчанию один метр.

Примечание:
Это значение игнорируется, если ни один прослушиватель не реализует navigator:didUpdateRemainingDistance: .
- (NSTimeInterval) timeToNextDestination [read, assign]

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

Оно будет обновляться в зависимости от текущего положения устройства, пока навигация активна.

Возвращает CLTimeIntervalMax, если маршрут недоступен.

- (CLLocationDistance) distanceToNextDestination [read, assign]

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

Оно будет обновляться в зависимости от текущего положения устройства, пока навигация активна.

Возвращает CLLocationDistanceMax, если маршрут недоступен.

- (GMSNavigationDelayCategory) layCategoryToNextDestination [read, assign]

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

Оно будет обновляться в зависимости от текущего положения устройства, пока навигация активна.

Возвращает GMSNavigationDelayCategoryNoData, если маршрут недоступен или данные о трафике недоступны.

- ( GMSRouteLeg *) currentRouteLeg [read, assign]

Текущий этап пути.

Этот GMSRouteLeg будет иметь начальную позицию как самую последнюю известную (привязку к дороге) позицию устройства.

- (NSArray< GMSRouteLeg *>*) routeLegs [read, assign]

Массив участков маршрута, где каждый участок соответствует заданному пункту назначения.

- ( GMSPath *) travelPath [read, assign]

Путь, пройденный устройством с момента последнего использования GuideActive, был установлен на YES.

Этот путь пуст, если наведение никогда не начиналось. Путь состоит из местоположения с привязкой к дороге, возвращаемого GMSRoadSnappedLocationProvider , но упрощенного для удаления избыточных точек. Например, превращение последовательных коллинеарных точек в один сегмент линии.

- ( GMSNavigationVoiceGuidance ) voiceGuidance [read, write, assign]

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

По умолчанию — GMSNavigationVoiceGuidanceAlertsAndGuidance.

- ( GMSVoiceGuidanceAudioDeviceType ) audioDeviceType [read, write, assign]

Определяет, через какие аудиоустройства можно воспроизводить голосовые указания.

По умолчанию используется GMSVoiceGuidanceAudioDeviceTypeBluetooth.

- (BOOL) вибрация включена [read, write, assign]

Определяет, должно ли устройство также вибрировать при воспроизведении голосовых оповещений.

- (BOOL) sendsBackgroundNotifications [read, write, assign]

Определяет, будут ли отображаться UILocalNotifications, содержащие справочную информацию, когда приложение находится в фоновом режиме.

По умолчанию ДА.

- ( GMSNavigationLightingMode ) предложенныйLightingMode [read, assign]

Предлагаемый режим освещения в зависимости от времени суток и местоположения устройства.

- (BOOL) mustDisplayPrompts [read, write, assign]

Определяет, следует ли отображать подсказки о пробках, лучших маршрутах и ​​происшествиях.

По умолчанию ДА.

- ( GMSNavigationSpeedAlertOptions *) speedAlertOptions [read, write, assign]

GMSNavigationSpeedAlertOptions для настройки порогов срабатывания GMSNavigationSpeedAlertSeverity.

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

Установив ноль, вы не будете получать никаких данных о превышении скорости, и будет отображаться предупреждение о скорости по умолчанию NavSDK: предупреждение о скорости показывает красный текст, когда скорость превышает ограничение скорости более чем на 5 миль в час или на 10 км/ч, и показывает белый текст и красный текст. фон при превышении скорости более 10 миль в час или 20 км/ч.