Freigeben über

Abrufen der Komponente im Microsoft Graph-Toolkit

  • Artikel

Sie können verwenden mgt-get , um jede GET-Abfrage aus Microsoft Graph direkt in Ihrem HTML-Code zu erstellen. Die Komponente stellt keine Standard-Ui bereit und erfordert, dass Sie eine Vorlage schreiben.

Beispiel

Das folgende Beispiel zeigt die Verwendung der -Komponente zum Anzeigen der mgt-get E-Mails eines Benutzers. Sie können den Code-Editor verwenden, um zu sehen, wie Eigenschaften und Attribute das Verhalten der Komponente ändern.

Eigenschaften und Attribute

Sie können mehrere Attribute verwenden, um das Verhalten der Komponente zu ändern. Das einzige erforderliche Attribut ist resource.

Attribut Eigenschaft Beschreibung
resource resource Die Ressource, /medie von Microsoft Graph abgerufen werden soll (z. B. ).
Bereiche Bereiche Optionales Array von Zeichenfolgen bei Verwendung der -Eigenschaft oder eines durch Trennzeichen getrennten Bereichs bei Verwendung des -Attributs. Die Komponente und ein unterstützter Anbieter stellen sicher, dass der Benutzer mindestens einer der bereitgestellten Berechtigungen zustimmt.
Version Version Optionale API-Version, die bei der GET Anforderung verwendet werden soll. Der Standardwert ist v1.0.
max-pages maxPages Optionale Anzahl von Seiten (für Ressourcen, die Paging unterstützen). Der Standardwert ist 3. Wenn Sie diesen Wert auf 0 festlegen, werden alle Seiten abgerufen.
Abrufrate pollingRate Optionale Anzahl von Millisekunden. Wenn festgelegt, fragt die Komponente den Anforderungs-URI für Updates im definierten Intervall ab. Bei Verwendung einer Delta-Abfrage wird beim Abfragen immer die Delta-API abfragt. Die Vorlage wird nur aktualisiert, wenn sich die Daten ändern.
Cache aktiviert cacheEnabled Optionaler Boolean-Wert. Wenn festgelegt, gibt dies an, dass die Antwort von der Ressource zwischengespeichert wird. Überschreiben Sie, wenn refresh() aufgerufen wird oder verwendet pollingRate wird. Der Standardwert ist false.
Cache-Invalidation-Zeitraum cacheInvalidationPeriod Optionale Anzahl von Millisekunden. Bei Festlegung in Kombination mit cacheEnabledändert die Verzögerung, bevor der Cache seinen Ungültigkeitszeitraum erreicht hat, den Wert. Der Standardwert ist 0 und verwendet den Standardvalidierungszeitraum.
type type Optionaler Typ der erwarteten Antwort. Der Standardwert ist json. Unterstützt json oder image (wird nur auf Endpunkten unterstützt, die auf /photo/value$enden).
Nicht zutreffend Antwort Schreibgeschützte Antwort von Microsoft Graph, wenn die Anforderung erfolgreich war.
Nicht zutreffend error Schreibgeschützter Fehler von Microsoft Graph, wenn die Anforderung nicht erfolgreich war.

Methoden

Methode Beschreibung
refresh(force?: boolean) Rufen Sie die -Methode auf, um die Daten zu aktualisieren. Standardmäßig wird die Benutzeroberfläche nur aktualisiert, wenn sich die Daten ändern. Übergeben, true um die Aktualisierung der Komponente zu erzwingen.

Ereignisse

Ereignis Wann wird es ausgegeben? Benutzerdefinierte Daten Abbrechbare Blasen Funktioniert mit benutzerdefinierter Vorlage
dataChange Wird ausgelöst, nachdem die Komponente ihre Daten geladen hat. { response: any, error: any }. Die response -Eigenschaft enthält die antwort, die von Microsoft Graph abgerufen wurde. Die error -Eigenschaft enthält Informationen zum Fehler, falls ein Fehler aufgetreten ist. Nein Nein Ja

Tipp

Weitere Informationen zu den in der response Eigenschaft zurückgegebenen Daten finden Sie in der API-Referenz der API, die Sie in der resource -Eigenschaft der Get-Komponente verwendet haben.

Weitere Informationen zum Behandeln von Ereignissen finden Sie unter Ereignisse.

Vorlagen

Die mgt-get Komponente unterstützt mehrere Vorlagen , mit denen Sie das Aussehen und Verhalten definieren können. Um eine Vorlage anzugeben, schließen Sie ein <template> Element in eine Komponente ein, und legen Sie auf data-type einen der folgenden Werte fest.

Datentyp Datenkontext Beschreibung
Standard Die Antwort von Microsoft Graph. Die Standardvorlage ist erforderlich, um die daten aus Microsoft Graph zu rendern.
Wert Datenelement aus dem zurückgegebenen value Array Verwenden Sie die value Vorlage anstelle der default Vorlage, wenn Sie erwarten, dass die Antwort des Graphen ein Array von Elementen enthält , z. B. Nachrichten, Dateien oder Benutzer. Die value Vorlage wird automatisch für jedes Element wiederholt, das von der Ressource zurückgegeben wird. Die value Vorlage beginnt auch mit dem Rendern der Elemente, sobald sie bereit sind (im Gegensatz zur Standardvorlage).
error Der Fehler von Microsoft Graph. Diese Vorlage wird verwendet, wenn bei der Anforderung ein Fehler auftritt.
Laden Nicht zutreffend Diese Vorlage wird während der Anforderung verwendet.
Keine Daten Nicht zutreffend Diese Vorlage wird verwendet, wenn die Anforderung keine Daten zurückgibt.

Microsoft Graph-Berechtigungen

Die für diese Komponente erforderlichen Berechtigungen hängen von den Daten ab, die Sie mit ihr aus Microsoft Graph abrufen möchten. Das Microsoft Graph-Toolkit überprüft, ob der aktuelle Benutzer mindestens einem der bereitgestellten scopeszugestimmt hat. Weitere Informationen zu Berechtigungen finden Sie in der Referenz zu Microsoft Graph-Berechtigungen.

Authentifizierung

Das Steuerelement verwendet den in der Authentifizierungsdokumentation beschriebenen globalen Authentifizierungsanbieter, um die erforderlichen Daten abzurufen.

Cache

Verwenden Sie zum Aktivieren und Konfigurieren des Caches die cacheEnabled Eigenschaften und cacheInvalidationPeriod . Standardmäßig speichert die mgt-get Komponente keine Antworten zwischen.

Objektspeicher Zwischengespeicherte Daten Bemerkungen
response Vollständige Antwort, die von Microsoft Graph für die in der resource -Eigenschaft von angegebene Abfrage abgerufen wurde mgt-get

Weitere Informationen finden Sie unter Zwischenspeichern.

Lokalisierung

Das Steuerelement macht keine Lokalisierungsvariablen verfügbar.