Componente de resultados da pesquisa no Microsoft Graph Toolkit

Cuidado

O Microsoft Graph Toolkit foi preterido. O período de aposentadoria começa em 1º de setembro de 2025, com aposentadoria total planejada para 28 de agosto de 2026. Os desenvolvedores devem migrar para o uso dos SDKs do Microsoft Graph ou outras ferramentas do Microsoft Graph com suporte para criar experiências na Web. Para obter mais informações, consulte o anúncio de substituição.

Você pode usar mgt-search-results para fazer consultas de pesquisa para o Microsoft Graph diretamente em seu HTML. O componente fornece algumas renderizações de tipo de resultado padrão, mas também oferece personalização completa dos modelos.

Exemplo

O exemplo a seguir mostra o uso do mgt-search-results componente para os documentos mais relevantes. Você pode usar o editor de código para ver como as propriedades e os atributos alteram o comportamento do componente.

Propriedades e atributos

Você pode usar 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 caracteres de consulta queryString A consulta a ser enviada à Pesquisa da Microsoft.
tipos de entidade 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. O padrão é driveItem, listItem, . site
fontes de conteúdo contentSources Fontes de conteúdo para usar com itens externos.
paging-max pagingMax O número máximo de páginas a serem clicáveis no controle de paginação. O padrão é 7.
modelo de consulta queryTemplate Modelo de consulta para usar em cenários de pesquisa complexos. Atualmente, há suporte para modelos de consulta apenas no ponto de extremidade beta.
fetch-thumbnail fetchThumbnail Define se a miniatura do resultado deve ser buscada no Microsoft Graph. O padrão é false.
Habilitar resultados superiores enableTopResults Isso dispara a classificaçã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 de caracteres, se usar a propriedade, ou um escopo delimitado por vírgula, se estiver usando o atributo. O componente usa esses escopos (com um provedor com suporte) para garantir que o usuário dê consentimento à permissão correta.
size size O tamanho da página a ser recuperada. O valor máximo é 1000. O padrão é 10.
campos campos Contém os campos a serem retornados para cada recurso.
versão versão Versão de API opcional a ser usada ao fazer a solicitação. O padrão é v1.0.
habilitado para cache cacheEnabled Booleano opcional. Quando definido, indica que a resposta do recurso está armazenada em cache. Substitua se refresh() for chamado ou se pollingRate estiver em uso. O padrão é false.
período de invalidação de cache cacheInvalidationPeriod Número opcional de milissegundos. Quando definido em combinação com cacheEnabled, o atraso antes que o cache atinja seu período de invalidação é modificado por esse valor. O padrão é 30000 e usa o período de invalidação padrão.
N/D erro Erro somente leitura do Microsoft Graph se a solicitação não tiver sido bem-sucedida.

Propriedades personalizadas CSS

O mgt-search-results componente define as seguintes propriedades personalizadas 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, consulte Componentes de estilo.

Métodos

Método Descrição
refresh(force?: boolean) Chame o método para atualizar os dados. Por padrão, a interface do usuário só será 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 modelo personalizado
dataChange Acionado após o componente carregar seus dados. { response: any, error: any }. A response propriedade contém a resposta recuperada do Microsoft Graph. A error propriedade contém informações sobre o erro, se houver. Não Não Sim

Para obter mais informações sobre como lidar com eventos, consulte eventos.

Modelos

O mgt-search-results componente oferece suporte a vários modelos que você pode usar para definir a aparência. 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. O padrão pode ser usado para renderizar toda a resposta proveniente do Microsoft Graph.
resultado-* Item de dados da matriz retornada value Use o result-* modelo em vez do default modelo quando esperar que a resposta do gráfico contenha uma matriz de itens. O result-* modelo é repetido automaticamente para cada item retornado pelo recurso. O result-* modelo começa a renderizar os itens assim que eles estão prontos (ao contrário do modelo padrão). Você 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. Esse modelo será usado se houver um erro ao fazer a solicitação.
carregando N/D Este modelo é usado enquanto a solicitação está sendo feita.
sem dados N/D Este modelo é usado quando a solicitação não retorna dados.

Permissões do Microsoft Graph

As permissões exigidas por este componente dependem dos dados que você deseja recuperar com ele do Microsoft Graph. Para obter mais informações sobre permissões, consulte Usar a API de Pesquisa da Microsoft para consultar dados.

Subcomponentes

O mgt-search-results componente consiste em um ou mais subcomponentes que podem exigir outras permissões além das necessárias para este componente. Para obter mais informações, consulte a documentação de cada subcomponente:

Autenticação

O controle usa o provedor de autenticação global descrito na documentação de autenticação para buscar os dados necessários.

Cache

Para habilitar e configurar o cache, use as cacheEnabled propriedades and cacheInvalidationPeriod . Por padrão, o mgt-search-results componente não armazena nenhuma resposta em cache.

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

Para obter mais informações, consulte Cache.

Localização

O controle expõe as variáveis a seguir que podem ser localizadas. Para obter detalhes sobre como configurar a localização, consulte Localizando componentes.

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