FleetEngine

パブリック クラス FleetEngine extensions オブジェクト

Google の Fleet Engine のクライアント。

このクラスを使用すると、enable と disableLocationTracking() の呼び出し元が位置情報のトラッキングを無効にできます。更新の頻度は setLocationReportingInterval(long, TimeUnit) で制御できます。

このクラスはスレッドセーフではありません。

ネストクラスの概要

インターフェース	FleetEngine.AuthTokenFactory		このインターフェースのインスタンスは、さまざまなオペレーションの実行時に認証トークンを提供するよう求められます。
クラス	FleetEngine.ErrorListener		Fleet Engine クライアントは、このインターフェースのインスタンスを使用して、重要な例外が発生したときにデベロッパーに通知します。
インターフェース	FleetEngine.FleetEngineConfig		このインターフェースは非推奨になりました。レガシーフック
インターフェース	FleetEngine.StatusListener		ステータス更新のリスナー。
enum	FleetEngine.VehicleState		車両が新しいルートを受け入れているかどうかを示します。

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

static void	clearInstance() ClearInstance は、位置情報の追跡を停止し、内部状態をクリアして、FleetEngine シングルトンを null にリセットします。
static void	createInstance（アプリケーション アプリケーション、文字列プロバイダ ID、文字列車両 ID、FleetEngine.AuthTokenFactory authTokenFactory、FleetEngine.ErrorListener errorListener） Google Fleet Engine サービスへのアクセスに使用できる FleetEngine シングルトンを作成します。
static void	createInstance（アプリケーション アプリケーション、文字列プロバイダ ID、文字列車両 ID、FleetEngine.AuthTokenFactory authTokenFactory、FleetEngine.StatusListener statusListener、FleetEngine.ErrorListener errorListener） Google Fleet Engine サービスへのアクセスに使用できる FleetEngine シングルトンを作成します。
void	disableLocationTracking() 位置情報の記録を停止します。
void	enableLocationTracking() Fleet Engine バックエンドへのポジション レポートのアップロードを開始します。
static FleetEngine	getInstance() FleetEngine シングルトンを返します。
長さ	getLocationReportingIntervalMs() 現在地の送信間隔をミリ秒単位で返します。
ブール値	isLocationTrackingEnabled() 位置追跡が有効かどうかを返します。
static void	setFleetEngineConfig（FleetEngine.FleetEngineConfig 構成）
void	setLocationReportingInterval（長い間隔、TimeUnit intervalUnits） ロケーション レポートを Fleet Engine バックエンドに配信する最小間隔を設定します。
static void	setNavigator（Navigator navigator）
void	setVehicleState（FleetEngine.VehicleState の状態） VehicleState を設定します。

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

クラス java.lang.Object から

ブール値	equals（オブジェクト arg0）
final Class<?>	getClass()
整数	hashCode()
final void	notify()
final void	notifyAll()
文字列	toString()
final void	wait（long arg0, int arg1）
final void	wait（long arg0）
final void	wait()

パブリック メソッド

public static void clearInstance ()

ClearInstance は、位置情報の追跡を停止し、内部状態をクリアして、FleetEngine シングルトンを null にリセットします。

public static void createInstance （アプリケーション アプリケーション、文字列プロバイダ ID、文字列車両 ID、FleetEngine.AuthTokenFactory authTokenFactory、FleetEngine.ErrorListener errorListener）

Google Fleet Engine サービスへのアクセスに使用できる FleetEngine シングルトンを作成します。内部的には、このメソッドは getRoadSnappedLocationProvider(Application) を使用して RoadSnappedLocationProvider を取得するため、このメソッドを呼び出す前に Navigator を正常に取得する必要があります。取得していない場合、IllegalStateException になります。createInstance() を 2 回呼び出すと、IllegalStateException が発生します。

パラメータ

アプリケーション	現在の Application。null にすることはできません
providerId	プロバイダの ID
vehicleId	Fleet Engine に接続される車両の ID
authTokenFactory	Fleet Engine の認証トークンを提供する factory
errorListener	Fleet Engine クライアント エラーが発生したときに通知される listener

例外

IllegalStateException	AndroidManifest.xml でプロバイダ ID が指定されていない場合

public static void createInstance （アプリケーション アプリケーション、文字列プロバイダ ID、文字列車両 ID、FleetEngine.AuthTokenFactory authTokenFactory、FleetEngine.StatusListener statusListener、FleetEngine.ErrorListener errorListener）

Google Fleet Engine サービスへのアクセスに使用できる FleetEngine シングルトンを作成します。内部的には、このメソッドは getRoadSnappedLocationProvider(Application) を使用して RoadSnappedLocationProvider を取得するため、このメソッドを呼び出す前に Navigator を正常に取得する必要があります。取得していない場合、IllegalStateException になります。createInstance() を 2 回呼び出すと、IllegalStateException が発生します。

パラメータ

アプリケーション	現在の Application。null であってはなりません。
providerId	プロバイダの ID。
vehicleId	Fleet Engine に接続される車両の ID
authTokenFactory	Fleet Engine の認証トークンを提供する factory。
statusListener	ステータス更新用のリスナー。
errorListener	Fleet Engine クライアント エラーが発生したときに通知される listener。

例外

IllegalStateException	AndroidManifest.xml でプロバイダ ID が指定されていない場合。

public void disableLocationTracking ()

位置情報の記録を停止します。すでに進行中のレポートを停止しようとしませんが、新しい現在地レポートは生成、送信されません。

停止後にもう一度 enableLocationTracking() を呼び出すと、トラッキングを再開できます。

例外

IllegalStateException	位置追跡がすでに停止している場合

public void enableLocationTracking ()

Fleet Engine バックエンドへのポジション レポートのアップロードを開始します。レポートは定期的に作成されます（デフォルトでは 5 秒ごと）。ネットワーク接続の損失などの一時的な問題によってレポートが配信されない場合は、レポートの頻度が低くなる可能性があります。

位置情報レポートはバックグラウンド スレッドで作成され、この呼び出しはすぐに返されます。

位置情報の追跡を無効にするには、disableLocationTracking() を呼び出します。

レポート間隔は [setLocationReportingInterval(long, TimeUnit)] で変更できます。

例外

IllegalStateException	位置追跡がすでに有効になっている場合

public static FleetEngine getInstance ()

FleetEngine シングルトンを返します。getInstance() の前に createInstance() を呼び出す必要があります。それ以外の場合は null が返されます。

public long getLocationReportingIntervalMs ()

現在地の送信間隔をミリ秒単位で返します。

public boolean isLocationTrackingEnabled ()

位置追跡が有効かどうかを返します。

public static void setFleetEngineConfig （FleetEngine.FleetEngineConfig 構成）

パラメータ

config

public void setLocationReportingInterval (long interval, TimeUnit intervalUnits)

ロケーション レポートを Fleet Engine バックエンドに配信する最小間隔を設定します。デフォルトのレポート間隔は 10 秒です。サポートされる最小更新間隔は 5 秒です。頻繁に更新すると、リクエストやエラーが遅くなる可能性があります。

パラメータ

interval
intervalUnits

public static void setNavigator （Navigator navigator）

パラメータ

ナビゲーター

public void setVehicleState （FleetEngine.VehicleState 状態）

VehicleState を設定します。ビジネス情報の更新が有効になっている場合、値は次のビジネス情報の更新時に伝播されます。位置情報の更新が無効になっている場合、更新は直ちに実行されます。

VehicleState の更新はバックグラウンド スレッドで行われ、この呼び出しはすぐに返されます。

パラメータ

state

例外

IllegalStateException	位置追跡がまだ有効になっていない場合に VehicleState が Online に設定されている場合。