Classe FleetEngineDeliveryVehicleLocationProvider
Classe
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider
Provedor de localização do veículo de entrega.
Essa classe estende
LocationProvider
.
Requer o parâmetro de URL &libraries=journeySharing
. Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
---|---|
FleetEngineDeliveryVehicleLocationProvider |
FleetEngineDeliveryVehicleLocationProvider(options) Parâmetros:
Cria um novo provedor de localização para um veículo de entrega do Fleet Engine. |
Propriedades | |
---|---|
deliveryVehicleId |
Tipo:
string ID do veículo que esse provedor de localização observa. Defina este campo para rastrear um veículo. |
shouldShowOutcomeLocations |
Tipo:
boolean optional Permitir que os usuários exibam o local do resultado da tarefa. |
shouldShowTasks |
Tipo:
boolean optional Permitir que os usuários exibam tarefas buscadas. |
staleLocationThresholdMillis |
Tipo:
number Este campo é somente leitura. Limite para localização de veículo desatualizado. Se o último local atualizado do veículo for mais antigo que esse limite, ele não será exibido. |
taskFilterOptions |
Retorna as opções de filtro a serem aplicadas ao buscar tarefas. |
Métodos | |
---|---|
Herdadas:
addListener
|
Eventos | |
---|---|
error |
function(event) Argumentos:
Evento acionado quando o provedor de localização encontra um erro. |
update |
function(event) Argumentos:
Evento acionado quando uma solicitação de atualização de dados do Fleet Engine é concluída. |
interface FleetEngineDeliveryVehicleLocationProviderOptions.
Interface google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderOptions
Opções do provedor de localização do veículo de entrega.
Requer o parâmetro de URL &libraries=journeySharing
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
authTokenFetcher |
Tipo:
AuthTokenFetcher Fornece JSON Web Tokens para autenticar o cliente na Fleet Engine. |
projectId |
Tipo:
string O ID do projeto do consumidor no Console do Google Cloud. |
deliveryVehicleId optional |
Tipo:
string optional O ID do veículo de entrega a ser rastreado imediatamente após o provedor de local ser instanciado. Se não for especificado, o provedor de local não começará a monitorar nenhum veículo. Use FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId para definir o ID e começar a rastrear. |
pollingIntervalMillis optional |
Tipo:
number optional Tempo mínimo entre buscar atualizações de localização em milissegundos. Se demorar mais de pollingIntervalMillis para buscar uma atualização de local, a próxima atualização de local não será iniciada até que a atual seja concluída. Definir esse valor como 0 desativa as atualizações recorrentes de localização. Uma nova atualização de localização será buscada se um dos parâmetros observados pelo provedor de localização mudar. O intervalo padrão de pesquisa é de 5.000 milissegundos, o intervalo mínimo. Se você definir o intervalo de pesquisa para um valor diferente de zero, o valor 5.000 será usado. |
shouldShowOutcomeLocations optional |
Tipo:
boolean optional Booleano para mostrar ou ocultar locais de resultados para as tarefas buscadas. |
shouldShowTasks optional |
Tipo:
boolean optional Booleano para mostrar ou ocultar tarefas. Definir como "false" vai impedir que o endpoint "ListTasks" seja chamado para buscar as tarefas. Somente as próximas paradas do veículo serão exibidas. |
staleLocationThresholdMillis optional |
Tipo:
number optional Limite para localização de veículo desatualizado. Se o último local atualizado do veículo for mais antigo que esse limite, ele não será exibido. O padrão é 24 horas em milissegundos. Se o limite for menor que 0 ou Infinity, ele será ignorado e o local do veículo não será considerado desatualizado. |
taskFilterOptions optional |
Tipo:
FleetEngineTaskFilterOptions optional Opções de filtro a serem aplicadas ao buscar tarefas. As opções podem incluir um veículo específico, horário e status da tarefa. |
Interface FleetEngineDeliveryVehicleFilterOptions.
Interface google.maps.journeySharing.FleetEngineDeliveryVehicleFilterOptions
Opções de filtragem para veículos de entrega
Requer o parâmetro de URL &libraries=journeySharing
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
requiredAttributes optional |
Tipo:
Object<string, string> optional Atributos personalizados que os veículos de entrega precisam ter. Os valores precisam ser strings. Caso contrário, um erro será gerado. |
Interface FleetEngineTaskFilterOptions.
Interface google.maps.journeySharing.FleetEngineTaskFilterOptions
Opções de filtragem para tarefas no provedor de localização do veículo de entrega.
Requer o parâmetro de URL &libraries=journeySharing
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
completionTimeFrom optional |
Tipo:
Date optional Limite inferior exclusivo para o tempo de conclusão da tarefa. Usado para filtrar tarefas que foram concluídas após o tempo especificado. |
completionTimeTo optional |
Tipo:
Date optional Limite superior exclusivo para o tempo de conclusão da tarefa. Usado para filtrar tarefas que foram concluídas antes do tempo especificado. |
state optional |
Tipo:
string optional O estado da tarefa. Os valores válidos são OPEN ou CLOSED. |
Interface FleetEngineDeliveryVehicleLocationProviderUpdateEvent.
Interface google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderUpdateEvent
Objeto de evento retornado pelo evento de atualização do provedor do local do veículo de entrega.
Requer o parâmetro de URL &libraries=journeySharing
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
completedVehicleJourneySegments optional |
Tipo:
Array<VehicleJourneySegment> optional Os trechos da jornada que foram concluídos por este veículo. Não pode ser modificado. |
deliveryVehicle optional |
Tipo:
DeliveryVehicle optional A estrutura de dados do veículo de entrega retornada pela atualização. Não pode ser modificado. |
tasks optional |
Tipo:
Array<Task> optional A lista de tarefas exibidas por este veículo de entrega. Não pode ser modificado. |
Classe FleetEngineDeliveryFleetLocationProvider
Classe
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider
Provedor de localização da frota de entrega.
Essa classe estende
LocationProvider
.
Requer o parâmetro de URL &libraries=journeySharing
. Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
---|---|
FleetEngineDeliveryFleetLocationProvider |
FleetEngineDeliveryFleetLocationProvider(options) Parâmetros:
Cria um novo provedor de localização para veículos rastreados pelo Fleet Engine. |
Propriedades | |
---|---|
deliveryVehicleFilterOptions |
Tipo:
FleetEngineDeliveryVehicleFilterOptions optional As opções de filtro a serem aplicadas ao buscar os veículos de entrega. |
locationRestriction |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Os limites aos quais as localizações do veículo de entrega serão limitadas. Defina esse campo para limitar os veículos mostrados aos limites especificados. Se nenhum limite for definido, todos os veículos de entrega serão mostrados. |
pollingIntervalMillis |
Tipo:
number optional Tempo mínimo entre buscar atualizações de localização em milissegundos. Se demorar mais de pollingIntervalMillis para buscar uma atualização de local, a próxima atualização de local não será iniciada até que a atual seja concluída. Definir esse valor como 0 desativa as atualizações recorrentes de localização. Uma nova atualização de localização será buscada se um dos parâmetros observados pelo provedor de localização mudar. O intervalo padrão de pesquisa é de 5.000 milissegundos, o intervalo mínimo. Se você definir o intervalo de pesquisa para um valor diferente de zero, o valor 5.000 será usado. |
staleLocationThresholdMillis |
Tipo:
number Este campo é somente leitura. Limite para localização de veículo desatualizado. Se o último local atualizado do veículo for mais antigo que esse limite, ele não será exibido. |
Métodos | |
---|---|
Herdadas:
addListener
|
Eventos | |
---|---|
update |
function(event) Argumentos:
Evento acionado quando uma solicitação de atualização de dados do Fleet Engine é concluída. |
Interface FleetEngineDeliveryFleetLocationProviderOptions
Interface google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions
Opções para o provedor de localização da frota de entrega.
Requer o parâmetro de URL &libraries=journeySharing
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
authTokenFetcher |
Tipo:
AuthTokenFetcher Fornece JSON Web Tokens para autenticar o cliente na Fleet Engine. |
projectId |
Tipo:
string O ID do projeto do consumidor no Console do Google Cloud. |
deliveryVehicleFilterOptions optional |
Tipo:
FleetEngineDeliveryVehicleFilterOptions optional Filtre as opções para aplicar ao buscar os veículos de entrega. |
locationRestriction optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Um filtro para limitar as consultas a estar dentro dos limites de latitude/longitude fornecidos. Se nenhum limite for especificado, todos os veículos de entrega serão exibidos. |
staleLocationThresholdMillis optional |
Tipo:
number optional Limite para localização de veículo desatualizado. Se o último local atualizado do veículo for mais antigo que esse limite, ele não será exibido. O padrão é 24 horas em milissegundos. Se o limite for menor que zero ou infinito, ele será ignorado e o local do veículo não será considerado desatualizado. |
Interface FleetEngineDeliveryFleetLocationProviderUpdateEvent
Interface google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent
Objeto de evento retornado pelo evento de atualização do provedor de localização da frota de entrega.
Requer o parâmetro de URL &libraries=journeySharing
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
deliveryVehicles optional |
Tipo:
Array<DeliveryVehicle> optional A lista de veículos de entrega retornados pela consulta. Não pode ser modificado. |