visualInfo-Ressourcentyp

Namespace: microsoft.graph

Ein komplexer Typ zum Darstellen der visualElements-Eigenschaft im Aktivitätsobjekt.

Jede Benutzeraktivität wird in der Zeitachse als adaptive Karte angezeigt. App-Entwicklern wird empfohlen, eine benutzerdefinierte Karte bereitzustellen, die den Kern der Aktivität erfasst, die in Ihrer App stattgefunden hat. Dies ist möglich, indem eine benutzerdefinierte JSON-Karte in der Inhaltseigenschaft bereitgestellt wird.

Zusätzlich zu visuellen Metadaten mit einer adaptiven Karte kann die App Inhaltsmetadaten angeben – Daten, die verwendet werden, um Rückschluss auf die Aktivitäten des Benutzers zu erstellen, um neue Aktivitäten für zukünftiges erneutes Engagement anzubieten. Dies ist möglich, indem die contentInfo-Eigenschaft der Aktivität verwendet wird, um ein JSON-Objekt bereitzustellen, das schema.org Eigenschaften verwendet, um den Inhalt zu beschreiben.

Wenn keine benutzerdefinierte Karte bereitgestellt wird, wird eine einfache Karte mit displayText- und Beschreibungseigenschaften generiert. Benutzerdefinierte Karten werden empfohlen, um die besten Inhalte in Ihrer App zu präsentieren.

Eigenschaften

Name Typ Beschreibung
Displaytext String Erforderlich. Kurze Textbeschreibung der eindeutigen Aktivität des Benutzers (z. B. Dokumentname in Fällen, in denen sich eine Aktivität auf die Dokumenterstellung bezieht)
description Zeichenfolge Optional. Längere Textbeschreibung der eindeutigen Aktivität des Benutzers (Beispiel: Dokumentname, erster Satz und/oder Metadaten)
Backgroundcolor Zeichenfolge Optional. Hintergrundfarbe, die zum Rendern der Aktivität in der Benutzeroberfläche verwendet wird – Markenfarbe für die Anwendungsquelle der Aktivität. Muss eine gültige Hexadezimalfarbe sein
content Untyped JSON-Objekt Optional. Benutzerdefinierte Daten – JSON-Objekt, das zum Bereitstellen von benutzerdefiniertem Inhalt zum Rendern der Aktivität in der Windows Shell-Benutzeroberfläche verwendet wird
Attribution Imageinfo Optional. JSON-Objekt zur Darstellung eines Symbols, das die Anwendung darstellt, die zum Generieren der Aktivität verwendet wird

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

{
    "@odata.type": "microsoft.graph.visualInfo",
    "attribution": {
        "@odata.type": "microsoft.graph.imageInfo",
        "iconUrl": "String (URL)",
        "alternateText": "String",
        "addImageQuery": "boolean"
    },
    "description": "String",
    "backgroundColor": "String",
    "displayText": "String",
    "content": {
        "@odata.type": "microsoft.graph.Json"
    }
}