Type de ressource outlookCategoryoutlookCategory resource type

Espace de noms: microsoft.graphNamespace: microsoft.graph

Représente une catégorie sous laquelle un utilisateur peut regrouper des éléments Outlook tels que des messages et des événements.Represents a category by which a user can group Outlook items such as messages and events. L’utilisateur définit des catégories dans une liste principale et peut appliquer ces catégories définies par l’utilisateur à un élément.The user defines categories in a master list, and can apply one or more of these user-defined categories to an item.

Avec l’API REST, vous pouvez créer et définir des catégories dans la liste principale des catégories pour un utilisateur.Using the REST API, you can create and define categories in the master list of categories for a user. Vous pouvez également obtenir cette liste principale des catégories, obtenir une catégorie spécifique, mettre à jour la couleur associée à une catégorie ou supprimerune catégorie.You can also get this master list of categories, get a specific category, update the color associated with a category, or delete a category. Vous pouvez appliquer une catégorie à un élément en affectant la propriété displayName de la catégorie à la collection categories de l’élément.You can apply a category to an item by assigning the displayName property of the category to the categories collection of the item. Les ressources auxquelles vous pouvez affecter des catégories incluent contact, event, message et post.Resources that can be assigned categories include contact, event, message, and post.

Deux propriétés sont affectées à chaque catégorie : displayName et color.Each category is attributed by 2 properties: displayName and color. La valeur displayName doit être unique dans la liste principale d’un utilisateur.The displayName value must be unique in a user's master list. En revanche, la propriété color ne doit pas obligatoirement être unique. Plusieurs catégories de la liste principale peuvent être mappées à la même couleur.The color however does not have to be unique; multiple categories in the master list can be mapped to the same color. Vous pouvez mapper jusqu’à 25 couleurs différentes aux catégories dans la liste principale d’un utilisateur.You can map up to 25 different colors to categories in a user's master list.

PropriétésProperties

PropriétéProperty TypeType DescriptionDescription
displayNamedisplayName ChaîneString Nom unique qui identifie une catégorie dans la boîte aux lettres de l’utilisateur.A unique name that identifies a category in the user's mailbox. Après la création d’une catégorie, le nom ne peut pas être modifié.After a category is created, the name cannot be changed. En lecture seule.Read-only.
colorcolor categoryColorcategoryColor Constante de couleur prédéfinie qui caractérise une catégorie et qui est mappée avec l’une des 25 couleurs prédéfinies.A pre-set color constant that characterizes a category, and that is mapped to one of 25 predefined colors. Voir la remarque ci-dessous.See the note below.

Remarque : les valeurs possibles pour color sont des constantes prédéfinies comme None, preset0 et preset1.Note The possible values for color are pre-set constants such as None, preset0 and preset1. Chaque constante prédéfinie est mappée à une couleur. La couleur réelle varie selon le client Outlook où les catégories sont affichées.Each pre-set constant is further mapped to a color; the actual color is dependent on the Outlook client that the categories are being displayed in. Le tableau suivant indique les couleurs mappées à chaque constante prédéfinie pour Outlook (client de bureau).The following table shows the colors mapped to each pre-set constant for Outlook (desktop client).

Constante prédéfiniePre-set constant Couleur mappée dans OutlookColor mapped to in Outlook
AucunNone Aucune couleur mappéeNo color mapped
Preset0Preset0 RougeRed
Preset1Preset1 OrangeOrange
Preset2Preset2 MarronBrown
Preset3Preset3 JauneYellow
Preset4Preset4 VertGreen
Preset5Preset5 Bleu-vertTeal
Preset6Preset6 OliveOlive
Preset7Preset7 BleuBlue
Preset8Preset8 VioletPurple
Preset9Preset9 Couleur cannebergeCranberry
Preset10Preset10 Gris acierSteel
Preset11Preset11 Acier foncéDarkSteel
Preset12Preset12 GrisGray
Preset13Preset13 Gris foncéDarkGray
Preset14Preset14 NoirBlack
Preset15Preset15 Rouge foncéDarkRed
Preset16Preset16 Orange foncéDarkOrange
Preset17Preset17 Marron foncéDarkBrown
Preset18Preset18 Jaune foncéDarkYellow
Preset19Preset19 Vert foncéDarkGreen
Preset20Preset20 Bleu-vert foncéDarkTeal
Preset21Preset21 Olive foncéDarkOlive
Preset22Preset22 Bleu foncéDarkBlue
Preset23Preset23 Violet foncéDarkPurple
Preset24Preset24 Couleur canneberge foncéDarkCranberry

Représentation JSONJSON representation

Voici une représentation JSON de la ressource.Here is a JSON representation of the resource.

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

MéthodesMethods

MéthodeMethod Type renvoyéReturn Type DescriptionDescription
List categoriesList categories Collection outlookCategoryoutlookCategory collection Obtenez toutes les catégories qui ont été définies pour l’utilisateur.Get all the categories that have been defined for the user.
Get categoryGet category outlookCategoryoutlookCategory Obtenez les propriétés et les relations de l’objet outlookCategory spécifié.Get the properties and relationships of the specified outlookCategory object.
CreateCreate outlookCategoryoutlookCategory Créez un objet outlookCategory dans la liste principale des catégories de l’utilisateur.Create an outlookCategory object in the user's master list of categories.
UpdateUpdate outlookCategoryoutlookCategory Mettez à jour la propriété accessible en écriture, color, de l’objet outlookCategory spécifié.Update the writable property, color, of the specified outlookCategory object.
SupprimerDelete AucunNone Supprimez l’objet outlookCategory spécifié.Delete the specified outlookCategory object.