Nawigacja po interfejsie API

publiczna klasa końcowa NavigationApi rozszerza obiekt Object

Punkt wejścia do interfejsu API nawigacji. Użyj metod statycznych w tej klasie, aby uzyskać odwołanie do Navigator.

Podsumowanie zagnieżdżonych zajęć

@interfejs NavigationApi.ErrorCode Kod błędu jest kodem stanu zwracanym przez funkcje getNavigator(Activity, NavigatorListener) i getNavigator(Application, NavigatorListener), gdy nie można uzyskać wartości Navigator. 
interfejs, NavigationApi.NavigatorListener Zarejestruj NavigatorListener w usłudze getNavigator(Activity, NavigatorListener), aby otrzymywać powiadomienia o stanie wypowiedzi Navigator. 
interfejs, NavigationApi.OnTermsResponseListener Zarejestruj funkcję OnTermsResponseListener w usłudze showTermsAndConditionsDialog(Activity, String, OnTermsResponseListener), aby otrzymywać powiadomienia, gdy użytkownik zaakceptuje lub odrzuci warunki korzystania z usługi. 

Podsumowanie metod publicznych

statyczna wartość logiczna
areTermsAccepted(zgłoszenie)
Zwraca wartość true, jeśli użytkownik wcześniej zaakceptował warunki korzystania z nawigacji Google.
statyczny stan nieważny
cleanup()
Usuwa wewnętrzny stan komponentów NavSDK.
zsynchronizowany statyczny ForegroundServiceManager
getForegroundServiceManager(aplikacja aplikacji)
Uzyskuje pojedynczą instancję ForegroundServiceManager.
statyczny ciąg znaków
getNavSDKVersion()
Zwraca bieżącą wersję pakietu NavSDK.
statyczny stan nieważny
getNavigator(aplikacja aplikacji, wywołanie zwrotne NavigationApi.NavigatorListener)
Pobiera instancję Navigator.
statyczny stan nieważny
getNavigator(aktywność związana z aktywnością, wywołanie zwrotne NavigationApi.NavigatorListener, sprawdzanie warunków TermsAndConditionsCheckOption)
Pobiera instancję Navigator.
statyczny stan nieważny
getNavigator(aktywność związana z aktywnością, wywołanie zwrotne NavigationApi.NavigatorListener)
Odpowiednik: getNavigator(activity, callback, {@link TermsAndConditionsCheckOption#ENABLED}.
statyczny stan nieważny
getNavigatorNoToS(aplikacja aplikacji, wywołanie zwrotne NavigationApi.NavigatorListener)
Pobiera instancję Navigator.
static RoadSnappedLocationProvider
getRoadSnappedLocationProvider(aplikacja aplikacji)
Pobiera instancję RoadSnappedLocationProvider, której można użyć do subskrybowania lokalizacji użytkowników niedostępnych na drogach.
static NavigationTransactionRecorder
getTransactionRecorder(aplikacja aplikacji)
Pobiera instancję NavigationTransactionRecorder, której można używać do rejestrowania transakcji związanych z nawigacją.
zsynchronizowana statyczna nieważna
initForegroundServiceManager (aplikacja aplikacji, identyfikator powiadomienia (całkowita), dostawca ciągu domyślnego, dostawca NotificationContentProvider.
Inicjuje instancję ForegroundServiceManager przy użyciu podanych argumentów.
statyczny stan nieważny
resetTermsAccepted(aplikacja)
Zresetuj warunki korzystania z usługi – w celu testowania.
statyczny stan nieważny
showTermsAndConditionsDialog(aktywność związana z aktywnością, nazwa firmy z ciągiem znaków, tytuł ciągu, detektor NavigationApi.OnTermsResponseListener)
Wyświetla okno, które zachęca użytkownika do zaakceptowania warunków korzystania z Nawigacji Google przy użyciu domyślnego wyglądu i stylu.
statyczny stan nieważny
showTermsAndConditionsDialog(Activity activity, String companyName, String title, TermsAndConditionsUIParams uiParams, NavigationApi.OnTermsResponseListener, detektor TermsAndConditionsCheckOption termsAndConditionsCheckOption)
Wyświetla okno z prośbą o zaakceptowanie warunków korzystania z usługi Nawigacja.
statyczny stan nieważny
showTermsAndConditionsDialog(aktywność związana z aktywnością, ciąg znaków firmy, odbiornik NavigationApi.OnTermsResponseListener)
Wyświetla okno, które zaleca użytkownikowi zaakceptowanie warunków korzystania z Nawigacji Google przy użyciu domyślnego tytułu oraz domyślnego wyglądu i stylu.

Podsumowanie metod dziedziczonych

Metody publiczne

public static boolean areTermsAccepted (Aplikacja aplikacji)

Zwraca wartość true, jeśli użytkownik wcześniej zaakceptował warunki korzystania z nawigacji Google.

W ten sposób możesz sprawdzić, czy ekran z hasłami powinien się wyświetlić wcześniej w aplikacji, a nie wtedy, gdy użytkownik będzie chciał przejść do innego miejsca. Możesz na przykład sprawdzić tę wartość, gdy w aplikacji wyświetlane są inne warunki korzystania z usługi, aby użytkownik mógł zaakceptować wszystkie warunki korzystania z aplikacji w jednym zadaniu.

Parametry
aplikacji ML bieżąca aplikacja
Akcje powrotne
  • true, jeśli warunki zostały zaakceptowane przez użytkownika, lub false w innym przypadku

public static void cleanup ()

Usuwa wewnętrzny stan komponentów NavSDK. Jeśli istnieje bieżący nawigator, wskazówki zostaną zatrzymane i wyłączone. W tym nawigatorze nie będzie można w przyszłości prosić o wskazówki. Wywołaj tę metodę, aby odzyskać pamięć, jeśli aplikacja nie wymaga już nawigacji, a aplikacja zniszczyła wszystkie odwołania do niej. Jeśli po tym wywołaniu Twoja aplikacja wymaga Nawigatora, użyj funkcji getNavigator(), by utworzyć nową. Uwaga: utworzenie nowego Nawigatora wymaga czasu. Zastanów się, jak opóźnienie wpłynęłoby na wydajność aplikacji, w porównaniu z korzyściami odzyskanymi z pamięci.

publiczna statyczna zsynchronizowana ForegroundServiceManager getForegroundServiceManager (aplikacja aplikacji)

Uzyskuje pojedynczą instancję ForegroundServiceManager. Jeśli funkcja initForegroundServiceManager(Application, Integer, String, NotificationContentProvider) nie zostanie wywołana przed getForegroundServiceManager(Application), zostanie użyty domyślny identyfikator powiadomień, wiadomości i dostawców powiadomień.

Parametry
aplikacji ML obecna wartość Application

public static Ciąg getNavSDKVersion ()

Zwraca bieżącą wersję pakietu NavSDK.

public static void getNavigator (aplikacja aplikacji, wywołanie zwrotne NavigationApi.NavigatorListener)

Pobiera instancję Navigator.

Jeśli użytkownik nie zaakceptował jeszcze warunków korzystania z usługi, wywołanie zwrotne zostanie natychmiast uruchomione z kodem błędu TERMS_NOT_ACCEPTED.

Pamiętaj, że Navigator jest pojedynczym poleceniem; jeśli wywołasz tę metodę wiele razy, każde wywołanie zwróci tego samego nawigatora.

Parametry
aplikacji ML obecna wartość Application
wywołanie zwrotne wywołanie zwrotne, które jest wywoływane, gdy Navigator będzie gotowy lub wystąpi błąd;

public static void getNavigator (Aktywność związana z aktywnością, NavigationApi.NavigatorListener wywołanie zwrotne, TermsAndConditionsCheckOptionWarunki)

Pobiera instancję Navigator.

Jeśli użytkownik nie zaakceptował jeszcze warunków korzystania z usługi, w wywołaniu pojawi się okno z prośbą o przestrzeganie lokalnych przepisów.

Jeśli termsCheck ma wartość ENABLED, okno będzie też zawierać link do warunków korzystania z pakietu SDK nawigacji. Jeśli użytkownik nie zaakceptuje tych warunków, zostanie wywołany callback z błędem TERMS_NOT_ACCEPTED.

Pamiętaj, że Navigator jest pojedynczym poleceniem; jeśli wywołasz tę metodę wiele razy, każde wywołanie zwróci tego samego nawigatora.

Parametry
aktywność [plural: aktywności] Activity, aby wyświetlić okno z warunkami korzystania z usługi, jeśli nie zostały jeszcze zaakceptowane.
wywołanie zwrotne wywołanie zwrotne, które jest wywoływane, gdy Navigator będzie gotowy lub wystąpi błąd;
termsCheck wskazujące, czy należy pominąć sprawdzanie Warunków korzystania z usługi.

public static void getNavigator (Aktywność związana z aktywnością, wywołanie zwrotne NavigationApi.NavigatorListener)

Odpowiednik: getNavigator(activity, callback, {@link TermsAndConditionsCheckOption#ENABLED}.

Parametry
aktywność [plural: aktywności]
wywołanie zwrotne
Zobacz również

public static void getNavigatorNoToS (aplikacja aplikacji, wywołanie zwrotne NavigationApi.NavigatorListener)

Pobiera instancję Navigator.

Oznacza naruszenie warunków korzystania z usługi.

Pamiętaj, że Navigator jest pojedynczym poleceniem; jeśli wywołasz tę metodę wiele razy, każde wywołanie zwróci tego samego nawigatora.

Parametry
aplikacji ML aktualna wartość: Application.
wywołanie zwrotne wywołanie zwrotne, które jest wywoływane, gdy Navigator będzie gotowy lub gdy wystąpi błąd.

public static RoadSnappedLocationProvider getRoadSnappedLocationProvider (aplikacja aplikacji)

Pobiera instancję RoadSnappedLocationProvider, której można użyć do subskrybowania lokalizacji użytkowników niedostępnych na drogach. Pamiętaj, że subskrypcja aktualizacji lokalizacji ograniczonych do drogi może powodować rozładowywanie baterii lub niezamierzone zbieranie danych o lokalizacji użytkownika, jeśli będzie działać w tle.

Przed wywołaniem tej metody należy uzyskać obiekt Navigator. W przeciwnym razie zwróci ona null.

Parametry
aplikacji ML obecna wartość Application

public static NavigationTransactionRecorder getTransactionRecorder (aplikacja aplikacji)

Pobiera instancję NavigationTransactionRecorder, której można używać do rejestrowania transakcji związanych z nawigacją.

Tej klasy należy używać tylko wtedy, gdy Twoja firma jest rozliczana przez Google na podstawie transakcji.

Przed wywołaniem tej metody należy uzyskać obiekt Navigator. W przeciwnym razie zwróci ona null.

Parametry
aplikacji ML obecna wartość Application

public static sync void initForegroundServiceManager (Aplikacja aplikacji, Integer notificationId, String defaultMessage, dostawca NotificationContentProvider)

Inicjuje instancję ForegroundServiceManager przy użyciu podanych argumentów.

Należy je wywoływać tylko wtedy, gdy chcesz zmodyfikować dowolny z parametrów domyślnych. W przeciwnym razie zadzwoń bezpośrednio do firmy getForegroundServiceManager(Application). Tę metodę można wywołać tylko raz i należy ją wywołać przed getForegroundServiceManager(Application).

Parametry
aplikacji ML obecna wartość Application
notificationId identyfikator powiadomienia trwałego
defaultMessage komunikat domyślny wyświetlany, jeśli provider nie został określony.
dostawca wdrożenie NotificationContentProvider

public static void resetTermsAccepted (Aplikacja aplikacji)

Zresetuj warunki korzystania z usługi – w celu testowania. Dodaj wywołanie do tego przed wywołaniami funkcji NavigationApi, jeśli chcesz przetestować okno warunków korzystania z usługi.

Parametry
aplikacji ML bieżąca aplikacja

public static void showTermsAndConditionsDialog (Aktywność związana z aktywnością, String companyName, tytuł ciągu znaków, odbiornik NavigationApi.OnTermsResponseListener)

Wyświetla okno, które zachęca użytkownika do zaakceptowania warunków korzystania z Nawigacji Google przy użyciu domyślnego wyglądu i stylu.

Parametry
aktywność [plural: aktywności]
companyName
title
detektor
Zobacz również

public static void showTermsAndConditionsDialog (Activity activity, String companyName, String title, TermsAndConditionsUIParams uiParams, NavigationApi.OnTermsResponseListener odbiornik, TermsAndConditionsCheckOption termsAndConditionsCheckOption)

Wyświetla okno z prośbą o zaakceptowanie warunków korzystania z usługi Nawigacja. Jeśli podasz wartość, odbiornik zostanie wywołany w wątku interfejsu użytkownika i będzie wskazywać, czy użytkownik zaakceptuje warunki korzystania z usługi.

Pamiętaj, że okno dialogowe pojawi się nawet wtedy, gdy użytkownik wyraził wcześniej zgodę. Należy go wywoływać tylko wtedy, gdy areTermsAccepted(Application) ma wartość false, ponieważ nie można cofnąć akceptacji warunków korzystania z usługi.

Parametry
aktywność [plural: aktywności] Activity, na którym będzie wyświetlane okno
companyName nazwę firmy, która będzie wyświetlana w oknie Warunków korzystania z usługi.
title tytuł okna dialogowego. Jeśli ma wartość null, w oknie będzie widoczny tytuł domyślny.
uiParams parametry służące do dostosowania wyglądu i stylu okna dialogowego. Jeśli ma wartość null, używany jest domyślny wygląd i styl.
detektor opcjonalne wywołanie zwrotne, które zostanie wykonane, gdy użytkownik zaakceptuje lub odrzuci warunki korzystania z usługi
termsAndConditionsCheckOption TermsAndConditionsCheckOption, który określa opcje sprawdzania warunków korzystania z usługi

public static void showTermsAndConditionsDialog (Aktywność związana z aktywnością, ciąg znaków firmyName, detektor NavigationApi.OnTermsResponseListener)

Wyświetla okno, które zaleca użytkownikowi zaakceptowanie warunków korzystania z Nawigacji Google przy użyciu domyślnego tytułu oraz domyślnego wyglądu i stylu.

Parametry
aktywność [plural: aktywności]
companyName
detektor
Zobacz również