Partilhar via

Componente de resultados de pesquisa no Microsoft Graph Toolkit

Cuidado

O Toolkit do Microsoft Graph foi preterido. O período de reforma começa a 1 de setembro de 2025, com a reforma completa prevista para 28 de agosto de 2026. Os programadores devem migrar para utilizar os SDKs do Microsoft Graph ou outras ferramentas suportadas do Microsoft Graph para criar experiências Web. Para obter mais informações, veja o anúncio de preterição.

Pode utilizar mgt-search-results para efetuar consultas de pesquisa no Microsoft Graph diretamente no seu HTML. O componente fornece algumas composiçãos de tipo de resultado predefinidas, mas também oferece personalização completa dos modelos.

Exemplo

O exemplo seguinte mostra a utilização do mgt-search-results componente nos documentos mais relevantes. Pode utilizar o editor de código para ver como as propriedades e os atributos alteram o comportamento do componente.

Propriedades e atributos

Pode utilizar vários atributos para alterar o comportamento do componente. Os atributos necessários são query-string e entity-types.

Atributo Propriedade Descrição
cadeia de consulta queryString A consulta a enviar para o Microsoft Search.
entity-types entityTypes Um ou mais tipos de recursos esperados na resposta. Os valores possíveis são: list, site, listItem, message, event, drive, driveItem, person, externalItem, acronym, bookmark, chatMessage. A predefinição é driveItem, listItem, site.
origens de conteúdo contentSources Origens de conteúdo a utilizar com itens externos.
paging-max pagingMax O número máximo de páginas a clicar no controlo de paginação. O padrão é 7.
query-template queryTemplate Modelo de consulta a utilizar em cenários de pesquisa complexos. Atualmente, os modelos de consulta são suportados apenas no ponto final beta.
obtenção-miniatura fetchThumbnail Define se a miniatura do resultado deve ser obtida a partir do Microsoft Graph. O padrão é false.
enable-top-results enableTopResults Isto aciona a ordenação híbrida para mensagens: as três primeiras mensagens são as mais relevantes. Esta propriedade só é aplicável a entityType=message. O padrão é false.
escopos escopos Matriz opcional de cadeias se utilizar a propriedade ou um âmbito delimitado por vírgulas se utilizar o atributo . O componente utiliza estes âmbitos (com um fornecedor suportado) para garantir que o utilizador consente a permissão certa.
size size O tamanho da página a obter. O valor máximo é 1000. O padrão é 10.
campos campos Contém os campos a serem devolvidos para cada recurso.
versão versão Versão opcional da API a utilizar ao fazer o pedido. O padrão é v1.0.
com cache ativada cacheEnabled Booleano opcional. Quando definido, indica que a resposta do recurso é colocada em cache. Substitua se refresh() for chamado ou se pollingRate estiver a ser utilizado. O padrão é false.
cache-invalidation-period cacheInvalidationPeriod Número opcional de milissegundos. Quando definido em combinação com cacheEnabled, o atraso antes de a cache atingir o respetivo período de invalidação é modificado por este valor. A predefinição é 30000 e utiliza o período de invalidação predefinido.
N/D erro Erro só de leitura do Microsoft Graph se o pedido não tiver sido bem-sucedido.

Propriedades personalizadas do CSS

O mgt-search-results componente define as seguintes propriedades personalizadas do CSS.

<mgt-search-results
  class="search-results"
  query-string="contoso"
  entity-types="driveItem"
></mgt-search-results>

.search-results {
  --answer-border-radius: 10px;
  --answer-box-shadow: 0px 2px 30px pink;
  --answer-border: dotted 2px white;
  --answer-padding: 8px 0px;
}

Para saber mais, veja Componentes de estilo.

Métodos

Método Descrição
refresh(force?: booleano) Chame o método para atualizar os dados. Por predefinição, a IU só é atualizada se os dados forem alterados. Passe true para forçar a atualização do componente.

Eventos

Evento Quando é emitido Dados personalizados Cancelável Bolhas Funciona com um modelo personalizado
dataChange Acionado após o componente carregar os dados. { response: any, error: any }. A response propriedade contém a resposta obtida do Microsoft Graph. A error propriedade contém informações sobre o erro, caso tenha ocorrido um. Não Não Sim

Para obter mais informações sobre o processamento de eventos, veja eventos.

Modelos

O mgt-search-results componente suporta vários modelos que pode utilizar para definir o aspeto e funcionalidade. Para especificar um modelo, inclua um <template> elemento dentro de um componente e defina como data-type um dos seguintes valores.

Tipo de dados Contexto de dados Descrição
Padrão. A resposta do Microsoft Graph. A predefinição pode ser utilizada para compor toda a resposta proveniente do Microsoft Graph.
result-* Item de dados da matriz devolvida value Utilize o result-* modelo em vez do default modelo quando espera que a resposta do gráfico contenha uma matriz de itens. O result-* modelo é repetido automaticamente para cada item devolvido pelo recurso. O result-* modelo começa a compor os itens assim que estiverem prontos (ao contrário do modelo predefinido). Pode ter vários result-* modelos, um por entityType (Veja o disponível entity-type em propriedades e atributos)
erro O erro do Microsoft Graph. Este modelo é utilizado se ocorrer um erro ao fazer o pedido.
a carregar N/D Este modelo é utilizado enquanto o pedido está a ser feito.
sem dados N/D Este modelo é utilizado quando o pedido não devolveu dados.

Permissões do Microsoft Graph

As permissões exigidas por este componente dependem dos dados que pretende obter com o mesmo a partir do Microsoft Graph. Para obter mais informações sobre permissões, consulte Utilizar a API de Pesquisa da Microsoft para consultar dados.

Subcomponentes

O mgt-search-results componente é composto por um ou mais subcomponentes que podem exigir outras permissões do que as necessárias para este componente. Para obter mais informações, veja a documentação de cada subcomponente:

Autenticação

O controlo utiliza o fornecedor de autenticação global descrito na documentação de autenticação para obter os dados necessários.

Cache

Para ativar e configurar a cache, utilize as cacheEnabled propriedades e cacheInvalidationPeriod . Por predefinição, o mgt-search-results componente não coloca em cache quaisquer respostas.

Arquivo de objetos Dados em cache Comentários
response Resposta completa obtida do Microsoft Graph para a consulta executada pelo mgt-search-results

Para obter mais informações, veja Colocação em cache.

Localização

O controlo expõe as seguintes variáveis que podem ser localizadas. Para obter detalhes sobre como configurar a localização, veja Localizar componentes.

Nome da cadeia Valor padrão
modificado modified on
Voltar Back
next Next
páginas pages
page Page
  • Last updated on