Office.SensitivityLabel interface

  • Referenz
Paket:
outlook

Stellt Methoden zum Abrufen oder Festlegen der Vertraulichkeitsbezeichnung einer Nachricht oder eines Termins bereit. Weitere Informationen zu Vertraulichkeitsbezeichnungen finden Sie unter Informationen zu Vertraulichkeitsbezeichnungen.

Hinweise

[ API-Satz: Postfach 1.13 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen

Wichtig: Um die Vertraulichkeitsbezeichnungsfunktion in Ihrem Add-In verwenden zu können, benötigen Sie ein Microsoft 365 E5-Abonnement.

Weitere Informationen zum Verwalten von Vertraulichkeitsbezeichnungen in Ihrem Add-In finden Sie unter Verwalten der Vertraulichkeitsbezeichnung Ihrer Nachricht oder Ihres Termins im Verfassenmodus.

Methoden

getAsync(options, callback)

Ruft den eindeutigen Bezeichner (GUID) der Vertraulichkeitsbezeichnung ab, die auf eine Nachricht oder einen Termin angewendet wird, der bzw. der erstellt wird.
getAsync(callback)

Ruft den eindeutigen Bezeichner (GUID) der Vertraulichkeitsbezeichnung ab, die auf eine Nachricht oder einen Termin angewendet wird, der bzw. der erstellt wird.
setAsync(sensitivityLabel, options, callback)

Wendet die angegebene Vertraulichkeitsbezeichnung auf die Nachricht oder den Termin an, die bzw. der erstellt wird.
setAsync(sensitivityLabel, callback)

Wendet die angegebene Vertraulichkeitsbezeichnung auf die Nachricht oder den Termin an, die bzw. der erstellt wird.

Details zur Methode

getAsync(options, callback)

Ruft den eindeutigen Bezeichner (GUID) der Vertraulichkeitsbezeichnung ab, die auf eine Nachricht oder einen Termin angewendet wird, der bzw. der erstellt wird.

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

Parameter

options
Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

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

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Die GUID der Vertraulichkeitsbezeichnung wird in der asyncResult.value -Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.13 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen

Wichtig: Um die Vertraulichkeitsbezeichnungsfunktion in Ihrem Add-In verwenden zu können, benötigen Sie ein Microsoft 365 E5-Abonnement.

Weitere Informationen zum Verwalten von Vertraulichkeitsbezeichnungen in Ihrem Add-In finden Sie unter Verwalten der Vertraulichkeitsbezeichnung Ihrer Nachricht oder Ihres Termins im Verfassenmodus.

getAsync(callback)

Ruft den eindeutigen Bezeichner (GUID) der Vertraulichkeitsbezeichnung ab, die auf eine Nachricht oder einen Termin angewendet wird, der bzw. der erstellt wird.

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

Parameter

callback

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

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Die GUID der Vertraulichkeitsbezeichnung wird in der asyncResult.value -Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.13 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen

Wichtig: Um die Vertraulichkeitsbezeichnungsfunktion in Ihrem Add-In verwenden zu können, benötigen Sie ein Microsoft 365 E5-Abonnement.

Weitere Informationen zum Verwalten von Vertraulichkeitsbezeichnungen in Ihrem Add-In finden Sie unter Verwalten der Vertraulichkeitsbezeichnung Ihrer Nachricht oder Ihres Termins im Verfassenmodus.

Beispiele

// 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)

Wendet die angegebene Vertraulichkeitsbezeichnung auf die Nachricht oder den Termin an, die bzw. der erstellt wird.

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

Parameter

sensitivityLabel

string | Office.SensitivityLabelDetails

Die Vertraulichkeitsbezeichnung, die auf die Nachricht oder den Termin angewendet werden soll, die bzw. der erstellt wird. Der Parameterwert kann der eindeutige Bezeichner einer Vertraulichkeitsbezeichnung (GUID) oder ein SensitivityLabelDetails-Objekt sein.

options
Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.13 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen

Wichtig: Um die Vertraulichkeitsbezeichnungsfunktion in Ihrem Add-In verwenden zu können, benötigen Sie ein Microsoft 365 E5-Abonnement.

Tipp: Rufen Sie die -Methode auf, um die Office.context.sensitivityLabelsCatalog.getAsync verfügbaren Vertraulichkeitsbezeichnungen zu ermitteln.

Weitere Informationen zum Verwalten von Vertraulichkeitsbezeichnungen in Ihrem Add-In finden Sie unter Verwalten der Vertraulichkeitsbezeichnung Ihrer Nachricht oder Ihres Termins im Verfassenmodus.

setAsync(sensitivityLabel, callback)

Wendet die angegebene Vertraulichkeitsbezeichnung auf die Nachricht oder den Termin an, die bzw. der erstellt wird.

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

Parameter

sensitivityLabel

string | Office.SensitivityLabelDetails

Die Vertraulichkeitsbezeichnung, die auf die Nachricht oder den Termin angewendet werden soll, die bzw. der erstellt wird. Der Parameterwert kann der eindeutige Bezeichner einer Vertraulichkeitsbezeichnung (GUID) oder ein SensitivityLabelDetails-Objekt sein.

callback

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.13 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen

Wichtig: Um die Vertraulichkeitsbezeichnungsfunktion in Ihrem Add-In verwenden zu können, benötigen Sie ein Microsoft 365 E5-Abonnement.

Tipp: Rufen Sie die -Methode auf, um die Office.context.sensitivityLabelsCatalog.getAsync verfügbaren Vertraulichkeitsbezeichnungen zu ermitteln.

Weitere Informationen zum Verwalten von Vertraulichkeitsbezeichnungen in Ihrem Add-In finden Sie unter Verwalten der Vertraulichkeitsbezeichnung Ihrer Nachricht oder Ihres Termins im Verfassenmodus.

Beispiele

// 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);
  }
});