Office.SensitivityLabel interface

  • Référence
Paquet:
outlook

Fournit des méthodes pour obtenir ou définir l’étiquette de confidentialité d’un message ou d’un rendez-vous. Pour plus d’informations sur les étiquettes de confidentialité, consultez En savoir plus sur les étiquettes de confidentialité.

Remarques

[ Ensemble d’API : Boîte aux lettres 1.13 ]

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

Mode Outlook applicable : Composer

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, consultez Gérer l’étiquette de confidentialité de votre message ou rendez-vous en mode composition.

Méthodes

getAsync(options, callback)

Obtient l’identificateur unique (GUID) de l’étiquette de confidentialité appliquée à un message ou un rendez-vous en cours de composition.
getAsync(callback)

Obtient l’identificateur unique (GUID) de l’étiquette de confidentialité appliquée à un message ou un rendez-vous en cours de composition.
setAsync(sensitivityLabel, options, callback)

Applique l’étiquette de confidentialité spécifiée au message ou au rendez-vous en cours de composition.
setAsync(sensitivityLabel, callback)

Applique l’étiquette de confidentialité spécifiée au message ou au rendez-vous en cours de composition.

Détails de la méthode

getAsync(options, callback)

Obtient l’identificateur unique (GUID) de l’étiquette de confidentialité appliquée à un message ou un rendez-vous en cours de composition.

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

Paramètres

options
Office.AsyncContextOptions

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

callback

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

Une fois la méthode 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 GUID de l’étiquette de confidentialité est retourné dans la asyncResult.value propriété .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.13 ]

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

Mode Outlook applicable : Composer

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, consultez Gérer l’étiquette de confidentialité de votre message ou rendez-vous en mode composition.

getAsync(callback)

Obtient l’identificateur unique (GUID) de l’étiquette de confidentialité appliquée à un message ou un rendez-vous en cours de composition.

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

Paramètres

callback

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

Une fois la méthode 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 GUID de l’étiquette de confidentialité est retourné dans la asyncResult.value propriété .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.13 ]

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

Mode Outlook applicable : Composer

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, consultez Gérer l’étiquette de confidentialité de votre message ou rendez-vous en mode composition.

Exemples

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

// This snippet gets the current mail item's sensitivity label.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
    Office.context.mailbox.item.sensitivityLabel.getAsync((asyncResult) => {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        console.log(asyncResult.value);
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});

setAsync(sensitivityLabel, options, callback)

Applique l’étiquette de confidentialité spécifiée au message ou au rendez-vous en cours de composition.

setAsync(sensitivityLabel: string | SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

sensitivityLabel

string | Office.SensitivityLabelDetails

Étiquette de confidentialité à appliquer au message ou au rendez-vous en cours de composition. La valeur du paramètre peut être l’identificateur unique (GUID) d’une étiquette de confidentialité ou un objet SensitivityLabelDetails .

options
Office.AsyncContextOptions

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

callback

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

Facultatif. Une fois la méthode 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 .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.13 ]

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

Mode Outlook applicable : Composer

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

Conseil : Pour déterminer les étiquettes de confidentialité disponibles, appelez la Office.context.sensitivityLabelsCatalog.getAsync méthode .

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

setAsync(sensitivityLabel, callback)

Applique l’étiquette de confidentialité spécifiée au message ou au rendez-vous en cours de composition.

setAsync(sensitivityLabel: string | SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

sensitivityLabel

string | Office.SensitivityLabelDetails

Étiquette de confidentialité à appliquer au message ou au rendez-vous en cours de composition. La valeur du paramètre peut être l’identificateur unique (GUID) d’une étiquette de confidentialité ou un objet SensitivityLabelDetails .

callback

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

Facultatif. Une fois la méthode 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 .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.13 ]

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

Mode Outlook applicable : Composer

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

Conseil : Pour déterminer les étiquettes de confidentialité disponibles, appelez la Office.context.sensitivityLabelsCatalog.getAsync méthode .

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

Exemples

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

// This snippet sets the sensitivity label on the current mail item.
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;
        if (catalog.length > 0) {
          var id = catalog[0].id;
          Office.context.mailbox.item.sensitivityLabel.setAsync(id, (asyncResult) => {
            if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
              console.log(asyncResult.status);
            } else {
              console.log("Action failed with error: " + asyncResult.error.message);
            }
          });
        }
        else {
          console.log("Catalog list is empty");
        }
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});