API de Navigation

clase final pública NavigationApi extiende Object

Punto de entrada a la API de Navigation. Usa los métodos estáticos de esta clase para obtener una referencia al Navigator.

Resumen de clases anidadas

@interfaz NavigationApi.ErrorCode Un ErrorCode es un código de estado que muestran getNavigator(Activity, NavigatorListener) y getNavigator(Application, NavigatorListener) cuando no se pudo obtener Navigator de forma correcta. 
Interfaz NavigationApi.NavigatorListener Registra un NavigatorListener con getNavigator(Activity, NavigatorListener) para recibir una notificación sobre el estado de dicho Navigator
Interfaz NavigationApi.OnTermsResponseListener Registra un OnTermsResponseListener con showTermsAndConditionsDialog(Activity, String, OnTermsResponseListener) para recibir una notificación cuando el usuario acepte o rechace los Términos y Condiciones. 

Resumen de métodos públicos

booleano estático
areTermsAccepted(solicitud de aplicación)
Muestra true si el usuario aceptó los Términos y Condiciones de Navigation de Google anteriormente.
estático void
cleanup()
Limpia el estado interno de los componentes de NavSDK.
sincronizado estático ForegroundServiceManager
getForegroundServiceManager(Aplicación)
Obtiene la instancia singleton ForegroundServiceManager.
String estática
getNavSDKVersion()
Muestra la versión actual de NavSDK.
estático void
getNavigator(aplicación de aplicación, devolución de llamada NavigationApi.NavigatorListener)
Obtiene la instancia Navigator.
estático void
getNavigator(Actividad de actividad, devolución de llamada de NavigationApi.NavigatorListener, TermsAndConditionsCheckOption termsCheck)
Obtiene la instancia Navigator.
estático void
getNavigator(Actividad de actividad, devolución de llamada NavigationApi.NavigatorListener)
Equivale a getNavigator(activity, callback, {@link TermsAndConditionsCheckOption#ENABLED}.
estático void
getNavigatorNoToS(aplicación de la aplicación, devolución de llamada NavigationApi.NavigatorListener)
Obtiene la instancia Navigator.
estático RoadSnappedLocationProvider
getRoadSnappedLocationProvider(aplicación de la aplicación)
Obtiene una instancia del RoadSnappedLocationProvider, que se puede usar para suscribirse a las ubicaciones del usuario ajustadas por la ruta.
NavigationTransactionRecorder estático
getTransactionRecorder(aplicación de la aplicación)
Obtiene una instancia de NavigationTransactionRecorder, que se puede usar para registrar transacciones relacionadas con la navegación.
sincronizado estático void
initForegroundServiceManager(Aplicación de aplicación, Integer notificationId, String defaultMessage, proveedor NotificationContentProvider)
Inicializa la instancia ForegroundServiceManager con los argumentos proporcionados.
estático void
resetTermsAccepted(solicitud de la aplicación)
Restablece los Términos y Condiciones para realizar pruebas.
estático void
showTermsAndConditionsDialog(Activity activity, String companyName, String title, NavigationApi.OnTermsResponseListener)
Muestra un diálogo que le indica al usuario que acepte los Términos y Condiciones de Navigation de Google con el aspecto predeterminado.
estático void
showTermsAndConditionsDialog(Activity activity, String companyName, String title, TermsAndConditionsUIParams uiParams, NavigationApi.OnTermsResponseListener, TermsAndConditionsCheckOption
Muestra un cuadro de diálogo que le indica al usuario que debe aceptar los Términos y Condiciones de Navigation de Google.
estático void
showTermsAndConditionsDialog(Activity activity, String companyName, NavigationApi.OnTermsResponseListener)
Muestra un diálogo que le indica al usuario que acepte los Términos y Condiciones de Navigation de Google con el título y el estilo predeterminados.

Resumen de métodos heredados

Métodos públicos

público estático booleano areTermsAccepted (Application application)

Muestra true si el usuario aceptó los Términos y Condiciones de Navigation de Google anteriormente.

Puedes usar esto para comprobar si debes mostrar la pantalla de términos antes en la aplicación, en lugar de cuando el usuario está a punto de navegar a algún lugar. Por ejemplo, podría ser apropiado verificar este valor cuando tu app muestra otros términos y condiciones, de modo que el usuario pueda aceptar todos los términos y condiciones que se exigen para la app en una sola tarea.

Parámetros
basada en reglas la aplicación actual
Devuelve
  • true si el usuario aceptó las condiciones y false en caso contrario

público estático void cleanup ()

Limpia el estado interno de los componentes de NavSDK. Si existe un navegador actual, la guía se detiene e inhabilita. No se podrán realizar llamadas futuras de orientación desde este Navegador. Llama a este método para recuperar memoria cuando tu app ya no requiera Navigator y haya destruido todas las referencias a él. Si tu app requiere un navegador Navigator después de esta llamada, usa getNavigator() para crear uno nuevo. Nota: Crear un nuevo Navigator lleva tiempo. Considera el impacto que tendría una demora en el rendimiento de tu app frente a los beneficios de la memoria recuperada.

público estático sincronizado ForegroundServiceManager getForegroundServiceManager (Aplicación de aplicación)

Obtiene la instancia singleton ForegroundServiceManager. Si no se llama a initForegroundServiceManager(Application, Integer, String, NotificationContentProvider) antes de getForegroundServiceManager(Application), se usará un ID, un mensaje y un proveedor de notificaciones predeterminados.

Parámetros
basada en reglas el Application actual

String pública estática getNavSDKVersion ()

Muestra la versión actual de NavSDK.

público estático void getNavigator (aplicación de la aplicación, devolución de llamada NavigationApi.NavigatorListener)

Obtiene la instancia Navigator.

Si el usuario aún no aceptó los términos y condiciones, se realizará la devolución de llamada de inmediato con el código de error TERMS_NOT_ACCEPTED.

Ten en cuenta que Navigator es un singleton; si llamas a este método varias veces, cada llamada mostrará el mismo Navigator.

Parámetros
basada en reglas el Application actual
callback una devolución de llamada que se activará cuando Navigator esté listo, o bien se produzca un error

público estático void getNavigator (Activity activity, devolución de llamada NavigationApi.NavigatorListener, TermsAndConditionsCheckOption termsCheck)

Obtiene la instancia Navigator.

Si el usuario aún no aceptó los Términos y Condiciones, en la llamada se mostrará un diálogo en el que se le pedirá que cumpla con las reglamentaciones locales.

Si termsCheck es ENABLED, el diálogo también contendrá un vínculo a los Términos y Condiciones del SDK de Navigation. Se llamará a callback con un error TERMS_NOT_ACCEPTED si el usuario no acepta estas condiciones.

Ten en cuenta que Navigator es un singleton; si llamas a este método varias veces, cada llamada mostrará el mismo Navigator.

Parámetros
actividad Activity para mostrar el diálogo de Términos y Condiciones, si aún no se aceptaron
callback una devolución de llamada que se activará cuando Navigator esté listo, o bien se produzca un error
termsCheck que indica si se debe omitir la verificación de Términos y Condiciones

público estático void getNavigator (actividad de actividad, devolución de llamada NavigationApi.NavigatorListener)

Equivale a getNavigator(activity, callback, {@link TermsAndConditionsCheckOption#ENABLED}.

Parámetros
actividad
callback

público estático void getNavigatorNoToS (aplicación de la aplicación, devolución de llamada NavigationApi.NavigatorListener)

Obtiene la instancia Navigator.

Omitir los términos y condiciones.

Ten en cuenta que Navigator es un singleton; si llamas a este método varias veces, cada llamada mostrará el mismo Navigator.

Parámetros
basada en reglas el Application actual
callback una devolución de llamada que se activará cuando Navigator esté listo, o se producirá un error.

estática pública RoadSnappedLocationProvider getRoadSnappedLocationProvider (Aplicación de la aplicación)

Obtiene una instancia del RoadSnappedLocationProvider, que se puede usar para suscribirse a las ubicaciones del usuario ajustadas por la ruta. Ten en cuenta que suscribirte a las actualizaciones de ubicación ajustadas en la ruta puede hacer que se agote la batería o que se recopilen de manera accidental datos de ubicación del usuario si se deja ejecutando en segundo plano.

Se debe obtener un Navigator de forma correcta antes de llamar a este método; de lo contrario, mostrará null.

Parámetros
basada en reglas el Application actual

público estático NavigationTransactionRecorder getTransactionRecorder (aplicación de aplicación)

Obtiene una instancia de NavigationTransactionRecorder, que se puede usar para registrar transacciones relacionadas con la navegación.

Esta clase solo se debe usar si Google factura a tu empresa por transacción.

Se debe obtener un Navigator de forma correcta antes de llamar a este método; de lo contrario, mostrará null.

Parámetros
basada en reglas el Application actual

público estático estático sincronizado void initForegroundServiceManager (Aplicación de aplicación, Integer notificationId, String defaultMessage, proveedor NotificationContentProvider)

Inicializa la instancia ForegroundServiceManager con los argumentos proporcionados.

Solo debes llamar a este método si deseas modificar cualquiera de los parámetros predeterminados. De lo contrario, llama directamente a getForegroundServiceManager(Application). Este método solo se puede llamar una vez, y se debe llamar antes de getForegroundServiceManager(Application).

Parámetros
basada en reglas el Application actual
notificationId el ID de la notificación persistente
defaultMessage El mensaje predeterminado que se mostrará si no se especifica un provider
provider una implementación de NotificationContentProvider

público estático void resetTermsAccepted (Application application)

Restablece los Términos y Condiciones para realizar pruebas. Agrega una llamada a esto antes de llamar a NavigationApi si quieres probar el diálogo de los Términos y Condiciones.

Parámetros
basada en reglas la aplicación actual

público estático void showTermsAndConditionsDialog (Activity activity, String companyName, String title, NavigationApi.OnTermsResponseListener)

Muestra un diálogo que le indica al usuario que acepte los Términos y Condiciones de Navigation de Google con el aspecto predeterminado.

Parámetros
actividad
companyName
título
objeto de escucha

público estático showTermsAndConditionsDialogTermsAndConditionsUIParamsNavigationApi.OnTermsResponseListenerTermsAndConditionsCheckOption

Muestra un cuadro de diálogo que le indica al usuario que debe aceptar los Términos y Condiciones de Navigation de Google. Si se especifica, se llamará al objeto de escucha en el subproceso de IU para indicar si el usuario acepta los Términos y Condiciones.

Ten en cuenta que el diálogo aparecerá incluso si el usuario lo aceptó anteriormente. Solo se debe llamar a este método si areTermsAccepted(Application) es false, ya que no es posible que un usuario rechace los Términos y Condiciones.

Parámetros
actividad El elemento Activity en el que se mostrará el diálogo
companyName El nombre de tu empresa, que se mostrará en el diálogo de los Términos y Condiciones.
título el título del diálogo. Si es nulo, el diálogo usará el título predeterminado.
uiParams los parámetros que se usan para personalizar la apariencia del diálogo. Si es nulo, se usa el aspecto predeterminado.
objeto de escucha Una devolución de llamada opcional que se activará cuando el usuario acepte o rechace los Términos y Condiciones
termsAndConditionsCheckOption TermsAndConditionsCheckOption, que especifica las opciones para verificar los Términos y Condiciones

público estático void showTermsAndConditionsDialog (Activity activity, String companyName, NavigationApi.OnTermsResponseListener)

Muestra un diálogo que le indica al usuario que acepte los Términos y Condiciones de Navigation de Google con el título y el estilo predeterminados.

Parámetros
actividad
companyName
objeto de escucha