SearchGetSearchAddressStructuredOptionalParams interface

Pacote:

azure-maps-rest

Parâmetros Opcionais.

Extends

RequestOptionsBase

Propriedades

countrySecondarySubdivision	O concelho para o endereço estruturado
countrySubdivision	A parte da subdividição do país de um endereço
countryTertiarySubdivision	A área nomeada para o endereço estruturado
crossStreet	O nome da rua cruzada para o endereço estruturado
extendedPostalCodesFor	Os índices para os quais os códigos postais alargados devem ser incluídos nos resultados. Os índices disponíveis são: Addr = Intervalos de endereços Geo = Geografias PAD = Endereços de Ponto POI = Pontos de Interesse Str = Ruas XStr = Cross Streets (interseções) O valor deve ser uma lista separada por vírgulas de tipos de índice (por qualquer ordem) ou Nenhum para nenhum índice. Por predefinição, os códigos postais expandidos estão incluídos para todos os índices, exceto Geo. As listas de códigos postais alargados para geografias podem ser bastante longas, pelo que têm de ser explicitamente pedidas quando necessário. Exemplos de utilização: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None O código postal alargado é devolvido como uma propriedade extendedPostalCode de um endereço. A disponibilidade é dependente da região.
language	Idioma no qual os resultados da pesquisa devem ser devolvidos. Deve ser uma das etiquetas de idioma IETF suportadas, não sensíveis a maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, é utilizado o idioma predefinido. Consulte idiomas suportados para obter detalhes.
limit	Número máximo de respostas que serão devolvidas
municipality	A parte do município de um endereço
municipalitySubdivision	Subdivisão do município (sub/super cidade) para o endereço estruturado
ofs	Desvio inicial dos resultados devolvidos no conjunto de resultados completo
postalCode	A parte do código postal de um endereço
streetName	A parte do nome da rua de um endereço
streetNumber	A parte do número da rua de um endereço
view	O parâmetro Ver especifica o conjunto de conteúdos geopolíticos contestados que é devolvido através de serviços Azure Maps, incluindo limites e etiquetas apresentados no mapa. O parâmetro Ver (também denominado "parâmetro da região do utilizador") mostrará os mapas corretos para esse país/região. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que devolverá os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN. Consulte Vistas Suportadas para obter detalhes e para ver as Vistas disponíveis.

Propriedades Herdadas

abortSignal	O sinal que pode ser utilizado para abortar pedidos.
customHeaders	{object} [customHeaders] Cabeçalhos de pedido personalizados definidos pelo utilizador que serão aplicados antes do pedido ser enviado.
onDownloadProgress	Chamada de retorno que é acionada após o progresso da transferência.
onUploadProgress	Chamada de retorno que é acionada após o progresso do carregamento.
timeout	O número de milissegundos que um pedido pode tomar antes de ser terminado automaticamente.

Detalhes de Propriedade

countrySecondarySubdivision

O concelho para o endereço estruturado

countrySecondarySubdivision?: string

Valor de Propriedade

string

countrySubdivision

A parte da subdividição do país de um endereço

countrySubdivision?: string

Valor de Propriedade

string

countryTertiarySubdivision

A área nomeada para o endereço estruturado

countryTertiarySubdivision?: string

Valor de Propriedade

string

crossStreet

O nome da rua cruzada para o endereço estruturado

crossStreet?: string

Valor de Propriedade

string

extendedPostalCodesFor

Os índices para os quais os códigos postais alargados devem ser incluídos nos resultados. Os índices disponíveis são:

Addr = Intervalos de endereços

Geo = Geografias

PAD = Endereços de Ponto

POI = Pontos de Interesse

Str = Ruas

XStr = Cross Streets (interseções)

O valor deve ser uma lista separada por vírgulas de tipos de índice (por qualquer ordem) ou Nenhum para nenhum índice.

Por predefinição, os códigos postais expandidos estão incluídos para todos os índices, exceto Geo. As listas de códigos postais alargados para geografias podem ser bastante longas, pelo que têm de ser explicitamente pedidas quando necessário.

Exemplos de utilização:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

O código postal alargado é devolvido como uma propriedade extendedPostalCode de um endereço. A disponibilidade é dependente da região.

extendedPostalCodesFor?: string

Valor de Propriedade

string

language

Idioma no qual os resultados da pesquisa devem ser devolvidos. Deve ser uma das etiquetas de idioma IETF suportadas, não sensíveis a maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, é utilizado o idioma predefinido. Consulte idiomas suportados para obter detalhes.

language?: string

Valor de Propriedade

string

limit

Número máximo de respostas que serão devolvidas

limit?: number

Valor de Propriedade

number

municipality

A parte do município de um endereço

municipality?: string

Valor de Propriedade

string

municipalitySubdivision

Subdivisão do município (sub/super cidade) para o endereço estruturado

municipalitySubdivision?: string

Valor de Propriedade

string

ofs

Desvio inicial dos resultados devolvidos no conjunto de resultados completo

ofs?: number

Valor de Propriedade

number

postalCode

A parte do código postal de um endereço

postalCode?: string

Valor de Propriedade

string

streetName

A parte do nome da rua de um endereço

streetName?: string

Valor de Propriedade

string

streetNumber

A parte do número da rua de um endereço

streetNumber?: string

Valor de Propriedade

string

view

O parâmetro Ver especifica o conjunto de conteúdos geopolíticos contestados que é devolvido através de serviços Azure Maps, incluindo limites e etiquetas apresentados no mapa. O parâmetro Ver (também denominado "parâmetro da região do utilizador") mostrará os mapas corretos para esse país/região. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que devolverá os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN. Consulte Vistas Suportadas para obter detalhes e para ver as Vistas disponíveis.

view?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser utilizado para abortar pedidos.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

Herdado de RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Cabeçalhos de pedido personalizados definidos pelo utilizador que serão aplicados antes do pedido ser enviado.

customHeaders?: [key: string]: string

Valor de Propriedade

[key: string]: string

Herdado de RequestOptionsBase.customHeaders

onDownloadProgress

Chamada de retorno que é acionada após o progresso da transferência.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onDownloadProgress

onUploadProgress

Chamada de retorno que é acionada após o progresso do carregamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onUploadProgress

timeout

O número de milissegundos que um pedido pode tomar antes de ser terminado automaticamente.

timeout?: number

Valor de Propriedade

number

Herdado de RequestOptionsBase.timeout