Pesquisa componente de resultados no Microsoft Graph Toolkit

Artigo
11/07/2024

Você pode usar mgt-search-results para fazer consultas de pesquisa no 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 propriedades e atributos alteram o comportamento do componente.

HTML
React

Abra este exemplo no mgt.dev.

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 para a Microsoft Pesquisa.
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 a serem usadas com itens externos.
paging-max	pagingMax	O número máximo de páginas a serem clicadas no controle de paginação. O padrão é `7`.
modelo de consulta	queryTemplate	Modelo de consulta a ser usado 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 do Microsoft Graph. O padrão é `false`.
enable-top-results	enableTopResults	Isso dispara a classificação híbrida para mensagens: as três primeiras mensagens são as mais relevantes. Essa propriedade só é aplicável a `entityType=message`. O padrão é `false`.
escopos	escopos	Matriz opcional de cadeias de caracteres se estiver usando 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 consenta com a permissão certa.
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 opcional da API a ser usada ao fazer a solicitação. O padrão é `v1.0`.
Habilitado para cache	cacheEnabled	Booliano opcional. Quando definido, ele indica que a resposta do recurso é armazenada em cache. Substitua se `refresh()` for chamado ou se `pollingRate` estiver em uso. O padrão é `false`.
cache-invalidation-period	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 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, confira componentes de estilo.

Métodos

Método	Descrição
refresh(force?: booleano)	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 o componente a ser atualizado.

Eventos

Evento	Quando ele é emitido	Dados personalizados	Cancelável	Bolhas	Funciona com modelo personalizado
`dataChange`	Acionado depois que o componente carregou 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 ocorreu um.	Não	Não	Sim

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

Modelos

O mgt-search-results componente dá suporte a vários modelos que você pode usar para definir a aparência e a aparência. Para especificar um modelo, inclua um <template> elemento dentro de um componente e defina o data-type como um dos valores a seguir.

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 ao esperar que a resposta do grafo 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 estiverem prontos (ao contrário do modelo padrão). Você pode ter vários `result-` modelos, um por `entityType` (Consulte 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.
Carregar	N/D	Esse modelo é usado enquanto a solicitação está sendo feita.
sem dados	N/D	Esse modelo é usado quando a solicitação não retorna dados.

Permissões do Microsoft Graph

As permissões necessárias por esse 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 do Microsoft Pesquisa para consultar dados.

Subcomponentes

O mgt-search-results componente consiste em um ou mais subcomponentes que podem exigir outras permissões do que as necessárias para esse componente. Para obter mais informações, confira 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 e cacheInvalidationPeriod . Por padrão, o mgt-search-results componente não armazena em cache respostas.

Repositório de objetos	Dados armazenados em cache	Comentários
`response`	Resposta completa recuperada do Microsoft Graph para a consulta executada por `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, confira Localizando componentes.

Nome da cadeia de caracteres	Valor padrão
modificado	`modified on`
Voltar	`Back`
next	`Next`
páginas	`pages`
page	`Page`

Partilhar via