Un client pour Fleet Engine de Google.
Cette classe permet à l'appelant de enable
et disableLocationTracking()
de désactiver le suivi de la position. La fréquence des mises à jour peut être contrôlée avec setLocationReportingInterval(long, TimeUnit)
.
Cette classe n'est pas thread-safe.
Récapitulatif des classes imbriquées
interface | FleetEngine.AuthTokenFactory | Les instances de cette interface sont invitées à fournir un jeton d'autorisation lorsque diverses opérations sont effectuées. | |
classe | FleetEngine.ErrorListener | Le client Fleet Engine utilisera les instances de cette interface pour informer le développeur lorsque des exceptions importantes se produisent. | |
interface | FleetEngine.FleetEngineConfig | Cette interface est obsolète. ancien hook | |
interface | FleetEngine.StatusListener | Écoutez les mises à jour de l'état. | |
enum | FleetEngine.VehicleState | Indique si un véhicule accepte de nouveaux trajets. |
Récapitulatif des méthodes publiques
statique vide |
clearInstance()
clearInstance arrête le suivi de la position, efface l'état interne et réinitialise le singleton FleetEngine à la valeur null.
|
statique vide |
createInstance(Application application, String providerId, String vehicleId, FleetEngine.AuthTokenFactory authTokenFactory, FleetEngine.ErrorListener errorListener)
Crée le singleton
FleetEngine , qui peut être utilisé pour accéder au service Google Fleet Engine. |
statique vide |
createInstance(Application application, String providerId, String customerId, FleetEngine.AuthTokenFactory authTokenFactory, FleetEngine.StatusListener statusListener, FleetEngine.ErrorListener errorListener)
Crée le singleton
FleetEngine , qui peut être utilisé pour accéder au service Google Fleet Engine. |
void |
disableLocationTracking()
Arrête le suivi de la position.
|
void |
enableLocationTracking()
Commencez à importer des rapports sur la position dans le backend Fleet Engine.
|
statique FleetEngine |
getInstance()
Renvoie le singleton FleetEngine.
|
long |
getLocationReportingIntervalMs()
Renvoie l'intervalle actuel de mise à jour de la position (en millisecondes).
|
boolean |
isLocationTrackingEnabled()
Indique si le suivi de la position est activé.
|
statique vide |
setFleetEngineConfig(configuration de FleetEngine.FleetEngineConfig)
|
void |
setLocationReportingInterval(intervalle long, intervalle_unité_de_temps)
Définit l'intervalle minimal d'envoi des rapports sur les zones géographiques au backend Fleet Engine.
|
statique vide |
setNavigator(navigateur Navigator)
|
void |
Récapitulatif des méthodes héritées
Méthodes publiques
public static vide clearInstance ()
clearInstance arrête le suivi de la position, efface l'état interne et réinitialise le singleton FleetEngine à la valeur null.
public statique vide createInstance (Application application, String providerId, StringvehicleId, FleetEngine.AuthTokenFactory authTokenFactory, FleetEngine.ErrorListener errorListener)
Crée le singleton FleetEngine
, qui peut être utilisé pour accéder au service Google Fleet Engine. En interne, cette méthode obtient un RoadSnappedLocationProvider
à l'aide de getRoadSnappedLocationProvider(Application)
. Par conséquent, un Navigator
doit être obtenu avant d'appeler cette méthode, sinon une exception IllegalStateException
sera générée. Le fait d'appeler createInstance() deux fois génère une erreur IllegalStateException
.
Paramètres
sur des règles | Application actuel, ne doit pas être null |
---|---|
providerId | ID du fournisseur |
vehicleId | Identifiant du véhicule qui sera connecté à Fleet Engine |
authTokenFactory | Le factory qui fournit les jetons d'autorisation Fleet Engine |
errorListener | Le listener qui sera averti en cas d'erreurs du client Fleet Engine |
Génère
IllegalStateException | si l'ID du fournisseur n'est pas spécifié dans AndroidManifest.xml
|
---|
public statique void createInstance (Application application, String providerId, StringvehicleId, FleetEngine.AuthTokenFactory authTokenFactory, FleetEngine.StatusListener statusListener, FleetEngine.ErrorListener errorListener)
Crée le singleton FleetEngine
, qui peut être utilisé pour accéder au service Google Fleet Engine. En interne, cette méthode obtient un RoadSnappedLocationProvider
à l'aide de getRoadSnappedLocationProvider(Application)
. Par conséquent, un Navigator
doit être obtenu avant d'appeler cette méthode, sinon une exception IllegalStateException
sera générée. Le fait d'appeler createInstance() deux fois génère une erreur IllegalStateException
.
Paramètres
sur des règles | Application actuel, ne doit pas être null . |
---|---|
providerId | l'identifiant du fournisseur. |
vehicleId | Identifiant du véhicule qui sera connecté à Fleet Engine |
authTokenFactory | le factory qui fournit les jetons d'autorisation Fleet Engine. |
statusListener | un écouteur pour les mises à jour de statut. |
errorListener | Le listener qui sera notifié lorsque des erreurs du client Fleet Engine se produisent. |
Génère
IllegalStateException | si l'ID du fournisseur n'est pas spécifié dans AndroidManifest.xml
|
---|
public vide disableLocationTracking ()
Arrête le suivi de la position. Aucune tentative n'est effectuée pour arrêter un rapport déjà en cours, mais aucun nouveau rapport de position ne sera généré ni transmis.
Pour reprendre le suivi après l'arrêt, appelez de nouveau enableLocationTracking()
.
Génère
IllegalStateException | si le suivi de la position a déjà été arrêté |
---|
public vide enableLocationTracking ()
Commencez à importer des rapports sur la position dans le backend Fleet Engine. Par défaut, des rapports sont générés à intervalles réguliers, toutes les cinq secondes. Les rapports peuvent être générés moins fréquemment si des problèmes temporaires, tels qu'une perte de connectivité réseau, empêchent leur diffusion.
Les rapports sur les positions sont générés dans un thread en arrière-plan. Cet appel est renvoyé immédiatement.
Vous pouvez désactiver le suivi de la position en appelant disableLocationTracking()
.
Vous pouvez modifier l'intervalle de reporting à l'aide de setLocationReportingInterval(long, TimeUnit)
.
Génère
IllegalStateException | si le suivi de la position était déjà activé |
---|
public static FleetEngine getInstance ()
Renvoie le singleton FleetEngine. createInstance() doit être appelé avant getInstance(). Sinon, la valeur nulle est renvoyée.
public long getLocationReportingIntervalMs ()
Renvoie l'intervalle actuel de mise à jour de la position (en millisecondes).
public booléen isLocationTrackingEnabled ()
Indique si le suivi de la position est activé.
public statique vide setFleetEngineConfig (configuration FleetEngine.FleetEngineConfig)
Paramètres
config |
---|
public void setLocationReportingInterval (intervalle long, intervalle entre les unités de temps)
Définit l'intervalle minimal d'envoi des rapports sur les zones géographiques au backend Fleet Engine. L'intervalle de reporting par défaut est de 10 secondes. L'intervalle minimal de mise à jour accepté est de cinq secondes. Des mises à jour plus fréquentes peuvent ralentir les requêtes et les erreurs.
Paramètres
interval | |
---|---|
intervalUnits |
public vide setVehicleState (FleetEngine.VehicleState state)
Définit l'élément VehicleState. Si les mises à jour de la position sont activées, la valeur sera propagée lors de la prochaine mise à jour de l'établissement. Si les mises à jour de la position sont désactivées, la mise à jour est déclenchée immédiatement.
La mise à jour de VehicleState est effectuée dans un thread en arrière-plan. Cet appel est renvoyé immédiatement.
Paramètres
state |
---|
Génère
IllegalStateException | si VehicleState est défini sur Online (En ligne) lorsque le suivi de la position n'est pas encore activé. |
---|