SearchGetSearchAddressStructuredOptionalParams interface

Pacote:

azure-maps-rest

Parâmetros opcionais.

Extends

RequestOptionsBase

Propriedades

countrySecondarySubdivision	O município para o endereço estruturado
countrySubdivision	A parte de 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	Índices para os quais os códigos postais estendidos 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 (em qualquer ordem) ou Nenhum para nenhum índice. Por padrão, os códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas de cep estendidas para geografias podem ser muito longas, portanto, elas precisam ser solicitadas explicitamente quando necessário. Exemplos de uso: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None O código postal estendido é retornado como uma propriedade extendedPostalCode de um endereço. A disponibilidade depende da região.
language	Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de idioma IETF com suporte, que não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado. Consulte Idiomas com suporte para obter detalhes.
limit	Número máximo de respostas que serão retornadas
municipality	A parte do município de um endereço
municipalitySubdivision	A subdivisão do município (sub/super cidade) para o endereço estruturado
ofs	Deslocamento inicial dos resultados retornados dentro do conjunto de resultados completo
postalCode	A parte do cep 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 View especifica qual conjunto de conteúdo geopolítico contestado é retornado por meio de serviços Azure Mapas, incluindo bordas e rótulos exibidos no mapa. O parâmetro View (também conhecido como "parâmetro de região do usuário") mostrará os mapas corretos para esse país/região. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização dos usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro View no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país em que mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas é disponibilizado. Exemplo: view=IN. Consulte Modos de exibição com suporte para obter detalhes e ver os Modos de Exibição disponíveis.

Propriedades herdadas

abortSignal	O sinal que pode ser usado para anular solicitações.
customHeaders	{object} [customHeaders] Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação.
onDownloadProgress	Retorno de chamada que é acionado após o progresso do download.
onUploadProgress	Retorno de chamada que é acionado após o progresso do upload.
timeout	O número de milissegundos que uma solicitação pode realizar antes de ser encerrada automaticamente.

Detalhes da propriedade

countrySecondarySubdivision

O município para o endereço estruturado

countrySecondarySubdivision?: string

Valor da propriedade

string

countrySubdivision

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

countrySubdivision?: string

Valor da propriedade

string

countryTertiarySubdivision

A área nomeada para o endereço estruturado

countryTertiarySubdivision?: string

Valor da propriedade

string

crossStreet

O nome da rua cruzada para o endereço estruturado

crossStreet?: string

Valor da propriedade

string

extendedPostalCodesFor

Índices para os quais os códigos postais estendidos 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 (em qualquer ordem) ou Nenhum para nenhum índice.

Por padrão, os códigos postais estendidos são incluídos para todos os índices, exceto Geo. As listas de cep estendidas para geografias podem ser muito longas, portanto, elas precisam ser solicitadas explicitamente quando necessário.

Exemplos de uso:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

O código postal estendido é retornado como uma propriedade extendedPostalCode de um endereço. A disponibilidade depende da região.

extendedPostalCodesFor?: string

Valor da propriedade

string

language

Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de idioma IETF com suporte, que não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado. Consulte Idiomas com suporte para obter detalhes.

language?: string

Valor da propriedade

string

limit

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

limit?: number

Valor da propriedade

number

municipality

A parte do município de um endereço

municipality?: string

Valor da propriedade

string

municipalitySubdivision

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

municipalitySubdivision?: string

Valor da propriedade

string

ofs

Deslocamento inicial dos resultados retornados dentro do conjunto de resultados completo

ofs?: number

Valor da propriedade

number

postalCode

A parte do cep de um endereço

postalCode?: string

Valor da propriedade

string

streetName

A parte do nome da rua de um endereço

streetName?: string

Valor da propriedade

string

streetNumber

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

streetNumber?: string

Valor da propriedade

string

view

O parâmetro View especifica qual conjunto de conteúdo geopolítico contestado é retornado por meio de serviços Azure Mapas, incluindo bordas e rótulos exibidos no mapa. O parâmetro View (também conhecido como "parâmetro de região do usuário") mostrará os mapas corretos para esse país/região. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização dos usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro View no Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país em que mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas é disponibilizado. Exemplo: view=IN. Consulte Modos de exibição com suporte para obter detalhes e ver os Modos de Exibição disponíveis.

view?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

Herdado de RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação.

customHeaders?: [key: string]: string

Valor da propriedade

[key: string]: string

Herdado de RequestOptionsBase.customHeaders

onDownloadProgress

Retorno de chamada que é acionado após o progresso do download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onDownloadProgress

onUploadProgress

Retorno de chamada que é acionado após o progresso do upload.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onUploadProgress

timeout

O número de milissegundos que uma solicitação pode realizar antes de ser encerrada automaticamente.

timeout?: number

Valor da propriedade

number

Herdado de RequestOptionsBase.timeout