Shipment Tracking

Classe FleetEngineShipmentLocationProvider

google.maps.journeySharing.FleetEngineShipmentLocationProvider classe
estende PollingLocationProvider
biblioteca "journeySharing"

Provedor de localização da remessa.

const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing");
FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
Parâmetros:
Cria um novo provedor de localização para o rastreamento de remessas do Fleet Engine.
trackingId
Tipo: string
O ID de rastreamento da tarefa que esse provedor de localização observa. Defina esse campo para começar o acompanhamento.
Herdado: isPolling, pollingIntervalMillis
refresh
refresh()
Parâmetros: nenhum
Valor de retorno: void
Atualiza explicitamente o local rastreado.
Herdado: addListener
error
function(event)
Argumentos:
Evento que é acionado quando o provedor de localização encontra um erro.
update
function(event)
Evento acionado quando uma solicitação de atualização de dados do Fleet Engine é concluída.
Herdado: ispollingchange

Interface FleetEngineShipmentLocationProviderOptions

Interface google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions

Opções para o provedor de local de envio.

authTokenFetcher
Fornece JSON Web Tokens para autenticar o cliente no Fleet Engine.
projectId
Tipo: string
O ID do projeto do consumidor no console do Google Cloud.
activePolylineCustomization
opcional
Personalização aplicada à polilinha ativa. Uma polilinha ativa corresponde a uma parte do trajeto que o veículo está percorrendo no momento.

Use esse campo para especificar o estilo personalizado (como a cor da polilinha) e a interatividade (como o processamento de cliques).
  • Se um objeto PolylineOptions for especificado, as mudanças indicadas nele serão aplicadas à polilinha depois que ela for criada, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando a polilinha for criada. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando as coordenadas da polilinha mudam ou quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a essa polilinha terem mudado.

    Consulte ShipmentPolylineCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
deliveryVehicleMarkerCustomization
opcional
Personalização aplicada ao marcador do veículo de entrega.

Use esse campo para especificar o estilo personalizado (como o ícone do marcador) e a interatividade (como o processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as mudanças especificadas nele serão aplicadas ao marcador após a criação, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando o marcador for criado, antes de ser adicionado à visualização do mapa. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a esse marcador terem mudado ou não.

    Consulte ShipmentMarkerCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
destinationMarkerCustomization
opcional
Personalização aplicada ao marcador de destino.

Use esse campo para especificar o estilo personalizado (como o ícone do marcador) e a interatividade (como o processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as mudanças especificadas nele serão aplicadas ao marcador após a criação, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando o marcador for criado, antes de ser adicionado à visualização do mapa. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a esse marcador terem mudado ou não.

    Consulte ShipmentMarkerCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
pollingIntervalMillis
opcional
Tipo: number optional
Tempo mínimo entre as atualizações do local em milissegundos. Se levar mais de pollingIntervalMillis para buscar uma atualização de local, a próxima não será iniciada até que a atual seja concluída.

Definir esse valor como 0, infinito ou um valor negativo desativa as atualizações automáticas de local. Uma nova atualização do local é buscada uma vez se o parâmetro do ID de rastreamento (por exemplo, o ID de rastreamento de remessa do provedor de localização de remessa) ou uma opção de filtragem (por exemplo, limites de janela de visualização ou filtros de atributos para provedores de localização de frota) mudar.

O intervalo de sondagem padrão e mínimo é de 5.000 milissegundos. Se você definir o intervalo de sondagem como um valor positivo menor, 5000 será armazenado e usado.
remainingPolylineCustomization
opcional
Personalização aplicada à polilinha restante. Uma polilinha restante corresponde a uma parte do trajeto que o veículo ainda não começou a percorrer.

Use esse campo para especificar o estilo personalizado (como a cor da polilinha) e a interatividade (como o processamento de cliques).
  • Se um objeto PolylineOptions for especificado, as mudanças indicadas nele serão aplicadas à polilinha depois que ela for criada, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando a polilinha for criada. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando as coordenadas da polilinha mudam ou quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a essa polilinha terem mudado.

    Consulte ShipmentPolylineCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
takenPolylineCustomization
opcional
Personalização aplicada à polilinha percorrida. Uma polilinha percorrida 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).
  • Se um objeto PolylineOptions for especificado, as mudanças indicadas nele serão aplicadas à polilinha depois que ela for criada, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando a polilinha for criada. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando as coordenadas da polilinha mudam ou quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a essa polilinha terem mudado.

    Consulte ShipmentPolylineCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
trackingId
opcional
Tipo: string optional
O ID de rastreamento da tarefa a ser rastreada imediatamente após a instanciação do provedor de localização. Se não for especificado, o provedor de localização não vai começar a rastrear nenhuma tarefa. Use FleetEngineShipmentLocationProvider.trackingId para definir o ID de rastreamento e iniciar o rastreamento.

Interface FleetEngineShipmentLocationProviderUpdateEvent

Interface google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent

O objeto de evento transmitido ao manipulador de eventos quando o evento FleetEngineShipmentLocationProvider.update é acionado.

taskTrackingInfo
opcional
Tipo: TaskTrackingInfo optional
A estrutura de informações de rastreamento de tarefas retornada pela atualização. Não modificável.