Shipment Tracking

Classe FleetEngineShipmentLocationProvider

Classe google.maps.journeySharing.FleetEngineShipmentLocationProvider

Provedor de local de envio.

Essa classe estende PollingLocationProvider.

Acesse chamando const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing"). Consulte Bibliotecas na API Maps JavaScript.

Construtor
FleetEngineShipmentLocationProvider	FleetEngineShipmentLocationProvider(options) Parâmetros: options:  FleetEngineShipmentLocationProviderOptions Opções para o provedor de local. Cria um novo provedor de local para o rastreamento de remessas do Fleet Engine.

Propriedades
trackingId	Tipo:string O ID de rastreamento da tarefa que esse provedor de local observa. Defina esse campo para começar a monitorar.
Herdado: isPolling, pollingIntervalMillis

Métodos
refresh	refresh() Parâmetros:nenhum Valor de retorno:void Atualiza explicitamente o local rastreado.
Herdado: addListener

Eventos
error	function(event) Argumentos:  event:  ErrorEvent Evento acionado quando o provedor de local encontra um erro.
update	function(event) Argumentos:  event:  FleetEngineShipmentLocationProviderUpdateEvent 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 do envio.

Propriedades
authTokenFetcher	Tipo: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 optional	Tipo:(function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional Personalização aplicada à polilinha ativa. Uma polilinha ativa corresponde a uma parte da rota que o veículo está percorrendo. Use esse campo para especificar estilos personalizados (como a cor da poligonal) e interatividade (como o processamento de cliques). Se um objeto PolylineOptions for especificado, as mudanças especificadas nele serão aplicadas à poligonal 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 linha poligonal mudam ou quando o provedor de local recebe dados do Fleet Engine, independentemente de os dados correspondentes a essa linha poligonal terem mudado. Consulte ShipmentPolylineCustomizationFunctionParams para conferir uma lista de parâmetros fornecidos e seus usos.
deliveryVehicleMarkerCustomization optional	Tipo:(function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personalização aplicada ao marcador do veículo de entrega. Use este campo para especificar estilos personalizados (como o ícone do marcador) e interatividade (como o processamento de cliques). Se um objeto MarkerOptions for especificado, as mudanças nele especificadas serão aplicadas ao marcador após a criação dele, 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. (Nesta 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 local recebe dados do Fleet Engine, independentemente de os dados correspondentes a esse marcador terem mudado. Consulte ShipmentMarkerCustomizationFunctionParams para conferir uma lista de parâmetros fornecidos e os usos deles.
destinationMarkerCustomization optional	Tipo:(function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personalização aplicada ao marcador de destino. Use este campo para especificar estilos personalizados (como o ícone do marcador) e interatividade (como o processamento de cliques). Se um objeto MarkerOptions for especificado, as mudanças nele especificadas serão aplicadas ao marcador após a criação dele, 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. (Nesta 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 local recebe dados do Fleet Engine, independentemente de os dados correspondentes a esse marcador terem mudado. Consulte ShipmentMarkerCustomizationFunctionParams para conferir uma lista de parâmetros fornecidos e os usos deles.
pollingIntervalMillis optional	Tipo:number optional Tempo mínimo entre a busca de atualizações de local em milissegundos. Se levar mais tempo que pollingIntervalMillis para buscar uma atualização de local, a próxima atualização não será iniciada até que a atual seja concluída. Definir esse valor como 0, "Infinity" ou um valor negativo desativa as atualizações automáticas de local. Uma nova atualização de local é buscada uma vez se o parâmetro de ID de rastreamento (por exemplo, o ID de rastreamento do envio do provedor de local do envio) ou uma opção de filtragem (por exemplo, limites de viewport ou filtros de atributo para provedores de local da frota) mudar. O intervalo de pesquisa padrão e mínimo é de 5.000 milissegundos. Se você definir o intervalo de pesquisa como um valor positivo menor, 5000 será armazenado e usado.
remainingPolylineCustomization optional	Tipo:(function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional Personalização aplicada à polilinha restante. Uma polilinha restante corresponde a uma parte da rota que o veículo ainda não começou a percorrer. Use esse campo para especificar estilos personalizados (como a cor da poligonal) e interatividade (como o processamento de cliques). Se um objeto PolylineOptions for especificado, as mudanças especificadas nele serão aplicadas à poligonal 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 linha poligonal mudam ou quando o provedor de local recebe dados do Fleet Engine, independentemente de os dados correspondentes a essa linha poligonal terem mudado. Consulte ShipmentPolylineCustomizationFunctionParams para conferir uma lista de parâmetros fornecidos e seus usos.
takenPolylineCustomization optional	Tipo:(function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional Personalização aplicada à polilinha tirada. Uma polilinha percorrida corresponde a uma parte da rota que o veículo já percorreu. Use esse campo para especificar estilos personalizados (como a cor da poligonal) e interatividade (como o processamento de cliques). Se um objeto PolylineOptions for especificado, as mudanças especificadas nele serão aplicadas à poligonal 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 linha poligonal mudam ou quando o provedor de local recebe dados do Fleet Engine, independentemente de os dados correspondentes a essa linha poligonal terem mudado. Consulte ShipmentPolylineCustomizationFunctionParams para conferir uma lista de parâmetros fornecidos e seus usos.
trackingId optional	Tipo:string optional O ID de rastreamento da tarefa a ser rastreada imediatamente após a instanciação do provedor de local. Se não for especificado, o provedor de local não vai começar a rastrear nenhuma tarefa. Use FleetEngineShipmentLocationProvider.trackingId para definir o ID de rastreamento e começar o rastreamento.

Interface FleetEngineShipmentLocationProviderUpdateEvent

Interface google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent

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

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