Um cliente para o Fleet Engine do Google.
Essa classe permite que o autor da chamada enable
e disableLocationTracking()
desative o rastreamento de localização. A frequência das atualizações pode ser controlada
com setLocationReportingInterval(long, TimeUnit)
.
Esta classe não é thread-safe.
Resumo de classes aninhadas
Interface | FleetEngine.AuthTokenFactory | As instâncias desta interface precisarão fornecer um token de autorização quando várias operações forem realizadas. | |
classe | FleetEngine.ErrorListener | O cliente do Fleet Engine vai usar instâncias dessa interface para informar o desenvolvedor quando exceções importantes ocorrerem. | |
Interface | FleetEngine.FleetEngineConfig | Essa interface foi descontinuada. hook legado | |
Interface | FleetEngine.StatusListener | Listener de atualizações de status. | |
enum | FleetEngine.VehicleState | Indica se um veículo está aceitando novas viagens. |
Resumo do método público
estático void |
clearInstance()
clearInstance interrompe o rastreamento de localização, limpa o estado interno e redefine o singleton FleetEngine como nulo.
|
estático void |
createInstance(aplicativo do aplicativo, String providerId, String veículosId, FleetEngine.AuthTokenFactory authTokenFactory, FleetEngine.ErrorListener errorListener)
Cria o singleton
FleetEngine , que pode ser usado para acessar o serviço do Google Fleet Engine. |
estático void |
createInstance(aplicativo do aplicativo, String providerId, String veículosId, FleetEngine.AuthTokenFactory authTokenFactory, FleetEngine.StatusListener statusListener, FleetEngine.ErrorListener errorListener)
Cria o singleton
FleetEngine , que pode ser usado para acessar o serviço do Google Fleet Engine. |
void |
disableLocationTracking()
Interrompe o rastreamento de localização.
|
void |
enableLocationTracking()
Começar a fazer upload dos relatórios de posição para o back-end do Fleet Engine.
|
estático FleetEngine |
getInstance()
Retorna o Singleton do FleetEngine.
|
long |
getLocationReportingIntervalMs()
Retorna o intervalo do relatório de localização atual, em milissegundos.
|
boolean |
isLocationTrackingEnabled()
Informa se o rastreamento de localização está ativado.
|
estático void |
setFleetEngineConfig(configuração FleetEngine.FleetEngineConfig)
|
void |
setLocationReportingInterval(intervalo longo, TimeUnit intervalUnits)
Define o intervalo mínimo em que os relatórios de localização serão entregues ao back-end do
Fleet Engine.
|
estático void | |
void |
Resumo do método herdado
Métodos públicos
public estático void clearInstance ()
clearInstance interrompe o rastreamento de localização, limpa o estado interno e redefine o singleton FleetEngine como nulo.
public estático void createInstance (aplicativo de aplicativo, ID de provedor de string, string de veículo, FleetEngine.AuthTokenFactory authTokenFactory, FleetEngine.ErrorListener errorListener)
Cria o singleton FleetEngine
, que pode ser usado para acessar o serviço do Google Fleet Engine. Internamente, esse método recebe um RoadSnappedLocationProvider
usando getRoadSnappedLocationProvider(Application)
. Portanto, um Navigator
precisa ser recebido antes de chamar esse método. Caso contrário, ele resulta em uma IllegalStateException
. Chamar createInstance() duas vezes resultará em uma IllegalStateException
.
Parâmetros
aplicativo | o Application atual, não pode ser null |
---|---|
providerId | o ID do fornecedor |
vehicleId | o ID do veículo que será conectado ao motor da frota |
authTokenFactory | o factory que fornece tokens de autorização
do Fleet Engine |
errorListener | o listener que será notificado quando ocorrerem erros de cliente do Fleet Engine |
Gera
IllegalStateException | se o ID do provedor não for especificado no AndroidManifest.xml
|
---|
public estático void createInstance (Aplicativo de aplicativo, String providerId, String veículosId, FleetEngine.AuthTokenFactory authTokenFactory, FleetEngine.StatusListener statusListener, FleetEngine.ErrorListener errorListener)
Cria o singleton FleetEngine
, que pode ser usado para acessar o serviço do Google Fleet Engine. Internamente, esse método recebe um RoadSnappedLocationProvider
usando getRoadSnappedLocationProvider(Application)
. Portanto, um Navigator
precisa ser recebido antes de chamar esse método. Caso contrário, ele resulta em uma IllegalStateException
. Chamar createInstance() duas vezes resultará em uma IllegalStateException
.
Parâmetros
aplicativo | o Application atual, não pode ser null . |
---|---|
providerId | o ID do fornecedor. |
vehicleId | o ID do veículo que será conectado ao motor da frota |
authTokenFactory | o factory que fornece tokens de autorização
do Fleet Engine. |
statusListener | listener para atualizações de status. |
errorListener | o listener que será notificado quando ocorrerem erros de cliente do Fleet Engine. |
Gera
IllegalStateException | se o ID do provedor não for especificado no AndroidManifest.xml .
|
---|
public void disableLocationTracking ()
Interrompe o rastreamento de localização. Não é feita nenhuma tentativa de interromper um relatório que já está em andamento, mas nenhum novo relatório de posição será gerado ou transmitido.
O rastreamento pode ser retomado após a interrupção chamando enableLocationTracking()
novamente.
Gera
IllegalStateException | se o rastreamento de localização já tiver sido interrompido |
---|
public void enableLocationTracking ()
Começar a fazer upload dos relatórios de posição para o back-end do Fleet Engine. Os relatórios são feitos periodicamente, por padrão a cada cinco segundos. Os relatórios podem ser feitos com menos frequência se problemas temporários, como perda de conectividade de rede, impedirem a entrega.
Os relatórios de posição são feitos em uma linha de execução em segundo plano e essa chamada é retornada imediatamente.
O rastreamento de localização pode ser desativado chamando disableLocationTracking()
.
O intervalo do relatório pode ser alterado com setLocationReportingInterval(long, TimeUnit)
.
Gera
IllegalStateException | se o rastreamento de localização já estiver ativado |
---|
public estático FleetEngine getInstance ()
Retorna o singleton do FleetEngine. createInstance() precisa ser chamado antes de getInstance(). Caso contrário, o valor nulo será retornado.
public long getLocationReportingIntervalMs ()
Retorna o intervalo do relatório de localização atual, em milissegundos.
public boolean isLocationTrackingEnabled ()
Informa se o rastreamento de localização está ativado.
public estático void setFleetEngineConfig (configuração de FleetEngine.FleetEngineConfig)
Parâmetros
config |
---|
public void setLocationReportingInterval (longo intervalo, TimeUnit intervalUnits)
Define o intervalo mínimo em que os relatórios de localização serão entregues ao back-end do Fleet Engine. O intervalo padrão do relatório é de 10 segundos. O intervalo mínimo de atualização permitido é de cinco segundos. Atualizações mais frequentes podem resultar em solicitações e erros mais lentos.
Parâmetros
interval | |
---|---|
intervalUnits |
public void setVehicleState (estado FleetEngine.VehicleState)
Define o VehicleState. Se as atualizações de localização estiverem ativadas, o valor será propagado na próxima atualização de local. Se as atualizações de localização estiverem desativadas, a atualização será disparada imediatamente.
A atualização de VehicleState é feita em uma linha de execução em segundo plano. Essa chamada é retornada imediatamente.
Parâmetros
state |
---|
Gera
IllegalStateException | se VehicleState estiver definido como ON-LINE quando o rastreamento de localização ainda não estiver ativado. |
---|