Point d'entrée de l'API Navigation. Utilisez les méthodes statiques de cette classe pour obtenir une référence à Navigator
.
Récapitulatif des classes imbriquées
@interface | NavigationApi.ErrorCode | Un ErrorCode est un code d'état renvoyé par getNavigator(Activity, NavigatorListener) et getNavigator(Application, NavigatorListener) lorsqu'un Navigator n'a pas pu être obtenu. |
|
interface | NavigationApi.NavigatorListener | Enregistrement d'un NavigatorListener avec getNavigator(Activity, NavigatorListener) pour être informé de l'état de l'élément Navigator . |
|
interface | NavigationApi.OnTermsResponseListener | Enregistrez un OnTermsResponseListener avec showTermsAndConditionsDialog(Activity, String, OnTermsResponseListener) pour être averti lorsque l'utilisateur accepte ou refuse les conditions d'utilisation. |
Récapitulatif des méthodes publiques
statique booléen |
areTermsAccepted(demande d'inscription)
Renvoie
true si l'utilisateur a déjà accepté les conditions d'utilisation de Navigation de Google. |
statique vide |
cleanup()
Nettoie l'état interne des composants du NavSDK.
|
synchronisé statique ForegroundServiceManager |
getForegroundServiceManager(application)
Récupère l'instance du singleton
ForegroundServiceManager . |
statique Chaîne |
getNavSDKVersion()
Renvoie la version actuelle du NavSDK.
|
statique vide |
getNavigator(application d'application, rappel NavigationApi.NavigatorListener)
Récupère l'instance
Navigator . |
statique vide |
getNavigator(Activity activity, rappel NavigationApi.NavigatorListener, TermsAndConditionsCheckOption termsCheck)
Récupère l'instance
Navigator . |
statique vide |
getNavigator(activité d'activité, rappel NavigationApi.NavigatorListener)
Équivaut à
getNavigator(activity, callback, {@link
TermsAndConditionsCheckOption#ENABLED} . |
statique vide |
getNavigatorNoToS(application d'application, rappel NavigationApi.NavigatorListener)
Récupère l'instance
Navigator . |
statique RoadSnappedLocationProvider |
getRoadSnappedLocationProvider(application)
Récupère une instance de
RoadSnappedLocationProvider , qui peut être utilisée pour s'abonner aux positions des utilisateurs capturées sur la route. |
statique NavigationTransactionRecorder |
getTransactionRecorder(application)
Récupère une instance de
NavigationTransactionRecorder , qui peut être utilisée pour enregistrer les transactions liées à la navigation. |
synchronisée statique vide |
initForegroundServiceManager(application d'application, Integer notificationId, String defaultMessage, fournisseur NotificationContentProvider)
Initialise l'instance
ForegroundServiceManager avec les arguments fournis. |
statique vide |
resetTermsAccepted(demande d'inscription)
Réinitialiser les conditions d'utilisation (à des fins de test)
|
statique vide |
showTermsAndConditionsDialog(activité d'activité, chaîne companyName, titre de la chaîne, écouteur NavigationApi.OnTermsResponseListener)
Affiche une boîte de dialogue invitant l'utilisateur à accepter les conditions d'utilisation Navigation de Google, avec l'apparence par défaut.
|
statique vide |
showTermsAndConditionsDialog(Activity activity, String companyName, String title, TermsAndConditionsUIParams uiParams, NavigationApi.OnTermsResponseListener, TermsAndConditionsCheckOption termsAndConditionsCheckOption)
Affiche une boîte de dialogue invitant l'utilisateur à accepter les conditions d'utilisation Navigation de Google.
|
statique vide |
showTermsAndConditionsDialog(activité d'activité, chaîne companyName, écouteur NavigationApi.OnTermsResponseListener)
Affiche une boîte de dialogue invitant l'utilisateur à accepter les conditions d'utilisation de Navigation de Google (avec le titre et l'apparence par défaut).
|
Récapitulatif des méthodes héritées
Méthodes publiques
public statique booléen areTermsAccepted (application)
Renvoie true
si l'utilisateur a déjà accepté les conditions d'utilisation de Navigation de Google.
Cela vous permet de vérifier si vous devez afficher l'écran des termes plus tôt dans l'application, plutôt que lorsque l'utilisateur est sur le point de naviguer quelque part. Par exemple, il peut être judicieux de vérifier cette valeur lorsque votre application affiche d'autres conditions d'utilisation, afin que l'utilisateur puisse accepter toutes les conditions d'utilisation requises pour l'application en une seule tâche.
Paramètres
sur des règles | l'application actuelle |
---|
Renvoie
true
si les conditions ont été acceptées par l'utilisateur, etfalse
dans le cas contraire
public statique vide cleanup ()
Nettoie l'état interne des composants du NavSDK. Si un navigateur actuel existe, le guidage est arrêté et désactivé. À l'avenir, vous ne pourrez plus demander d'instructions à partir de ce navigateur. Appelez cette méthode pour récupérer de la mémoire lorsque votre application n'a plus besoin du navigateur et qu'elle a détruit toutes les références à ce navigateur. Si votre application nécessite un navigateur après cet appel, utilisez getNavigator() pour en créer un. Remarque: La création d'un navigateur prend du temps. Réfléchissez à l'impact d'un délai sur les performances de votre application par rapport aux avantages de la mémoire récupérée.
public statique synchronisé ForegroundServiceManager getForegroundServiceManager (application d'application)
Récupère l'instance du singleton ForegroundServiceManager
. Si initForegroundServiceManager(Application, Integer, String, NotificationContentProvider)
n'est pas appelé avant getForegroundServiceManager(Application)
, un ID de notification, un message et un fournisseur de notifications par défaut sont utilisés.
Paramètres
sur des règles | le Application actuel
|
---|
public statique Chaîne getNavSDKVersion ()
Renvoie la version actuelle du NavSDK.
public statique void getNavigator (application d'application, rappel NavigationApi.NavigatorListener)
Récupère l'instance Navigator
.
Si l'utilisateur n'a pas encore accepté les conditions d'utilisation, le rappel est immédiatement déclenché avec le code d'erreur TERMS_NOT_ACCEPTED
.
Notez que Navigator est un singleton. Si vous appelez cette méthode plusieurs fois, chaque appel renvoie le même Navigator.
Paramètres
sur des règles | le Application actuel |
---|---|
rappel | Un rappel qui est déclenché lorsque Navigator est prêt, ou en cas d'erreur
|
public statique void getNavigator (Activity activity, rappel NavigationApi.NavigatorListener, TermsAndConditionsCheckOption termsCheck)
Récupère l'instance Navigator
.
Si l'utilisateur n'a pas encore accepté les conditions d'utilisation, cet appel affiche une boîte de dialogue l'invitant à respecter les réglementations locales.
Si termsCheck
est défini sur ENABLED
, la boîte de dialogue contient également un lien vers les conditions d'utilisation du SDK Navigation. Le callback
est appelé avec une erreur TERMS_NOT_ACCEPTED
si l'utilisateur n'accepte pas ces conditions.
Notez que Navigator est un singleton. Si vous appelez cette méthode plusieurs fois, chaque appel renvoie le même Navigator.
Paramètres
activité | Activity pour afficher la boîte de dialogue des conditions d'utilisation, si elles n'ont pas encore été acceptées |
---|---|
rappel | Un rappel qui est déclenché lorsque Navigator est prêt, ou en cas d'erreur |
termsCheck | indiquant si la vérification des conditions d'utilisation doit être ignorée |
public statique void getNavigator (Activity activity, rappel NavigationApi.NavigatorListener)
Équivaut à getNavigator(activity, callback, {@link
TermsAndConditionsCheckOption#ENABLED}
.
Paramètres
activité | |
---|---|
rappel |
public statique void getNavigatorNoToS (application d'application, rappel NavigationApi.NavigatorListener)
Récupère l'instance Navigator
.
Contourne les conditions d'utilisation.
Notez que Navigator est un singleton. Si vous appelez cette méthode plusieurs fois, chaque appel renvoie le même Navigator.
Paramètres
sur des règles | le Application actuel. |
---|---|
rappel | Un rappel qui est déclenché lorsque Navigator est prêt, ou en cas d'erreur.
|
public statique RoadSnappedLocationProvider getRoadSnappedLocationProvider (application d'application)
Récupère une instance de RoadSnappedLocationProvider
, qui peut être utilisée pour s'abonner aux positions des utilisateurs capturées sur la route. Notez que si vous vous abonnez aux notifications de position effectuées en arrière-plan, vous risquez d'épuiser la batterie ou de collecter involontairement des données de localisation de l'utilisateur.
Un Navigator
doit être obtenu avec succès avant d'appeler cette méthode. Sinon, il renverra null
.
Paramètres
sur des règles | le Application actuel
|
---|
public statique NavigationTransactionRecorder getTransactionRecorder (application d'application)
Récupère une instance de NavigationTransactionRecorder
, qui peut être utilisée pour enregistrer les transactions liées à la navigation.
Cette classe doit être utilisée si et seulement si votre entreprise est facturée par Google sur la base de la transaction.
Un Navigator
doit être obtenu avec succès avant d'appeler cette méthode. Sinon, il renverra null
.
Paramètres
sur des règles | le Application actuel
|
---|
public statique synchronisé vide initForegroundServiceManager (Application, Integer notificationId, String defaultMessage, NotificationContentProvider)
Initialise l'instance ForegroundServiceManager
avec les arguments fournis.
Cette méthode ne doit être appelée que si vous souhaitez modifier l'un des paramètres par défaut. Sinon, appelez directement getForegroundServiceManager(Application)
. Cette méthode ne peut être appelée qu'une seule fois et doit être appelée avant getForegroundServiceManager(Application)
.
Paramètres
sur des règles | le Application actuel |
---|---|
notificationId | l'identifiant de la notification persistante. |
defaultMessage | Message par défaut à afficher si provider n'est pas spécifié |
fournisseur | une implémentation de NotificationContentProvider .
|
public statique vide resetTermsAccepted (application)
Réinitialiser les conditions d'utilisation (à des fins de test) Ajoutez un appel à cet élément avant tout appel à NavigationApi
si vous souhaitez tester la boîte de dialogue des conditions d'utilisation.
Paramètres
sur des règles | l'application actuelle |
---|
public statique vide showTermsAndConditionsDialog (Activity activity, String companyName, String title, NavigationApi.OnTermsResponseListener écouteur)
Affiche une boîte de dialogue invitant l'utilisateur à accepter les conditions d'utilisation Navigation de Google, avec l'apparence par défaut.
Paramètres
activité | |
---|---|
companyName | |
title | |
écouteur |
Voir également
public statique vide showTermsAndConditionsDialog (Activity activity, String companyName, String title, TermsAndConditionsUIParams uiParams, NavigationApi.OnTermsResponseListener Listen, TermsAndConditionsCheckOption termsAndConditionsCheckOption)
Affiche une boîte de dialogue invitant l'utilisateur à accepter les conditions d'utilisation Navigation de Google. S'il est spécifié, l'écouteur est appelé sur le thread UI, ce qui indique si l'utilisateur accepte les conditions d'utilisation.
Notez que la boîte de dialogue s'affiche même si l'utilisateur a déjà accepté l'invitation. Cette méthode ne doit être appelée que si areTermsAccepted(Application)
est défini sur false
, car un utilisateur ne peut pas accepter les conditions d'utilisation.
Paramètres
activité | Activity sur lequel la boîte de dialogue sera affichée |
---|---|
companyName | le nom de votre entreprise, qui s'affichera dans la boîte de dialogue des conditions d'utilisation |
title | Titre de la boîte de dialogue. Si la valeur est nulle, la boîte de dialogue utilise le titre par défaut. |
uiParams | les paramètres permettant de personnaliser l'apparence de la boîte de dialogue. Si la valeur est nulle, l'apparence par défaut est utilisée. |
écouteur | Un rappel facultatif qui est déclenché lorsque l'utilisateur accepte ou refuse les conditions d'utilisation |
termsAndConditionsCheckOption | TermsAndConditionsCheckOption , qui spécifie les options de vérification des termes et conditions
|
public statique vide showTermsAndConditionsDialog (Activity activity, String companyName, NavigationApi.OnTermsResponseListener écouteur)
Affiche une boîte de dialogue invitant l'utilisateur à accepter les conditions d'utilisation de Navigation de Google (avec le titre et l'apparence par défaut).
Paramètres
activité | |
---|---|
companyName | |
écouteur |