Recherche composant résultats dans le Kit de ressources Microsoft Graph

Article
11/07/2024

Vous pouvez utiliser mgt-search-results pour effectuer des requêtes de recherche sur Microsoft Graph directement dans votre code HTML. Le composant fournit des rendus de type de résultat par défaut, mais offre également une personnalisation complète des modèles.

Exemple

L’exemple suivant montre l’utilisation du mgt-search-results composant pour les documents les plus pertinents. Vous pouvez utiliser l’éditeur de code pour voir comment les propriétés et les attributs modifient le comportement du composant.

HTML
React

Ouvrez cet exemple dans mgt.dev.

Propriétés et attributs

Vous pouvez utiliser plusieurs attributs pour modifier le comportement du composant. Les attributs requis sont query-string et entity-types.

Attribut	Propriété	Description
query-string	Querystring	Requête à envoyer à Microsoft Recherche.
entity-types	entityTypes	Un ou plusieurs types de ressources attendus dans la réponse. Les valeurs possibles sont : list, site, listItem, message, event, drive, driveItem, person, externalItem, acronyme, bookmark, chatMessage. La valeur par défaut est `driveItem`, `listItem`, `site`.
content-sources	contentSources	Sources de contenu à utiliser avec des éléments externes.
paging-max	pagingMax	Nombre maximal de pages à cliquer dans le contrôle de pagination. La valeur par défaut est `7`.
modèle de requête	queryTemplate	Modèle de requête à utiliser dans des scénarios de recherche complexes. Les modèles de requête sont actuellement pris en charge uniquement sur le point de terminaison bêta.
fetch-thumbnail	fetchThumbnail	Définit si la miniature du résultat doit être extraite de Microsoft Graph. La valeur par défaut est `false`.
enable-top-results	enableTopResults	Cela déclenche un tri hybride pour les messages : les trois premiers messages sont les plus pertinents. Cette propriété s’applique uniquement à `entityType=message`. La valeur par défaut est `false`.
scopes	scopes	Tableau facultatif de chaînes si vous utilisez la propriété ou une étendue délimitée par des virgules si vous utilisez l’attribut . Le composant utilise ces étendues (avec un fournisseur pris en charge) pour s’assurer que l’utilisateur consent à l’autorisation appropriée.
size	size	Taille de la page à récupérer. La valeur maximale est `1000`. La valeur par défaut est `10`.
fields	fields	Contient les champs à retourner pour chaque ressource.
version	version	Version d’API facultative à utiliser lors de la requête. La valeur par défaut est `v1.0`.
activé pour le cache	cacheEnabled	Facultatif Boolean. Lorsqu’il est défini, il indique que la réponse de la ressource est mise en cache. Remplacez si `refresh()` est appelé ou si `pollingRate` est en cours d’utilisation. La valeur par défaut est `false`.
cache-invalidation-period	cacheInvalidationPeriod	Nombre facultatif de millisecondes. Lorsqu’il est défini en combinaison avec `cacheEnabled`, le délai avant que le cache n’atteigne sa période d’invalidation est modifié par cette valeur. La valeur par défaut est `30000` et utilise la période d’invalidation par défaut.
S/O	error	Erreur en lecture seule de Microsoft Graph si la demande n’a pas réussi.

Propriétés personnalisées CSS

Le mgt-search-results composant définit les propriétés personnalisées CSS suivantes.

<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;
}

Pour en savoir plus, consultez composants de style.

Méthodes

Méthode	Description
refresh(force ?: boolean)	Appelez la méthode pour actualiser les données. Par défaut, l’interface utilisateur est mise à jour uniquement si les données changent. `true` Passez pour forcer la mise à jour du composant.

Événements

Événement	Quand est-il émis	Données personnalisées	Annulable	Bulles	Fonctionne avec un modèle personnalisé
`dataChange`	Déclenché après le chargement de ses données par le composant.	`{ response: any, error: any }`. La `response` propriété contient la réponse récupérée à partir de Microsoft Graph. La `error` propriété contient des informations sur l’erreur si une erreur s’est produite.	Non	Non	Oui

Pour plus d’informations sur la gestion des événements, consultez événements.

Modèles

Le mgt-search-results composant prend en charge plusieurs modèles que vous pouvez utiliser pour définir l’apparence. Pour spécifier un modèle, incluez un <template> élément à l’intérieur d’un composant et définissez sur l’une data-type des valeurs suivantes.

Type de données	Contexte de données	Description
Valeur par défaut.	Réponse de Microsoft Graph.	La valeur par défaut peut être utilisée pour afficher l’intégralité de la réponse provenant de Microsoft Graph.
Résultat-*	Élément de données du tableau retourné `value`	Utilisez le `result-` modèle au lieu du `default` modèle lorsque vous attendez que la réponse du graphe contienne un tableau d’éléments. Le `result-` modèle est automatiquement répété pour chaque élément retourné par la ressource. Le `result-` modèle commence à afficher les éléments dès qu’ils sont prêts (contrairement au modèle par défaut). Vous pouvez avoir plusieurs `result-` modèles, un par `entityType` (voir les propriétés et attributs disponibles`entity-type`)
error	Erreur de Microsoft Graph.	Ce modèle est utilisé en cas d’erreur lors de la demande.
Chargement	S/O	Ce modèle est utilisé pendant que la demande est effectuée.
no-data	S/O	Ce modèle est utilisé lorsque la requête n’a retourné aucune donnée.

Autorisations de Microsoft Graph

Les autorisations requises par ce composant dépendent des données que vous souhaitez récupérer avec lui à partir de Microsoft Graph. Pour plus d’informations sur les autorisations, consultez Utiliser l’API Microsoft Recherche pour interroger des données.

Sous-composants

Le mgt-search-results composant se compose d’un ou plusieurs sous-composants qui peuvent nécessiter d’autres autorisations que celles requises pour ce composant. Pour plus d’informations, consultez la documentation de chaque sous-composant :

Authentification

Le contrôle utilise le fournisseur d’authentification global décrit dans la documentation sur l’authentification pour extraire les données requises.

Cache

Pour activer et configurer le cache, utilisez les cacheEnabled propriétés et cacheInvalidationPeriod . Par défaut, le mgt-search-results composant ne met pas en cache les réponses.

Magasin d’objets	Données mises en cache	Remarques
`response`	Réponse complète récupérée à partir de Microsoft Graph pour la requête exécutée par `mgt-search-results`

Pour plus d’informations, consultez Mise en cache.

Localisation

Le contrôle expose les variables suivantes qui peuvent être localisées. Pour plus d’informations sur la configuration de la localisation, consultez Localisation des composants.

Nom de la chaîne	Valeur par défaut
modifié	`modified on`
Précédent	`Back`
next	`Next`
pages	`pages`
page	`Page`

Partager via