導覽 API

公開最終類別 NavigationApi 擴充物件

Navigation API 的進入點。使用此類別中的靜態方法取得 Navigator 的參照。

巢狀類別摘要

@interface NavigationApi.ErrorCode ErrorCode 是由 getNavigator(Activity, NavigatorListener) 和 getNavigator(Application, NavigatorListener) 傳回的狀態碼，用於成功取得 Navigator 時。
NavigationApi.NavigatorListener 使用 getNavigator(Activity, NavigatorListener) 註冊 NavigatorListener，即可收到所說 Navigator 的狀態通知。 
NavigationApi.OnTermsResponseListener 以 showTermsAndConditionsDialog(Activity, String, OnTermsResponseListener) 註冊 OnTermsResponseListener，即可在使用者接受或拒絕條款及細則時收到通知。

公用方法摘要

static 布林值
areTermsAccepted(申請書)
如果使用者先前已接受 Google 的 Navigation 條款及細則，就會傳回 true。
static void
cleanup()
清除 NavSDK 元件的內部狀態。
已同步 靜態 ForegroundServiceManager
getForegroundServiceManager(應用程式)
取得單例模式 ForegroundServiceManager 執行個體。
static 字串
getNavSDKVersion()
傳回目前的 NavSDK 版本。
static void
getNavigator(應用程式應用程式、NavigationApi.NavigatorListener 回呼)
取得 Navigator 執行個體。
static void
getNavigator(Activity activity、NavigationApi.NavigatorListener 回呼、TermsAndConditionsCheckOption termsCheck)
取得 Navigator 執行個體。
static void
getNavigator(活動活動、NavigationApi.NavigatorListener 回呼)
等同於 getNavigator(activity, callback, {@link TermsAndConditionsCheckOption#ENABLED}。
static void
getNavigatorNoToS(應用程式、NavigationApi.NavigatorListener 回呼)
取得 Navigator 執行個體。
static RoadSnappedLocationProvider
getRoadSnappedLocationProvider(應用程式)
取得 RoadSnappedLocationProvider 的例項，可用於訂閱路障使用者位置。
靜態 NavigationTransactionRecorder
getTransactionRecorder(應用程式)
取得 NavigationTransactionRecorder 的例項，可用於記錄與導航相關的交易。
Sync static void
initForegroundServiceManager(Application application, Integer notificationId, String defaultMessage, NotificationContentProvider 提供者)
使用提供的引數初始化 ForegroundServiceManager 例項。
static void
resetTermsAccepted(應用程式)
重設測試用的條款及細則。
static void
showTermsAndConditionsDialog(活動活動、字串公司名稱、字串標題、NavigationApi.OnTermsResponseListener 事件監聽器)
顯示對話方塊，引導使用者接受 Google 的導覽條款及細則，並使用預設外觀和風格。
static void
showTermsAndConditionsDialog(Activity activity, String companyName, String title, TermsAndConditionsUIParams uiParams、NavigationApi.OnTermsResponseListener 事件監聽器、TermsAndConditionsCheckOption termsAndConditionsCheckOption)
顯示對話方塊，引導使用者接受 Google 的導航條款及細則。
static void
showTermsAndConditionsDialog(活動活動、字串公司名稱、NavigationApi.OnTermsResponseListener 事件監聽器)
顯示對話方塊，引導使用者接受 Google 的導覽條款及細則，並使用預設標題及預設外觀和風格。

繼承方法摘要

公用方法

public static 布林值 areTermsAccepted (Application application)

如果使用者先前已接受 Google 的 Navigation 條款及細則，就會傳回 true。

您可以利用這個做法檢查是否應在應用程式中提早顯示字詞畫面，而非在使用者即將前往某處時顯示。舉例來說，您可以在應用程式顯示其他條款及細則時檢查這個值，讓使用者在單一工作中接受應用程式的所有必要條款及細則。

參數
調度應用程式資源 目前的應用程式
傳回
  • true 表示使用者已接受條款，false 則表示

public static void cleanup ()

清除 NavSDK 元件的內部狀態。如果目前有導航工具，導航功能就會停止並停用。日後無法再透過這個 Navigator 尋求指引。如果您的應用程式不再需要導覽器，且應用程式已刪除所有對導覽器的參照，請呼叫此方法來復原記憶體。如果在呼叫後您的應用程式需要導覽器，請使用 getNavigator() 建立新的導覽器。注意：建立新的導覽器需要時間，請考慮延遲對應用程式效能的影響，以及復原記憶體的優點。

公開靜態 已同步 ForegroundServiceManager getForegroundServiceManager (應用程式應用程式)

取得單例模式 ForegroundServiceManager 執行個體。如果在 getForegroundServiceManager(Application) 之前未呼叫 initForegroundServiceManager(Application, Integer, String, NotificationContentProvider)，系統會使用預設的通知 ID、訊息和通知供應程式。

參數
調度應用程式資源 目前的Application

public static 字串 getNavSDKVersion ()

傳回目前的 NavSDK 版本。

public static void getNavigator (應用程式應用程式、NavigationApi.NavigatorListener 回呼)

取得 Navigator 執行個體。

如果使用者尚未同意條款及細則，系統會立即觸發回呼，並顯示錯誤代碼 TERMS_NOT_ACCEPTED。

請注意，Navigator 為單例模式；若多次呼叫此方法，每次呼叫都會傳回同一個導覽器。

參數
調度應用程式資源 目前Application
回呼 系統會在 Navigator 準備就緒時觸發回呼，或是發生錯誤

public static void getNavigator (Activity activity、NavigationApi.NavigatorListener 回呼、TermsAndConditionsCheckOption termsCheck)

取得 Navigator 執行個體。

如果使用者尚未同意條款及細則，這項呼叫會顯示對話方塊，鼓勵使用者遵守當地法規。

如果 termsCheck 為 ENABLED，對話方塊也會包含 Navigation SDK 條款及細則的連結。如果使用者未接受這些條款，系統會呼叫 callback 並顯示 TERMS_NOT_ACCEPTED 錯誤。

請注意，Navigator 為單例模式；若多次呼叫此方法，每次呼叫都會傳回同一個導覽器。

參數
活動 Activity，用於顯示條款及細則對話方塊 (如果尚未接受)
回呼 回呼會在 Navigator 準備就緒，或發生錯誤時觸發的回呼
termsCheck 指出是否應略過《條款及細則》檢查

public static void getNavigator (活動活動、NavigationApi.NavigatorListener 回呼)

等同於 getNavigator(activity, callback, {@link TermsAndConditionsCheckOption#ENABLED}。

參數
活動
回呼
另請參閱

public static void getNavigatorNoToS (應用程式應用程式、NavigationApi.NavigatorListener 回呼)

取得 Navigator 執行個體。

略過條款及細則。

請注意，Navigator 為單例模式；若多次呼叫此方法，每次呼叫都會傳回同一個導覽器。

參數
調度應用程式資源 目前的Application。
回呼 可在 Navigator 準備就緒或發生錯誤時觸發的回呼。

public static RoadSnappedLocationProvider getRoadSnappedLocationProvider (應用程式應用程式)

取得 RoadSnappedLocationProvider 的例項，可用於訂閱路障使用者位置。請注意，如果訂閱道路啟動位置更新通知，在背景運作時，可能會導致電池耗電或不小心收集到使用者位置資料。

必須先成功取得 Navigator 才能呼叫這個方法，否則會傳回 null。

參數
調度應用程式資源 目前的Application

public static NavigationTransactionRecorder getTransactionRecorder (應用程式應用程式)

取得 NavigationTransactionRecorder 的例項，可用於記錄與導航相關的交易。

只有在 Google 是按交易收費時，才應使用這個類別。

必須先成功取得 Navigator 才能呼叫這個方法，否則會傳回 null。

參數
調度應用程式資源 目前的Application

public static sync void initForegroundServiceManager (Application application, Integer notificationId, String defaultMessage, NotificationContentProvider 提供者)

使用提供的引數初始化 ForegroundServiceManager 例項。

只有在需要修改任何預設參數時，才應呼叫這個方法。否則，請直接呼叫 getForegroundServiceManager(Application)。這個方法只能呼叫一次，且必須在 getForegroundServiceManager(Application) 之前呼叫。

參數
調度應用程式資源 目前Application
notificationId 持續性通知的通知 ID
defaultMessage 如未指定 provider，則顯示的預設訊息
供應商 NotificationContentProvider 的實作

public static void resetTermsAccepted (應用程式應用程式)

重設測試用的條款及細則。如要測試條款及細則對話方塊，請在呼叫 NavigationApi 之前新增呼叫。

參數
調度應用程式資源 目前的應用程式

public static void showTermsAndConditionsDialog (Activity activity, String companyName, String title, NavigationApi.OnTermsResponseListener 事件監聽器)

顯示對話方塊，引導使用者接受 Google 的導覽條款及細則，並使用預設外觀和風格。

參數
活動
companyName
title
事件監聽器
另請參閱

public static void showTermsAndConditionsDialog (Activity activity, String companyName, String title, TermsAndConditionsUIParams uiParams、NavigationApi.OnTermsResponseListener 事件監聽器、TermsAndConditionsCheckOption termsAndConditionsCheckOptionListener)

顯示對話方塊，引導使用者接受 Google 的導航條款及細則。如果指定這項設定，系統就會在 UI 執行緒上呼叫事件監聽器，指出使用者是否接受條款及細則。

請注意，即使使用者先前接受過對話方塊，系統仍會顯示對話方塊。只有在 areTermsAccepted(Application) 是 false 時才需要呼叫此方法，因為使用者無法不接受條款及細則。

參數
活動 顯示對話方塊的 Activity
companyName 貴公司名稱，會顯示在條款及細則對話方塊中
title 對話方塊的標題如果為空值，對話方塊會使用預設標題。
uiParams 用來自訂對話方塊外觀和風格的參數。如果為空值，則會使用預設的外觀和風格。
事件監聽器 在使用者接受或拒絕條款及細則時觸發的選用回呼
termsAndConditionsCheckOption TermsAndConditionsCheckOption，用來指定查看條款及細則的選項

public static void showTermsAndConditionsDialog (Activity activity, String companyName, NavigationApi.OnTermsResponseListener 事件監聽器)

顯示對話方塊，引導使用者接受 Google 的導覽條款及細則，並使用預設標題及預設外觀和風格。

參數
活動
companyName
事件監聽器
另請參閱