SearchGetSearchPOICategoryOptionalParams interface

  • Referência
Pacote:
azure-maps-rest

Parâmetros opcionais.

Extends

RequestOptionsBase

Propriedades

brandSet

Uma lista separada por vírgulas de marcas que podem ser usadas para restringir o resultado a marcas específicas. A ordem do item não importa. Quando várias marcas são fornecidas, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados. As marcas que contêm um "," em seu nome devem ser colocadas entre aspas. Exemplos de uso:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Vírgula", Barra
btmRight

Posição inferior direita da caixa delimitadora. Por exemplo, 37,553,-122,453
connectorSet

Uma lista separada por vírgulas de tipos de conectores que podem ser usados para restringir o resultado à Estação de Veículos Elétricos que dá suporte a tipos de conectores específicos. A ordem do item não importa. Quando vários tipos de conector são fornecidos, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados. Os tipos de conectores disponíveis são:

  • StandardHouseholdCountrySpecific - Esses são os conectores domésticos padrão para uma determinada região. Elas são todas fase única ac e a tensão padrão e amperagem padrão. Consulte também: Tipos de soquete plug & – Padrões Mundiais.
  • IEC62196Type1 – Digite um conector conforme definido no padrão IEC 62196-2. Também chamado yazaki após o fabricante original ou SAE J1772 após o padrão que o publicou pela primeira vez. Usado principalmente em combinação com a fase única de 120V ou até 240V infraestrutura de fase única.
  • IEC62196Type1CCS - Conector de combinação baseado em tipo 1, conforme definido no padrão IEC 62196-3. O conector baseia-se no conector tipo 1 , conforme definido no padrão IEC 62196-2 , com dois contatos dc (corrente direta) adicionais para permitir o carregamento rápido de DC.
  • IEC62196Type2CableAttached - Conector do tipo 2, conforme definido no padrão IEC 62196-2. Fornecido como um cabo e plugue anexado ao ponto de carregamento.
  • IEC62196Type2Outlet - Conector do tipo 2, conforme definido no padrão IEC 62196-2. Fornecido como um soquete definido no ponto de carregamento.
  • IEC62196Type2CCS - Conector de combinação baseado no tipo 2, conforme definido no padrão IEC 62196-3. O conector baseia-se no conector tipo 2 , conforme definido no padrão IEC 62196-2 , com dois contatos dc (atuais diretos) adicionais para permitir o carregamento rápido de DC.
  • IEC62196Type3 - Conector do tipo 3, conforme definido no padrão IEC 62196-2. Também chamado scame após o fabricante original. Usado principalmente em combinação com até 240V fase única ou até 420V infraestrutura de três fases.
  • Chademo - Conector CHAdeMO com o nome de uma associação formada pela Tokyo Electric Power Company e por parceiros industriais. Por isso, também é conhecido como o conector do TEPCO. Ele dá suporte ao carregamento rápido de DC.
  • IEC60309AC1PhaseBlue – O conector Azul Industrial é um conector definido no padrão IEC 60309. Às vezes, ele é conhecido como por alguma combinação do padrão, a cor e o fato de que é um conector de fase única. O conector geralmente tem a configuração "P+N+E, 6h".
  • IEC60309DCWhite – O conector Branco Industrial é um conector dc definido no padrão IEC 60309.
  • Tesla - O conector tesla é o conector Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, às vezes chamado de Porta Tesla, em sua maioria limitado a América do Norte ou o Tipo 2 modificado (DC sobre o Tipo 2) na Europa.

Exemplos de uso:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
countrySet

Cadeia de caracteres separada por vírgulas de códigos de país, por exemplo, FR,ES. Isso limitará a pesquisa aos países especificados
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.
lat

Latitude em que os resultados devem ser tendenciosos. Por exemplo, 37,337
limit

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

Longitude em que os resultados devem ser tendenciosos. Por exemplo, -121,89
openingHours

Horário de funcionamento de uma POI (Pontos de Interesse). A disponibilidade do horário de funcionamento varia de acordo com os dados disponíveis. Os valores possíveis incluem: 'nextSevenDays'
radius

O raio em metros para para que os resultados sejam restritos à área definida
topLeft

Posição superior esquerda da caixa delimitadora. Por exemplo, 37,553,-122,453
typeahead

Booliano. Se o sinalizador typeahead estiver definido, a consulta será interpretada como uma entrada parcial e a pesquisa entrará no modo preditivo
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 é disparado após o progresso do download.
onUploadProgress

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

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

Detalhes da propriedade

brandSet

Uma lista separada por vírgulas de marcas que podem ser usadas para restringir o resultado a marcas específicas. A ordem do item não importa. Quando várias marcas são fornecidas, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados. As marcas que contêm um "," em seu nome devem ser colocadas entre aspas. Exemplos de uso:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Vírgula", Barra

brandSet?: string[]

Valor da propriedade

string[]

btmRight

Posição inferior direita da caixa delimitadora. Por exemplo, 37,553,-122,453

btmRight?: string

Valor da propriedade

string

connectorSet

Uma lista separada por vírgulas de tipos de conectores que podem ser usados para restringir o resultado à Estação de Veículos Elétricos que dá suporte a tipos de conectores específicos. A ordem do item não importa. Quando vários tipos de conector são fornecidos, somente os resultados que pertencem a (pelo menos) uma das listas fornecidas serão retornados. Os tipos de conectores disponíveis são:

  • StandardHouseholdCountrySpecific - Esses são os conectores domésticos padrão para uma determinada região. Elas são todas fase única ac e a tensão padrão e amperagem padrão. Consulte também: Tipos de soquete plug & – Padrões Mundiais.
  • IEC62196Type1 – Digite um conector conforme definido no padrão IEC 62196-2. Também chamado yazaki após o fabricante original ou SAE J1772 após o padrão que o publicou pela primeira vez. Usado principalmente em combinação com a fase única de 120V ou até 240V infraestrutura de fase única.
  • IEC62196Type1CCS - Conector de combinação baseado em tipo 1, conforme definido no padrão IEC 62196-3. O conector baseia-se no conector tipo 1 , conforme definido no padrão IEC 62196-2 , com dois contatos dc (corrente direta) adicionais para permitir o carregamento rápido de DC.
  • IEC62196Type2CableAttached - Conector do tipo 2, conforme definido no padrão IEC 62196-2. Fornecido como um cabo e plugue anexado ao ponto de carregamento.
  • IEC62196Type2Outlet - Conector do tipo 2, conforme definido no padrão IEC 62196-2. Fornecido como um soquete definido no ponto de carregamento.
  • IEC62196Type2CCS - Conector de combinação baseado no tipo 2, conforme definido no padrão IEC 62196-3. O conector baseia-se no conector tipo 2 , conforme definido no padrão IEC 62196-2 , com dois contatos dc (atuais diretos) adicionais para permitir o carregamento rápido de DC.
  • IEC62196Type3 - Conector do tipo 3, conforme definido no padrão IEC 62196-2. Também chamado scame após o fabricante original. Usado principalmente em combinação com até 240V fase única ou até 420V infraestrutura de três fases.
  • Chademo - Conector CHAdeMO com o nome de uma associação formada pela Tokyo Electric Power Company e por parceiros industriais. Por isso, também é conhecido como o conector do TEPCO. Ele dá suporte ao carregamento rápido de DC.
  • IEC60309AC1PhaseBlue – O conector Azul Industrial é um conector definido no padrão IEC 60309. Às vezes, ele é conhecido como por alguma combinação do padrão, a cor e o fato de que é um conector de fase única. O conector geralmente tem a configuração "P+N+E, 6h".
  • IEC60309DCWhite – O conector Branco Industrial é um conector dc definido no padrão IEC 60309.
  • Tesla - O conector tesla é o conector Tesla Supercharger específico regionalmente. Ou seja, refere-se ao conector proprietário da Tesla, às vezes chamado de Porta Tesla, em sua maioria limitado a América do Norte ou o Tipo 2 modificado (DC sobre o Tipo 2) na Europa.

Exemplos de uso:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

connectorSet?: ConnectorSet[]

Valor da propriedade

ConnectorSet[]

countrySet

Cadeia de caracteres separada por vírgulas de códigos de país, por exemplo, FR,ES. Isso limitará a pesquisa aos países especificados

countrySet?: 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

lat

Latitude em que os resultados devem ser tendenciosos. Por exemplo, 37,337

lat?: number

Valor da propriedade

number

limit

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

limit?: number

Valor da propriedade

number

lon

Longitude em que os resultados devem ser tendenciosos. Por exemplo, -121,89

lon?: number

Valor da propriedade

number

openingHours

Horário de funcionamento de uma POI (Pontos de Interesse). A disponibilidade do horário de funcionamento varia de acordo com os dados disponíveis. Os valores possíveis incluem: 'nextSevenDays'

openingHours?: OpeningHours

Valor da propriedade

OpeningHours

radius

O raio em metros para para que os resultados sejam restritos à área definida

radius?: number

Valor da propriedade

number

topLeft

Posição superior esquerda da caixa delimitadora. Por exemplo, 37,553,-122,453

topLeft?: string

Valor da propriedade

string

typeahead

Booliano. Se o sinalizador typeahead estiver definido, a consulta será interpretada como uma entrada parcial e a pesquisa entrará no modo preditivo

typeahead?: boolean

Valor da propriedade

boolean

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 é disparado 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 é disparado 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 levar antes de ser encerrada automaticamente.

timeout?: number

Valor da propriedade

number

Herdado de RequestOptionsBase.timeout