Office.Categories interface

Représente les catégories d’un article.

Dans Outlook, un utilisateur peut marquer les messages et les rendez-vous à l’aide d’une catégorie pour leur attribuer un code couleur. L’utilisateur définit des catégories dans une liste master sur sa boîte aux lettres. Ils peuvent ensuite appliquer une ou plusieurs catégories à un élément.

Important : Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message en mode Composer.

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Utilisateur

Méthodes

addAsync(categories, options, callback)	Ajoute des catégories à un article. Chaque catégorie doit figurer dans la liste des catégories master de cette boîte aux lettres et doit donc avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur.
addAsync(categories, callback)	Ajoute des catégories à un article. Chaque catégorie doit figurer dans la liste des catégories master de cette boîte aux lettres et doit donc avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur.
getAsync(options, callback)	Obtient les catégories d’un élément. Important: S’il n’y a aucune catégorie sur l’élément, ou un tableau vide sera renvoyé en fonction de la version d’Outlook. `null` Veillez donc à gérer les deux cas. Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message en mode Compose.
getAsync(callback)	Obtient les catégories d’un élément. Important: S’il n’y a aucune catégorie sur l’élément, ou un tableau vide sera renvoyé en fonction de la version d’Outlook. `null` Veillez donc à gérer les deux cas. Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message en mode Compose.
removeAsync(categories, options, callback)	Supprime des catégories d’un élément.
removeAsync(categories, callback)	Supprime des catégories d’un élément.

addAsync(categories, options, callback)

Ajoute des catégories à un article. Chaque catégorie doit figurer dans la liste des catégories master de cette boîte aux lettres et doit donc avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur.

addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

categories: string[]

Catégories à ajouter à l’article.

options: Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback: (asyncResult: Office.AsyncResult<void>) => void

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Rédiger ou Lire

Important : Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message ou un élément de rendez-vous en mode Composer.

Erreurs :

InvalidCategory : des catégories non valides ont été fournies.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const masterCategories = asyncResult.value;
    if (masterCategories && masterCategories.length > 0) {
      // Grab the first category from the master list.
      const categoryToAdd = [masterCategories[0].displayName];
      Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
        } else {
          console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

addAsync(categories, callback)

Ajoute des catégories à un article. Chaque catégorie doit figurer dans la liste des catégories master de cette boîte aux lettres et doit donc avoir un nom unique, mais plusieurs catégories peuvent utiliser la même couleur.

addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

categories: string[]

Catégories à ajouter à l’article.

callback: (asyncResult: Office.AsyncResult<void>) => void

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Rédiger ou Lire

Important : Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message ou un élément de rendez-vous en mode Composer.

Erreurs :

InvalidCategory : des catégories non valides ont été fournies.

getAsync(options, callback)

Obtient les catégories d’un élément.

Important:

S’il n’y a aucune catégorie sur l’élément, ou un tableau vide sera renvoyé en fonction de la version d’Outlook. null Veillez donc à gérer les deux cas.
Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message en mode Compose.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void): void;

Paramètres

options: Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback: (asyncResult: Office.AsyncResult<Office.CategoryDetails[]>) => void

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. Si l’obtention des catégories échoue, la asyncResult.error propriété contient un code d’erreur.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

getAsync(callback)

Obtient les catégories d’un élément.

Important:

S’il n’y a aucune catégorie sur l’élément, ou un tableau vide sera renvoyé en fonction de la version d’Outlook. null Veillez donc à gérer les deux cas.
Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message en mode Compose.

getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void): void;

Paramètres

callback: (asyncResult: Office.AsyncResult<Office.CategoryDetails[]>) => void

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. Si l’obtention des catégories échoue, la asyncResult.error propriété contient un code d’erreur.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Categories assigned to this item:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

removeAsync(categories, options, callback)

Supprime des catégories d’un élément.

removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

categories: string[]

Catégories à supprimer de l’article.

options: Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback: (asyncResult: Office.AsyncResult<void>) => void

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. En cas d’échec de la suppression de catégories, la asyncResult.error propriété contient un code d’erreur.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Rédiger ou Lire

Important : Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message ou un élément de rendez-vous en mode Composer.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      // Grab the first category assigned to this item.
      const categoryToRemove = [categories[0].displayName];
      Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
        } else {
          console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

removeAsync(categories, callback)

Supprime des catégories d’un élément.

removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

categories: string[]

Catégories à supprimer de l’article.

callback: (asyncResult: Office.AsyncResult<void>) => void

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. En cas d’échec de la suppression de catégories, la asyncResult.error propriété contient un code d’erreur.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Rédiger ou Lire

Important : Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories appliquées à un message ou un élément de rendez-vous en mode Composer.

Remarques

Utilisateur

Méthodes

Détails de la méthode

addAsync(categories, options, callback)

Paramètres

Retours

Remarques

Exemples

addAsync(categories, callback)

Paramètres

Retours

Remarques

getAsync(options, callback)

Paramètres

Retours

Remarques

getAsync(callback)

Paramètres

Retours

Remarques

Exemples

removeAsync(categories, options, callback)

Paramètres

Retours

Remarques

Exemples

removeAsync(categories, callback)

Paramètres

Retours

Remarques

Commentaires