NavigationApi

публичный конечный класс NavigationApi расширяет объект

Точка входа в API навигации. Используйте статические методы этого класса, чтобы получить ссылку на Navigator .

Сводка вложенных классов

@интерфейс НавигацияАпи.ErrorCode ErrorCode — это код состояния, возвращаемый методами getNavigator(Activity, NavigatorListener) и getNavigator(Application, NavigatorListener) , когда Navigator не удалось успешно получить.
интерфейс НавигацияApi.NavigatorListener Зарегистрируйте NavigatorListener с помощью getNavigator(Activity, NavigatorListener) , чтобы получать уведомления о статусе указанного Navigator .
интерфейс НавигацияApi.OnTermsResponseListener Зарегистрируйте OnTermsResponseListener с помощью showTermsAndConditionsDialog(Activity, String, OnTermsResponseListener) чтобы получать уведомления, когда пользователь принимает или отклоняет условия.

Краткое описание общедоступного метода

статическое логическое значение
areTermsAccepted (приложение-приложение)
Возвращает true , если пользователь ранее принял условия использования навигации Google.
статическая пустота
уборка ()
Очищает внутреннее состояние компонентов NavSDK.
синхронизированный статический ForegroundServiceManager
getForegroundServiceManager (приложение-приложение)
Получает одноэлементный экземпляр ForegroundServiceManager .
статическая строка
getNavSDKVersion ()
Возвращает текущую версию NavSDK.
статическая пустота
getNavigator (Приложение, обратный вызов NavigationApi.NavigatorListener )
Получает экземпляр Navigator .
статическая пустота
getNavigator (активность, обратный вызов NavigationApi.NavigatorListener , TermsAndConditionsCheckOption , termCheck)
Получает экземпляр Navigator .
статическая пустота
getNavigator (активность, обратный вызов NavigationApi.NavigatorListener )
Эквивалент getNavigator(activity, callback, {@link TermsAndConditionsCheckOption#ENABLED} .
статическая пустота
getNavigatorNoToS (приложение, обратный вызов NavigationApi.NavigatorListener )
Получает экземпляр Navigator .
статический RoadSnappedLocationProvider
getRoadSnappedLocationProvider (приложение-приложение)
Получает экземпляр RoadSnappedLocationProvider , который можно использовать для подписки на местоположения пользователей, привязанных к дороге.
статический NavigationTransactionRecorder
getTransactionRecorder (приложение-приложение)
Получает экземпляр NavigationTransactionRecorder , который можно использовать для записи транзакций, связанных с навигацией.
синхронизированная статическая пустота
initForegroundServiceManager (приложение, целочисленный идентификатор уведомления, строка defaultMessage, поставщик NotificationContentProvider )
Инициализирует экземпляр ForegroundServiceManager с предоставленными аргументами.
статическая пустота
resetTermsAccepted (приложение-приложение)
Сбросить условия - для тестирования.
статическая пустота
showTermsAndConditionsDialog (активность, строка имя компании, заголовок строки, прослушиватель NavigationApi.OnTermsResponseListener )
Отображает диалоговое окно, предлагающее пользователю принять положения и условия навигации Google, используя внешний вид по умолчанию.
статическая пустота
showTermsAndConditionsDialog (Действие активности, String CompanyName, String Title, TermsAndConditionsUIParams uiParams, NavigationApi.OnTermsResponseListener прослушиватель, TermsAndConditionsCheckOption termAndConditionsCheckOption)
Отображает диалоговое окно, предлагающее пользователю принять положения и условия навигации Google.
статическая пустота
showTermsAndConditionsDialog (активность действия, строка имя компании, прослушиватель NavigationApi.OnTermsResponseListener )
Отображает диалоговое окно, предлагающее пользователю принять положения и условия навигации Google, используя заголовок по умолчанию и внешний вид по умолчанию.

Сводка унаследованных методов

Публичные методы

общедоступное статическое логическое значение areTermsAccepted (приложение-приложение)

Возвращает true , если пользователь ранее принял условия использования навигации Google.

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

Параметры
приложение текущее приложение
Возврат
  • true , если условия были приняты пользователем, и false в противном случае.

публичная очистка статической пустоты ()

Очищает внутреннее состояние компонентов NavSDK. Если текущий навигатор существует, наведение останавливается и отключается. С помощью этого навигатора в будущем нельзя будет выполнять запросы на указания. Вызовите этот метод, чтобы восстановить память, когда вашему приложению больше не требуется навигатор и ваше приложение уничтожило все ссылки на навигатор. Если вашему приложению после этого вызова требуется навигатор, используйте getNavigator(), чтобы создать новый. Примечание. Создание нового навигатора требует времени; подумайте, как задержка повлияет на производительность вашего приложения по сравнению с преимуществами восстановленной памяти.

общедоступный статический синхронизированный ForegroundServiceManager getForegroundServiceManager (приложение-приложение)

Получает одноэлементный экземпляр ForegroundServiceManager . Если initForegroundServiceManager(Application, Integer, String, NotificationContentProvider) не вызывается перед getForegroundServiceManager(Application) , будет использоваться идентификатор уведомления, сообщение и поставщик уведомлений по умолчанию.

Параметры
приложение текущее Application

общедоступная статическая строка getNavSDKVersion ()

Возвращает текущую версию NavSDK.

public static void getNavigator (приложение-приложение, обратный вызов NavigationApi.NavigatorListener )

Получает экземпляр Navigator .

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

Обратите внимание, что Navigator является одноэлементным; если вы вызовете этот метод несколько раз, каждый вызов вернет один и тот же Navigator.

Параметры
приложение текущее Application
перезвонить обратный вызов, который будет запущен, когда Navigator будет готов или произойдет ошибка

public static void getNavigator (активность, обратный вызов NavigationApi.NavigatorListener , TermsAndConditionsCheckOption termCheck)

Получает экземпляр Navigator .

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

Если termsCheck ENABLED , диалоговое окно также будет содержать ссылку на Условия и положения для Navigation SDK. callback будет вызван с ошибкой TERMS_NOT_ACCEPTED , если пользователь не примет эти условия.

Обратите внимание, что Navigator является одноэлементным; если вы вызовете этот метод несколько раз, каждый вызов вернет один и тот же Navigator.

Параметры
активность Activity для отображения диалогового окна условий использования, если они еще не были приняты.
перезвонить обратный вызов, который будет запущен, когда Navigator будет готов или произойдет ошибка
УсловияПроверить указывающий, следует ли пропустить проверку Условий и положений

public static void getNavigator (активность активности, обратный вызов NavigationApi.NavigatorListener )

Эквивалент getNavigator(activity, callback, {@link TermsAndConditionsCheckOption#ENABLED} .

Параметры
активность
перезвонить

public static void getNavigatorNoToS (приложение, обратный вызов NavigationApi.NavigatorListener )

Получает экземпляр Navigator .

Обходит условия.

Обратите внимание, что Navigator является одноэлементным; если вы вызовете этот метод несколько раз, каждый вызов вернет один и тот же Navigator.

Параметры
приложение текущее Application .
перезвонить обратный вызов, который будет запущен, когда Navigator будет готов или произойдет ошибка.

общедоступный статический RoadSnappedLocationProvider getRoadSnappedLocationProvider (приложение-приложение)

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

Перед вызовом этого метода необходимо успешно получить Navigator , иначе он вернет значение null .

Параметры
приложение текущее Application

общедоступный статический NavigationTransactionRecorder getTransactionRecorder (приложение-приложение)

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

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

Перед вызовом этого метода необходимо успешно получить Navigator , иначе он вернет значение null .

Параметры
приложение текущее Application

общедоступная статическая синхронизированная пустота initForegroundServiceManager (приложение, целочисленный идентификатор уведомления, строка defaultMessage, поставщик NotificationContentProvider )

Инициализирует экземпляр ForegroundServiceManager с предоставленными аргументами.

Это следует вызывать только в том случае, если вы хотите изменить какой-либо из параметров по умолчанию. В противном случае вызовите getForegroundServiceManager(Application) напрямую. Этот метод можно вызвать только один раз и он должен быть вызван перед getForegroundServiceManager(Application) .

Параметры
приложение текущее Application
идентификатор уведомления идентификатор уведомления для постоянного уведомления
defaultMessage сообщение по умолчанию, которое будет отображаться, если provider не указан
поставщик реализация NotificationContentProvider

public static void resetTermsAccepted (приложение-приложение)

Сбросить условия - для тестирования. Добавьте вызов перед любыми вызовами NavigationApi , если вы хотите протестировать диалоговое окно условий использования.

Параметры
приложение текущее приложение

public static void showTermsAndConditionsDialog (действия активности, String CompanyName, String Title, прослушиватель NavigationApi.OnTermsResponseListener )

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

Параметры
активность
Название компании
заголовок
слушатель

public static void showTermsAndConditionsDialog (Активность, String CompanyName, String title, TermsAndConditionsUIParams uiParams, NavigationApi.OnTermsResponseListener прослушиватель, TermsAndConditionsCheckOption termAndConditionsCheckOption)

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

Обратите внимание, что диалоговое окно появится, даже если пользователь ранее принял его. Это следует вызывать только в том случае, если areTermsAccepted(Application) имеет значение false , поскольку пользователь не может отказаться от принятия условий.

Параметры
активность Activity , в которой будет отображаться диалог
Название компании название вашей компании, которое будет отображаться в диалоговом окне условий использования.
заголовок заголовок диалога. Если значение равно нулю, в диалоговом окне будет использоваться заголовок по умолчанию.
uiParams параметры, используемые для настройки внешнего вида диалогового окна. Если значение равно нулю, используется внешний вид по умолчанию.
слушатель необязательный обратный вызов, который будет запущен, когда пользователь принимает или отклоняет условия
УсловияИУсловияПроверкаОпция TermsAndConditionsCheckOption , который определяет параметры проверки условий и положений.

public static void showTermsAndConditionsDialog (активность, String CompanyName, прослушиватель NavigationApi.OnTermsResponseListener )

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

Параметры
активность
Название компании
слушатель