SearchStructuredAddressOptions interface

Pacote:

@azure/maps-search

Opções para pesquisar endereços estruturados

Extends

SearchBaseOptions,OperationOptions

Propriedades

entityType

O entityType especifica o nível de filtragem executado em geografias

Propriedades herdadas

abortSignal	O sinal que pode ser usado para anular solicitações.
extendedPostalCodesFor	Índices para os quais os códigos postais estendidos devem ser incluídos nos resultados
language	Idioma no qual os resultados da pesquisa devem ser retornados.
localizedMapView	O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopolicamente disputadas.
onResponse	Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
requestOptions	Opções usadas ao criar e enviar solicitações HTTP para esta operação.
serializerOptions	Opções para substituir o comportamento de serialização/des serialização.
skip	Deslocamento inicial dos resultados retornados dentro do conjunto de resultados completo. Padrão: 0, mínimo: 0 e máximo: 1900
top	Número máximo de respostas que serão retornadas. Padrão: 10, mínimo: 1 e máximo: 100
tracingOptions	Opções usadas quando o rastreamento está habilitado.

Detalhes da propriedade

entityType

O entityType especifica o nível de filtragem executado em geografias

entityType?: 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 OperationOptions.abortSignal

extendedPostalCodesFor

Índices para os quais os códigos postais estendidos devem ser incluídos nos resultados

extendedPostalCodesFor?: string[]

Valor da propriedade

string[]

Herdado deSearchBaseOptions.extendedPostalCodesFor

language

Idioma no qual os resultados da pesquisa devem ser retornados.

language?: string

Valor da propriedade

string

Herdado deSearchBaseOptions.language

localizedMapView

O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopolicamente disputadas.

localizedMapView?: string

Valor da propriedade

string

Herdado deSearchBaseOptions.localizedMapView

onResponse

Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor da propriedade

RawResponseCallback

Herdado de OperationOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor da propriedade

OperationRequestOptions

Herdado de OperationOptions.requestOptions

serializerOptions

Opções para substituir o comportamento de serialização/des serialização.

serializerOptions?: SerializerOptions

Valor da propriedade

SerializerOptions

herdado de OperationOptions.serializerOptions

skip

Deslocamento inicial dos resultados retornados dentro do conjunto de resultados completo. Padrão: 0, mínimo: 0 e máximo: 1900

skip?: number

Valor da propriedade

number

Herdado deSearchBaseOptions.skip

top

Número máximo de respostas que serão retornadas. Padrão: 10, mínimo: 1 e máximo: 100

top?: number

Valor da propriedade

number

Herdado deSearchBaseOptions.top

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

Herdado de OperationOptions.tracingOptions