Search Ergebniskomponente im Microsoft Graph-Toolkit
Sie können verwenden mgt-search-results , um Suchabfragen direkt in Ihrem HTML-Code an Microsoft Graph zu senden. Die Komponente bietet einige Standardergebnistyprenderings, bietet aber auch eine vollständige Anpassung der Vorlagen.
Beispiel
Das folgende Beispiel zeigt die Verwendung der mgt-search-results -Komponente für die relevantesten Dokumente. 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. Die erforderlichen Attribute sind query-string und entity-types.
| Attribut | Eigenschaft | Beschreibung |
|---|---|---|
| query-string | Querystring | Die Abfrage, die an Microsoft Search gesendet werden soll. |
| Entitätstypen | entityTypes | Mindestens ein Ressourcentyp, der in der Antwort erwartet wird. Mögliche Werte sind: list, site, listItem, message, event, drive, driveItem, person, externalItem, akronym, bookmark, chatMessage. Der Standardwert ist driveItem, listItem, site. |
| content-sources | contentSources | Inhaltsquellen, die mit externen Elementen verwendet werden sollen. |
| paging-max | pagingMax | Die maximale Anzahl von Seiten, auf die im Paging-Steuerelement geklickt werden soll. Der Standardwert ist 7. |
| query-template | queryTemplate | Abfragevorlage, die in komplexen Suchszenarien verwendet werden soll. Abfragevorlagen werden derzeit nur auf dem Betaendpunkt unterstützt. |
| fetch-thumbnail | fetchThumbnail | Legt fest, ob die Miniaturansicht des Ergebnisses aus Microsoft Graph abgerufen werden soll. Der Standardwert ist false. |
| enable-top-results | enableTopResults | Dadurch wird eine Hybridsortierung für Nachrichten ausgelöst: Die ersten drei Nachrichten sind die relevantesten. Diese Eigenschaft gilt nur für entityType=message. Der Standardwert ist false. |
| Bereiche | Bereiche | Optionales Array von Zeichenfolgen bei Verwendung der -Eigenschaft oder eines durch Kommas getrennten Bereichs bei Verwendung des -Attributs. Die Komponente verwendet diese Bereiche (mit einem unterstützten Anbieter), um sicherzustellen, dass der Benutzer der richtigen Berechtigung zustimmt. |
| size | size | Die Größe der abzurufenden Seite. Der Maximalwert ist 1000. Der Standardwert ist 10. |
| fields | fields | Enthält die Felder, die für jede Ressource zurückgegeben werden sollen. |
| Version | Version | Optionale API-Version, die bei der Anforderung verwendet werden soll. Der Standardwert ist v1.0. |
| 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. Wenn in Kombination mit cacheEnabledfestgelegt wird, wird die Verzögerung, bevor der Cache seinen Ungültigkeitszeitraum erreicht, durch diesen Wert geändert. Der Standardwert ist 30000 und verwendet den Standardvalidierungszeitraum. |
| Nicht zutreffend | error | Schreibgeschützter Fehler von Microsoft Graph, wenn die Anforderung nicht erfolgreich war. |
Benutzerdefinierte CSS-Eigenschaften
Die mgt-search-results Komponente definiert die folgenden benutzerdefinierten CSS-Eigenschaften.
<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;
}
Weitere Informationen finden Sie unter Formatieren von Komponenten.
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 zu dem Fehler, falls ein Fehler aufgetreten ist. |
Nein | Nein | Ja |
Weitere Informationen zum Behandeln von Ereignissen finden Sie unter Ereignisse.
Vorlagen
Die mgt-search-results 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 Standardeinstellung kann verwendet werden, um die gesamte Antwort von Microsoft Graph zu rendern. |
| Ergebnis-* | Datenelement aus dem zurückgegebenen value Array |
Verwenden Sie die result-* Vorlage anstelle der default Vorlage, wenn Sie erwarten, dass die Antwort des Graphen ein Array von Elementen enthält. Die result-* Vorlage wird automatisch für jedes Element wiederholt, das von der Ressource zurückgegeben wird. Die result-* Vorlage beginnt mit dem Rendern der Elemente, sobald sie bereit sind (im Gegensatz zur Standardvorlage). Sie können mehrere result-* Vorlagen verwenden, eine pro entityType (siehe verfügbare entity-type in Eigenschaften und Attributen). |
| 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. Weitere Informationen zu Berechtigungen finden Sie unter Verwenden der Microsoft Search-API zum Abfragen von Daten.
Unterkomponenten
Die mgt-search-results Komponente besteht aus einem oder mehreren Unterkomponenten, die möglicherweise andere Als die für diese Komponente erforderlichen Berechtigungen erfordern. Weitere Informationen finden Sie in der Dokumentation zu den einzelnen Unterkomponenten:
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-search-results Komponente keine Antworten zwischen.
| Objektspeicher | Zwischengespeicherte Daten | Bemerkungen |
|---|---|---|
response |
Vollständige Antwort, die von Microsoft Graph für die Von ausgeführte Abfrage abgerufen wurde mgt-search-results |
Weitere Informationen finden Sie unter Zwischenspeichern.
Lokalisierung
Das -Steuerelement macht die folgenden Variablen verfügbar, die lokalisiert werden können. Ausführliche Informationen zum Einrichten der Lokalisierung finden Sie unter Lokalisieren von Komponenten.
| Zeichenfolgenname | Standardwert |
|---|---|
| geändert | modified on |
| Zurück | Back |
| next | Next |
| Seiten | pages |
| Seite | Page |