Type de ressource outlookCategory

  • Article

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Attention

Les applications existantes qui utilisent cette fonctionnalité avec les tâches Outlook doivent être mises à jour, car les tâches Outlook sont déconseillées. Pour plus d’informations, consultez API To Do en préversion publique .

Représente une catégorie sous laquelle un utilisateur peut regrouper des éléments Outlook tels que des messages et des événements. Dans Outlook, l’utilisateur définit des catégories dans une liste master et peut appliquer une ou plusieurs de ces catégories définies par l’utilisateur à un élément.

Avec l’API REST, vous pouvez créer et définir des catégories dans la liste principale des catégories pour un utilisateur. 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. 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. Les ressources qui peuvent être affectées à des catégories incluent contact, événement, message, outlookTask, post et todoTask.

Deux propriétés sont affectées à chaque catégorie : displayName et color. La valeur displayName doit être unique dans la liste principale d’un utilisateur. 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. Vous pouvez mapper jusqu’à 25 couleurs différentes aux catégories dans la liste principale d’un utilisateur.

Méthodes

Méthode Type renvoyé Description
List categories Collection outlookCategory Obtenez toutes les catégories qui ont été définies pour l’utilisateur.
Get category outlookCategory Obtenez les propriétés et les relations de l’objet outlookCategory spécifié.
Create outlookCategory Créez un objet outlookCategory dans la liste principale des catégories de l’utilisateur.
Update outlookCategory Mettez à jour la propriété accessible en écriture, color, de l’objet outlookCategory spécifié.
Delete Aucun Supprimez l’objet outlookCategory spécifié.

Propriétés

Propriété Type Description
color String 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. Pour plus d’informations, consultez la note suivante.
displayName String Nom unique qui identifie une catégorie dans la boîte aux lettres de l’utilisateur. Après la création d’une catégorie, le nom ne peut pas être modifié. En lecture seule.

Remarque : les valeurs possibles pour color sont des constantes prédéfinies comme None, preset0 et 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. Le tableau suivant indique les couleurs mappées à chaque constante prédéfinie pour Outlook (client de bureau).

Constante prédéfinie Couleur mappée dans Outlook
Aucun Aucune couleur mappée
Preset0 Rouge
Preset1 Orange
Preset2 Marron
Preset3 Jaune
Preset4 Vert
Preset5 Bleu-vert
Preset6 Olive
Preset7 Bleu
Preset8 Violet
Preset9 Couleur canneberge
Preset10 Gris acier
Preset11 Acier foncé
Preset12 Gris
Preset13 Gris foncé
Preset14 Noir
Preset15 Rouge foncé
Preset16 Orange foncé
Preset17 Marron foncé
Preset18 Jaune foncé
Preset19 Vert foncé
Preset20 Bleu-vert foncé
Preset21 Olive foncé
Preset22 Bleu foncé
Preset23 Violet foncé
Preset24 Couleur canneberge foncé

Représentation JSON

Voici une représentation JSON de la ressource.

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