Office.SensitivityLabelsCatalog interface

Paquet:
outlook

Fournit des méthodes pour case activée le status du catalogue d’étiquettes de confidentialité dans Outlook et récupérer toutes les étiquettes de confidentialité disponibles si le catalogue est activé.

Remarques

Jeu d’API : Boîte aux lettres 1.13

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

Mode Outlook applicable : Compose

Important : Pour utiliser la fonctionnalité d’étiquette de confidentialité dans votre complément, vous devez disposer d’un abonnement Microsoft 365 E5.

Pour en savoir plus sur la gestion des étiquettes de confidentialité dans votre complément, voir Gérer l’étiquette de confidentialité de votre message ou rendez-vous en mode de composition.

Utilisateur

Méthodes

getAsync(options, callback)

Obtient toutes les étiquettes de confidentialité activées dans Outlook.
getAsync(callback)

Obtient toutes les étiquettes de confidentialité activées dans Outlook.
getIsEnabledAsync(options, callback)

Vérifie si le catalogue des étiquettes de confidentialité est activé dans Outlook.
getIsEnabledAsync(callback)

Vérifie si le catalogue des étiquettes de confidentialité est activé dans Outlook.

Détails de la méthode

getAsync(options, callback)

Obtient toutes les étiquettes de confidentialité activées dans Outlook.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => 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.SensitivityLabelDetails[]>) => 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, asyncResult, qui est un Office.AsyncResult objet. Les étiquettes de confidentialité disponibles et leurs propriétés sont renvoyées dans la asyncResult.value propriété.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.13

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

Mode Outlook applicable : Compose

Important : Pour utiliser la fonctionnalité d’étiquette de confidentialité dans votre complément, vous devez disposer d’un abonnement Microsoft 365 E5.

Recommandé : Pour déterminer si le catalogue d’étiquettes de confidentialité est activé dans Outlook, appelez getIsEnabledAsync avant d’utiliser getAsync.

Pour en savoir plus sur la gestion des étiquettes de confidentialité dans votre complément, voir Gérer l’étiquette de confidentialité de votre message ou rendez-vous en mode de composition.

getAsync(callback)

Obtient toutes les étiquettes de confidentialité activées dans Outlook.

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

Paramètres

callback

(asyncResult: Office.AsyncResult<Office.SensitivityLabelDetails[]>) => 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, asyncResult, qui est un Office.AsyncResult objet. Les étiquettes de confidentialité disponibles et leurs propriétés sont renvoyées dans la asyncResult.value propriété.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.13

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

Mode Outlook applicable : Compose

Important : Pour utiliser la fonctionnalité d’étiquette de confidentialité dans votre complément, vous devez disposer d’un abonnement Microsoft 365 E5.

Recommandé : Pour déterminer si le catalogue d’étiquettes de confidentialité est activé dans Outlook, appelez getIsEnabledAsync avant d’utiliser getAsync.

Pour en savoir plus sur la gestion des étiquettes de confidentialité dans votre complément, voir Gérer l’étiquette de confidentialité de votre message ou rendez-vous en mode de composition.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-labels-catalog.yaml

// This snippet gets all available sensitivity labels from the catalog.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
    Office.context.sensitivityLabelsCatalog.getAsync((asyncResult) => {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        const catalog = asyncResult.value;
        console.log("Sensitivity Labels Catalog:");
        console.log(JSON.stringify(catalog));
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});

getIsEnabledAsync(options, callback)

Vérifie si le catalogue des étiquettes de confidentialité est activé dans Outlook.

getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => 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<boolean>) => 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, asyncResult, qui est un Office.AsyncResult objet. Le status du catalogue d’étiquettes de confidentialité est renvoyé dans la asyncResult.value propriété.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.13

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

Mode Outlook applicable : Compose

Important : Le catalogue des étiquettes de confidentialité est configuré par l’administrateur d’une organisation. Pour plus d’informations, consultez Prise en main des étiquettes de confidentialité.

Important : Pour utiliser la fonctionnalité d’étiquette de confidentialité dans votre complément, vous devez disposer d’un abonnement Microsoft 365 E5.

Pour en savoir plus sur la gestion des étiquettes de confidentialité dans votre complément, voir Gérer l’étiquette de confidentialité de votre message ou rendez-vous en mode de composition.

getIsEnabledAsync(callback)

Vérifie si le catalogue des étiquettes de confidentialité est activé dans Outlook.

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

Paramètres

callback

(asyncResult: Office.AsyncResult<boolean>) => 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, asyncResult, qui est un Office.AsyncResult objet. Le status du catalogue d’étiquettes de confidentialité est renvoyé dans la asyncResult.value propriété.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.13

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

Mode Outlook applicable : Compose

Important : Le catalogue des étiquettes de confidentialité est configuré par l’administrateur d’une organisation. Pour plus d’informations, consultez Prise en main des étiquettes de confidentialité.

Important : Pour utiliser la fonctionnalité d’étiquette de confidentialité dans votre complément, vous devez disposer d’un abonnement Microsoft 365 E5.

Pour en savoir plus sur la gestion des étiquettes de confidentialité dans votre complément, voir Gérer l’étiquette de confidentialité de votre message ou rendez-vous en mode de composition.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-labels-catalog.yaml

// This snippet determines if the sensitivity labels catalog is enabled on the current mailbox.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log(asyncResult.value);
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});