NavigationAPI

public final class NavigationApi extended Object

Navigation API へのエントリ ポイント。このクラスの静的メソッドを使用して、Navigator への参照を取得します。

ネストクラスの概要

@インターフェース NavigationApi.ErrorCode ErrorCode は、Navigator が正常に取得できなかった場合に getNavigator(Activity, NavigatorListener) と getNavigator(Application, NavigatorListener) によって返されるステータス コードです。
インターフェース NavigationApi.NavigatorListener getNavigator(Activity, NavigatorListener) で NavigatorListener を登録して、Navigator のステータスについて通知されるようにします。 
インターフェース NavigationApi.OnTermsResponseListener showTermsAndConditionsDialog(Activity, String, OnTermsResponseListener) で OnTermsResponseListener を登録し、ユーザーが利用規約に同意または拒否したときに通知されるようにします。

パブリック メソッドの概要

静的 ブール値
areTermsAccepted（申請申請）
ユーザーが以前に Google の Navigation の利用規約に同意したことがある場合は、true を返します。
static void
cleanup()
NavSDK コンポーネントの内部状態をクリーンアップ。
同期済み 静的 ForegroundServiceManager
getForegroundServiceManager（アプリ アプリ）
シングルトン ForegroundServiceManager インスタンスを取得します。
static 文字列
getNavSDKVersion()
NavSDK の現在のバージョンを返します。
static void
getNavigator（アプリケーション アプリ、NavigationApi.NavigatorListener コールバック）
Navigator インスタンスを取得します。
static void
getNavigator（アクティビティ アクティビティ、NavigationApi.NavigatorListener コールバック、TermsAndConditionsCheckOption termsCheck）
Navigator インスタンスを取得します。
static void
getNavigator（アクティビティ アクティビティ、NavigationApi.NavigatorListener コールバック）
getNavigator(activity, callback, {@link TermsAndConditionsCheckOption#ENABLED} と同じです。
static void
getNavigatorNoToS（アプリケーション アプリ、NavigationApi.NavigatorListener コールバック）
Navigator インスタンスを取得します。
静的 RoadSnappedLocationProvider
getRoadSnappedLocationProvider（アプリ アプリケーション）
RoadSnappedLocationProvider のインスタンスを取得します。これは、道路スナップ地点のユーザー位置情報に登録するために使用できます。
静的 NavigationTransactionRecorder
getTransactionRecorder（アプリ アプリケーション）
NavigationTransactionRecorder のインスタンスを取得します。これは、ナビゲーションに関連するトランザクションを記録するために使用できます。
同期済み static void
initForegroundServiceManager（アプリケーション アプリ、Integer notificationId、String defaultMessage、NotificationContentProvider プロバイダ）
指定された引数で ForegroundServiceManager インスタンスを初期化します。
static void
resetTermsAccepted（アプリケーション アプリケーション）
利用規約をリセット - テスト用
static void
showTermsAndConditionsDialog（アクティビティ アクティビティ、String companyName、String title、NavigationApi.OnTermsResponseListener リスナー）
デフォルトのデザインを使用して、Google のナビゲーションの利用規約に同意するようユーザーに促すダイアログを表示します。
static void
showTermsAndConditionsDialog（アクティビティ アクティビティ、String companyName、String title、TermsAndConditionsUIParams uiParams、NavigationApi.OnTermsResponseListener リスナー、TermsAndConditionsCheckOption termsAndConditionsCheckOption）
Google のナビの利用規約に同意するようユーザーに促すダイアログを表示します。
static void
showTermsAndConditionsDialog（アクティビティ アクティビティ、String companyName、NavigationApi.OnTermsResponseListener リスナー）
デフォルトのタイトルとデフォルトのデザインを使用して、Google の Navigation の利用規約に同意するようユーザーに促すダイアログを表示します。

継承されたメソッドの概要

パブリック メソッド

public static boolean areTermsAccepted （アプリケーション アプリケーション）

ユーザーが以前に Google の Navigation の利用規約に同意している場合は、true を返します。

これを使用して、ユーザーがどこに移動しようとしているときではなく、アプリの早い段階で用語画面を表示する必要があるかどうかを確認できます。たとえば、アプリに他の利用規約を表示しているときに、この値を確認すると、ユーザーが 1 つのタスクでアプリに必要なすべての利用規約に同意できる場合があります。

パラメータ
アプリケーション 現在のアプリケーション
戻り値
  • ユーザーが利用規約に同意した場合は true、それ以外の場合は false

public static void cleanup ()

NavSDK コンポーネントの内部状態をクリーンアップ。現在のナビゲータが存在する場合、ガイダンスは停止され、無効になります。今後、このナビゲーターからガイダンスを求めることはできません。アプリが Navigator を必要としなくなり、アプリが Navigator への参照をすべて破棄したときに、このメソッドを呼び出してメモリを復元します。この呼び出しの後にアプリで Navigator が必要な場合は、getNavigator() を使用して新しい Navigator を作成します。注: 新しい Navigator の作成には時間がかかります。遅延がアプリのパフォーマンスに及ぼす影響と、回復するメモリのメリットを比較して考慮すること。

public static sync ForegroundServiceManager getForegroundServiceManager （アプリケーション アプリケーション）

シングルトン ForegroundServiceManager インスタンスを取得します。getForegroundServiceManager(Application) の前に initForegroundServiceManager(Application, Integer, String, NotificationContentProvider) が呼び出されなかった場合は、デフォルトの通知 ID、メッセージ、通知プロバイダが使用されます。

パラメータ
アプリケーション 現在の Application

public static String getNavSDKVersion ()

NavSDK の現在のバージョンを返します。

public static void getNavigator （アプリケーション アプリケーション、NavigationApi.NavigatorListener コールバック）

Navigator インスタンスを取得します。

ユーザーが利用規約に同意していない場合は、エラーコード TERMS_NOT_ACCEPTED とともにコールバックが直ちに呼び出されます。

Navigator はシングルトンであることに注意してください。このメソッドを複数回呼び出すと、どの呼び出しでも同じ Navigator が返されます。

パラメータ
アプリケーション 現在のApplication
callback Navigator の準備が整うか、エラーが発生したときに呼び出されるコールバック

public static void getNavigator （アクティビティ アクティビティ、NavigationApi.NavigatorListener コールバック、TermsAndConditionsCheckOption termsCheck）

Navigator インスタンスを取得します。

ユーザーがまだ利用規約に同意していない場合は、この呼び出しで現地の規制の遵守をユーザーに促すダイアログが表示されます。

termsCheck が ENABLED の場合、ダイアログに Navigation SDK の利用規約へのリンクも表示されます。ユーザーが利用規約に同意しなかった場合、callback は TERMS_NOT_ACCEPTED エラーで呼び出されます。

Navigator はシングルトンであることに注意してください。このメソッドを複数回呼び出すと、どの呼び出しでも同じ Navigator が返されます。

パラメータ
アクティビティ 利用規約のダイアログを表示する Activity（まだ同意していない場合）
callback Navigator の準備が整うか、エラーが発生したときに呼び出されるコールバック。
termsCheck 利用規約のチェックをスキップするかどうかを指定する

public static void getNavigator （アクティビティ アクティビティ、NavigationApi.NavigatorListener コールバック）

getNavigator(activity, callback, {@link TermsAndConditionsCheckOption#ENABLED} と同じです。

パラメータ
アクティビティ
callback
関連項目

public static void getNavigatorNoToS （アプリケーション アプリ、NavigationApi.NavigatorListener コールバック）

Navigator インスタンスを取得します。

利用規約を回避します。

Navigator はシングルトンであることに注意してください。このメソッドを複数回呼び出すと、どの呼び出しでも同じ Navigator が返されます。

パラメータ
アプリケーション 現在の Application。
callback Navigator の準備が整うか、エラーが発生したときに呼び出されるコールバック。

public static RoadSnappedLocationProvider getRoadSnappedLocationProvider （アプリケーション アプリケーション）

RoadSnappedLocationProvider のインスタンスを取得します。これは、道路スナップ地点のユーザー位置情報に登録するために使用できます。道路限定の位置情報の更新データに登録すると、バックグラウンドで実行したままにしておくと、バッテリーの消耗が早くなったり、ユーザーの位置情報が意図せず収集されたりすることがあります。

このメソッドを呼び出す前に Navigator を正常に取得する必要があります。取得しなかった場合、null が返されます。

パラメータ
アプリケーション 現在の Application

public static NavigationTransactionRecorder getTransactionRecorder （アプリケーション アプリケーション）

NavigationTransactionRecorder のインスタンスを取得します。これは、ナビゲーションに関連するトランザクションを記録するために使用できます。

このクラスは、Google からトランザクションごとに請求される場合にのみ使用してください。

このメソッドを呼び出す前に Navigator を正常に取得する必要があります。取得しなかった場合、null が返されます。

パラメータ
アプリケーション 現在の Application

public static sync void initForegroundServiceManager （アプリケーション アプリ、Integer notificationId、String defaultMessage、NotificationContentProvider プロバイダ）

指定された引数で ForegroundServiceManager インスタンスを初期化します。

これは、デフォルト パラメータを変更する場合にのみ呼び出す必要があります。それ以外の場合は、getForegroundServiceManager(Application) を直接呼び出します。このメソッドは 1 回だけ呼び出せます。getForegroundServiceManager(Application) の前に呼び出す必要があります。

パラメータ
アプリケーション 現在のApplication
notificationId 永続的な通知の通知 ID
defaultMessage provider が指定されていない場合に表示されるデフォルトのメッセージ
provider NotificationContentProvider の実装

public static void resetTermsAccepted （アプリケーション アプリケーション）

利用規約をリセット - テスト用利用規約ダイアログをテストする場合は、NavigationApi の呼び出しの前にこのメソッドの呼び出しを追加します。

パラメータ
アプリケーション 現在のアプリケーション

public static void showTermsAndConditionsDialog （アクティビティ アクティビティ、String companyName、String title、NavigationApi.OnTermsResponseListener リスナー）

デフォルトのデザインを使用して、Google のナビゲーションの利用規約に同意するようユーザーに促すダイアログを表示します。

パラメータ
アクティビティ
companyName
title
リスナー
関連項目

public static void showTermsAndConditionsDialog (Activity activity, String companyName, String title, TermsAndConditionsUIParams uiParams、NavigationApi.OnTermsResponseListener リスナー、TermsAndConditionsCheckOption termsAndConditionsCheckOption)

Google のナビの利用規約に同意するようユーザーに促すダイアログを表示します。指定すると、リスナーが UI スレッドで呼び出され、ユーザーが利用規約に同意したかどうかを示します。

なお、ユーザーが以前に同意した場合も、このダイアログが表示されます。このメソッドは、areTermsAccepted(Application) が false の場合にのみ呼び出します。ユーザーが利用規約への同意を取り消すことはできないためです。

パラメータ
アクティビティ ダイアログが表示される Activity
companyName 会社名（利用規約ダイアログに表示されます）
title ダイアログのタイトルnull の場合、ダイアログではデフォルトのタイトルが使用されます。
uiParams ダイアログの外観をカスタマイズするために使用するパラメータ。null の場合、デフォルトのデザインが使用されます。
リスナー ユーザーが利用規約に同意または拒否したときに呼び出されるオプションのコールバック。
termsAndConditionsCheckOption 利用規約を確認するためのオプションを指定する TermsAndConditionsCheckOption

public static void showTermsAndConditionsDialog (Activity activity, String companyName, NavigationApi.OnTermsResponseListener リスナー)

デフォルトのタイトルとデフォルトのデザインを使用して、Google の Navigation の利用規約に同意するようユーザーに促すダイアログを表示します。

パラメータ
アクティビティ
companyName
リスナー
関連項目