Classe FleetEngineDeliveryVehicleLocationProvider
Classe
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider
Provedor de localização de veículo de entrega.
Essa classe estende
PollingLocationProvider
.
Acesse chamando const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("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 monitorar um veículo. |
shouldShowOutcomeLocations |
Tipo:
boolean optional Outra opção é permitir que os usuários exibam o local do resultado da tarefa. |
shouldShowTasks |
Tipo:
boolean optional Outra opção é permitir que os usuários exibam as tarefas buscadas. |
staleLocationThresholdMillis |
Tipo:
number Este campo é somente leitura. Limite para a localização do veículo desatualizado. Se o último local atualizado do veículo for anterior a esse limite, o veículo não será exibido. |
taskFilterOptions |
Retorna as opções de filtro a serem aplicadas ao buscar tarefas. |
Herdado:
isPolling ,
pollingIntervalMillis
|
Métodos | |
---|---|
Herdado:
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. |
Herdado:
ispollingchange
|
Interface FleetEngineDeliveryVehicleLocationProviderOptions
Interface
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderOptions
Opções para o provedor de localização do veículo de entrega.
Propriedades | |
---|---|
authTokenFetcher |
Tipo:
AuthTokenFetcher Fornece tokens JSON Web para autenticar o cliente no Fleet Engine. |
projectId |
Tipo:
string O ID do projeto do consumidor no console do Google Cloud. |
activePolylineCustomization optional |
Tipo:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional Personalização aplicada à polilinha ativa. Uma polilinha ativa corresponde a uma parte do trajeto pelo qual o veículo está passando. Use esse campo para especificar o estilo personalizado (como a cor da polilinha) e a interatividade (como o processamento de cliques).
|
deliveryVehicleId optional |
Tipo:
string optional O ID do veículo de entrega a ser rastreado imediatamente após o provedor de localização ser instanciado. Se não for especificado, o provedor do local não vai começar a rastrear nenhum veículo. Use FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId para definir o ID e iniciar o monitoramento. |
deliveryVehicleMarkerCustomization optional |
Tipo:
(function(DeliveryVehicleMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personalização aplicada ao marcador do veículo de entrega. Use esse campo para especificar o estilo personalizado (como o ícone de um marcador) e a interatividade (como o processamento de cliques).
|
plannedStopMarkerCustomization optional |
Tipo:
(function(PlannedStopMarkerCustomizationFunctionParams): void)|MarkerOptions optional A personalização foi aplicada a um marcador de parada planejada. Use esse campo para especificar o estilo personalizado (como o ícone de um marcador) e a interatividade (como o processamento de cliques).
|
pollingIntervalMillis optional |
Tipo:
number optional Tempo mínimo entre a busca de atualizações de local em milissegundos. Se levar 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 de localização recorrentes. Uma nova atualização de local será buscada se qualquer um dos parâmetros observados pelo provedor de localização mudar. O intervalo de pesquisa padrão é de 5.000 milissegundos, o intervalo mínimo. Se você definir o intervalo de pesquisa com um valor menor, diferente de zero, será usado 5.000. |
remainingPolylineCustomization optional |
Tipo:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional Personalização aplicada à polilinha restante. Uma polilinha restante corresponde a uma parte do trajeto que o veículo ainda não começou a atravessar. Use esse campo para especificar o estilo personalizado (como a cor da polilinha) e a interatividade (como o processamento de cliques).
|
shouldShowOutcomeLocations optional |
Tipo:
boolean optional Booleano para mostrar ou ocultar os locais de resultados das tarefas buscadas. |
shouldShowTasks optional |
Tipo:
boolean optional Booleano para mostrar ou ocultar tarefas. Definir como falso impede que o endpoint ListTasks seja chamado para buscar as tarefas. Somente as próximas paradas de veículos serão exibidas. |
staleLocationThresholdMillis optional |
Tipo:
number optional Limite para a localização do veículo desatualizado. Se o último local atualizado do veículo tiver um valor anterior a esse limite, o veículo não será mostrado. O padrão é de 24 horas em milissegundos. Se o limite for menor que 0, ou Infinity, o limite será ignorado, e a localização do veículo não será considerada desatualizada. |
takenPolylineCustomization optional |
Tipo:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional Personalização aplicada à polilinha escolhida. Uma polilinha selecionada corresponde a uma parte do trajeto que o veículo já percorreu. Use esse campo para especificar o estilo personalizado (como a cor da polilinha) e a interatividade (como o processamento de cliques).
|
taskFilterOptions optional |
Tipo:
FleetEngineTaskFilterOptions optional Opções de filtro a serem aplicadas ao buscar tarefas. As opções podem incluir informações específicas do veículo, horário e status da tarefa. |
taskMarkerCustomization optional |
Tipo:
(function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personalização aplicada a um marcador de tarefa. Um marcador de tarefa é renderizado no local planejado de cada tarefa atribuída ao veículo de entrega. Use esse campo para especificar o estilo personalizado (como o ícone de um marcador) e a interatividade (como o processamento de cliques).
|
taskOutcomeMarkerCustomization optional |
Tipo:
function(TaskMarkerCustomizationFunctionParams): void optional Personalização aplicada a um marcador de resultado de tarefa. Um marcador de resultado da tarefa é renderizado no local do resultado real de cada tarefa atribuída ao veículo de entrega. Use esse campo para especificar o estilo personalizado (como o ícone de um marcador) e a interatividade (como o processamento de cliques).
|
Interface FleetEngineTaskFilterOptions
Interface
google.maps.journeySharing.FleetEngineTaskFilterOptions
Opções de filtragem para tarefas no provedor de localização do veículo de entrega.
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 período 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
O objeto do evento transmitido ao manipulador de eventos quando o evento FleetEngineDeliveryVehicleLocationProvider.update
é acionado.
Propriedades | |
---|---|
completedVehicleJourneySegments optional |
Tipo:
Array<VehicleJourneySegment> optional Os trechos da jornada que foram concluídos por este veículo. Não modificável. |
deliveryVehicle optional |
Tipo:
DeliveryVehicle optional A estrutura de dados do veículo de entrega retornada pela atualização. Não modificável. |
tasks optional |
A lista de tarefas atendidas por este veículo de entrega. Não modificável. |
Classe FleetEngineDeliveryFleetLocationProvider
Classe
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider
Provedor de localização da frota de entregas.
Essa classe estende
PollingLocationProvider
.
Acesse chamando const {FleetEngineDeliveryFleetLocationProvider} = await google.maps.importLibrary("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 | |
---|---|
deliveryVehicleFilter |
Tipo:
string optional O filtro aplicado ao buscar os veículos de entrega. |
locationRestriction |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Os limites para rastrear os veículos de entrega. Se nenhum limite for definido, nenhum veículo de entrega será rastreado. Para rastrear todos os veículos de entrega, independentemente do local, defina limites equivalentes a toda a Terra. |
staleLocationThresholdMillis |
Tipo:
number Este campo é somente leitura. Limite para a localização do veículo desatualizado. Se o último local atualizado do veículo for anterior a esse limite, o veículo não será exibido. |
Herdado:
isPolling ,
pollingIntervalMillis
|
Métodos | |
---|---|
Herdado:
addListener
|
Eventos | |
---|---|
update |
function(event) Argumentos:
Evento acionado quando uma solicitação de atualização de dados do Fleet Engine é concluída. |
Herdado:
ispollingchange
|
Interface FleetEngineDeliveryFleetLocationProviderOptions
Interface
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions
Opções para o provedor de localização da frota de entregas.
Propriedades | |
---|---|
authTokenFetcher |
Tipo:
AuthTokenFetcher Fornece tokens JSON Web para autenticar o cliente no Fleet Engine. |
projectId |
Tipo:
string O ID do projeto do consumidor no console do Google Cloud. |
deliveryVehicleFilter optional |
Tipo:
string optional Uma consulta de filtro para aplicar ao buscar veículos de entrega. Esse filtro é transmitido diretamente para o Fleet Engine. Consulte os formatos compatíveis em ListDeliveryVehiclesRequest.filter. Os filtros válidos para atributos precisam ter o prefixo "atributos". Por exemplo, attributes.x = "y" ou attributes."x y" = "z" . |
deliveryVehicleMarkerCustomization optional |
Tipo:
function(DeliveryVehicleMarkerCustomizationFunctionParams): void optional Personalização aplicada a um marcador de veículo de entrega. Use esse campo para especificar o estilo personalizado (como o ícone de um marcador) e a interatividade (como o processamento de cliques).
|
locationRestriction optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Os limites de latitude/longitude nos quais rastrear veículos imediatamente após o provedor de localização ser instanciado. Se ela não for definida, o provedor de localização não vai começar a rastrear nenhum veículo. Use FleetEngineDeliveryFleetLocationProvider.locationRestriction para definir os limites e começar o rastreamento. Para rastrear todos os veículos de entrega, independentemente do local, defina limites equivalentes a toda a Terra. |
staleLocationThresholdMillis optional |
Tipo:
number optional Limite para a localização do veículo desatualizado. Se o último local atualizado do veículo tiver um valor anterior a esse limite, o veículo não será mostrado. O padrão é de 24 horas em milissegundos. Se o limite for menor que zero ou Infinity, o limite vai ser ignorado, e a localização do veículo não vai ser considerada desatualizada. |
Interface FleetEngineDeliveryFleetLocationProviderUpdateEvent
Interface
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent
O objeto do evento transmitido ao manipulador de eventos quando o evento FleetEngineDeliveryFleetLocationProvider.update
é acionado.
Propriedades | |
---|---|
deliveryVehicles optional |
Tipo:
Array<DeliveryVehicle> optional A lista de veículos de entrega retornados pela consulta. Não modificável. |