outlookCategory-Ressourcentyp

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Achtung

Vorhandene Apps, die dieses Feature mit Outlook-Aufgaben verwenden, sollten aktualisiert werden, da Outlook-Aufgaben veraltet sind. Weitere Informationen finden Sie unter To Do-APIs in der öffentlichen Vorschau .

Stellt eine Kategorie dar, anhand der ein Benutzer Outlook-Elemente, z. B. Nachrichten und Ereignisse, gruppieren kann. In Outlook definiert der Benutzer Kategorien in einer master Liste und kann eine oder mehrere dieser benutzerdefinierten Kategorien auf ein Element anwenden.

Mithilfe der REST-API können Sie Kategorien für einen Benutzer in der Masterliste erstellen und definieren. Sie können auch dieser Masterliste mit Kategorien erhalten, eine bestimmte Kategorie abrufen, aktualisieren die Farbe einer Kategorie, oder Löscheneine Kategorie. Sie können eine Kategorie auf ein Element anwenden, indem Sie die displayName-Eigenschaft der Kategorie der categories-Sammlung des Elements zuweisen. Ressourcen, denen Kategorien zugewiesen werden können, sind contact, event, message, outlookTask, post und todoTask.

Jede Kategorie weist zwei Eigenschaften auf: displayName und color. Der Wert displayName muss in der Masterliste eines Benutzers eindeutig sein. Die color-Eigenschaft muss jedoch nicht eindeutig sein; mehrere Kategorien in der Masterliste können derselben Farbe zugeordnet werden. Sie können bis zu 25 verschiedene Farben Kategorien in der Masterliste eines Benutzers zuordnen.

Methoden

Methode Rückgabetyp Beschreibung
Kategorien auflisten outlookCategory-Sammlung Ruft alle Kategorien ab, die für den Benutzer definiert wurden.
Kategorie abrufen outlookCategory Dient zum Abrufen der Eigenschaften und Beziehungen des angegebenen outlookCategory-Objekts.
Erstellen outlookCategory Erstellen eines outlookCategory-Objekts in der Masterliste von Kategorien.
Aktualisieren outlookCategory Aktualisieren Sie die schreibbare Eigenschaft, color, des angegebenen outlookCategory-Objekts.
Löschen Keine Löscht das angegebene outlookCategory-Objekt.

Eigenschaften

Eigenschaft Typ Beschreibung
color Zeichenfolge Eine voreingestellte Konstante, die eine Kategorie charakterisiert und einer von 25 vordefinierten Farben zugeordnet ist. Weitere Informationen finden Sie im folgenden Hinweis.
displayName Zeichenfolge Ein eindeutiger Name, der eine Kategorie im Postfach des Benutzers identifiziert. Nach der Erstellung einer Kategorie kann der Namen nicht geändert werden. Schreibgeschützt.

Hinweis Die möglichen Werte für color sind vordefinierte Konstanten wie None, preset0 und preset1. Jede voreingestellte Konstante ist weiter einer Farbe zugeordnet. Die tatsächliche Farbe ist von dem Outlook-Client abhängig, auf dem die Kategorien angezeigt werden. In der folgenden Tabelle sind die Farben dargestellt, die den einzelnen vordefinierten Konstanten für Outlook (Desktopclient) zugeordnet sind.

Voreingestellte Konstante In Outlook zugeordnete Farbe
Keine Keine Farbe zugeordnet
Preset0 Red
Preset1 Orange
Preset2 Brown
Preset3 Yellow
Preset4 Green
Preset5 Teal
Preset6 Olive
Preset7 Blau
Preset8 Purple
Preset9 Cranberry
Preset10 Steel
Preset11 DarkSteel
Preset12 Gray
Preset13 DarkGray
Preset14 Black
Preset15 DarkRed
Preset16 DarkOrange
Preset17 DarkBrown
Preset18 DarkYellow
Preset19 DarkGreen
Preset20 DarkTeal
Preset21 DarkOlive
Preset22 DarkBlue
Preset23 DarkPurple
Preset24 DarkCranberry

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

{
  "color": "String",
  "displayName": "String"
}