Obtenir un composant dans le Kit de ressources Microsoft Graph
Vous pouvez utiliser mgt-get pour effectuer n’importe quelle requête GET à partir de Microsoft Graph directement dans votre code HTML. Le composant ne fournit pas d’interface utilisateur par défaut et nécessite l’écriture d’un modèle.
Exemple
L’exemple suivant montre l’utilisation du composant pour afficher les mgt-get e-mails d’un utilisateur. Vous pouvez utiliser l’éditeur de code pour voir comment les propriétés et les attributs modifient le comportement du composant.
Propriétés et attributs
Vous pouvez utiliser plusieurs attributs pour modifier le comportement du composant. Le seul attribut requis est resource.
| Attribut | Propriété | Description |
|---|---|---|
| ressource | ressource | Ressource à obtenir à partir de Microsoft Graph (par exemple, /me). |
| 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 et un fournisseur pris en charge garantissent que l’utilisateur consent à au moins l’une des autorisations fournies. |
| version | version | Version d’API facultative à utiliser lors de la GET requête. La valeur par défaut est v1.0. |
| max-pages | maxPages | Nombre de pages facultatif (pour les ressources qui prennent en charge la pagination). La valeur par défaut est 3. La définition de cette valeur sur 0 permet de récupérer toutes les pages. |
| taux d’interrogation | pollingRate | Nombre facultatif de millisecondes. Lorsqu’il est défini, le composant interroge l’URI de la demande pour les mises à jour dans l’intervalle défini. Si vous utilisez une requête delta, l’interrogation interroge toujours l’API delta. Le modèle s’actualise uniquement lorsque les données changent. |
| 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 modifie la valeur. La valeur par défaut est 0 et utilise la période d’invalidation par défaut. |
| type | type | Type facultatif de la réponse attendue. La valeur par défaut est json. Prend en charge json ou image (être pris en charge uniquement sur les points de terminaison se terminant par /photo/value$). |
| S/O | réponse | Réponse en lecture seule de Microsoft Graph si la demande a réussi. |
| S/O | error | Erreur en lecture seule de Microsoft Graph si la demande n’a pas réussi. |
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 |
Conseil
Pour plus d’informations sur les données retournées dans la response propriété, consultez la référence d’API de l’API que vous avez utilisée dans la resource propriété du composant Get.
Pour plus d’informations sur la gestion des événements, consultez événements.
Modèles
Le mgt-get 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. | Le modèle par défaut est requis pour afficher les données provenant de Microsoft Graph. |
| valeur | Élément de données du tableau retourné value |
Utilisez le modèle à la value place du default modèle lorsque vous attendez que la réponse du graphique contienne un tableau d’éléments, tels que des messages, des fichiers ou des utilisateurs. Le value modèle est automatiquement répété pour chaque élément retourné par la ressource. Le value modèle commence également à afficher les éléments dès qu’ils sont prêts (contrairement au modèle par défaut). |
| 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. Microsoft Graph Toolkit vérifie que l’utilisateur actuel a consenti à au moins l’un des éléments fournis scopes. Pour plus d’informations sur les autorisations, consultez Informations de référence sur les autorisations Microsoft Graph.
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-get 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 spécifiée dans la resource propriété de mgt-get |
Pour plus d’informations, consultez Mise en cache.
Localisation
Le contrôle n’expose aucune variable de localisation.