Office.SensitivityLabel interface

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: Mailbox 1.13

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig: Um das Feature für Vertraulichkeitsbezeichnungen in Ihrem Add-In verwenden zu können, müssen Sie über ein Microsoft 365 E5 Abonnement verfügen.

Weitere Informationen zum Verwalten von Vertraulichkeitsbezeichnungen in Ihrem Add-In finden Sie unter Verwalten von Vertraulichkeitsbezeichnungen in Office-Add-Ins.

Verwendet von

Methoden

getAsync(options, callback)

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

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

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

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

Details zur Methode

getAsync(options, callback)

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

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: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

callback

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

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

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.13

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig: Um das Feature für Vertraulichkeitsbezeichnungen in Ihrem Add-In verwenden zu können, müssen Sie über ein Microsoft 365 E5 Abonnement verfügen.

Weitere Informationen zum Verwalten von Vertraulichkeitsbezeichnungen in Ihrem Add-In finden Sie unter Verwalten von Vertraulichkeitsbezeichnungen in Office-Add-Ins.

getAsync(callback)

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

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, asyncResultder ein Office.AsyncResult Objekt ist. Die GUID der Vertraulichkeitsbezeichnung wird in der asyncResult.value Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.13

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig: Um das Feature für Vertraulichkeitsbezeichnungen in Ihrem Add-In verwenden zu können, müssen Sie über ein Microsoft 365 E5 Abonnement verfügen.

Weitere Informationen zum Verwalten von Vertraulichkeitsbezeichnungen in Ihrem Add-In finden Sie unter Verwalten von Vertraulichkeitsbezeichnungen in Office-Add-Ins.

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 verfasst 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 verfassende Nachricht oder den zu verfassenden Termin angewendet werden soll. Der Parameterwert kann der eindeutige Bezeichner (GUID) einer Vertraulichkeitsbezeichnung oder ein SensitivityLabelDetails-Objekt sein.

options
Office.AsyncContextOptions

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

callback

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

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

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.13

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig:

  • Um das Feature für Vertraulichkeitsbezeichnungen in Ihrem Add-In verwenden zu können, müssen Sie über ein Microsoft 365 E5-Abonnement verfügen.

  • Die setAsync Methode wird für eine Nachricht, die derzeit mit der loadItemByIdAsync Methode geladen wird, nicht unterstützt. Weitere Informationen finden Sie unter "Aktivieren Ihres Outlook-Add-Ins für mehrere Nachrichten".

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

Weitere Informationen zum Verwalten von Vertraulichkeitsbezeichnungen in Ihrem Add-In finden Sie unter Verwalten von Vertraulichkeitsbezeichnungen in Office-Add-Ins.

setAsync(sensitivityLabel, callback)

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

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

Parameter

sensitivityLabel

string | Office.SensitivityLabelDetails

Die Vertraulichkeitsbezeichnung, die auf die verfassende Nachricht oder den zu verfassenden Termin angewendet werden soll. Der Parameterwert kann der eindeutige Bezeichner (GUID) einer Vertraulichkeitsbezeichnung 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, asyncResultder ein Office.AsyncResult Objekt ist.

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.13

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig:

  • Um das Feature für Vertraulichkeitsbezeichnungen in Ihrem Add-In verwenden zu können, müssen Sie über ein Microsoft 365 E5-Abonnement verfügen.

  • Die setAsync Methode wird für eine Nachricht, die derzeit mit der loadItemByIdAsync Methode geladen wird, nicht unterstützt. Weitere Informationen finden Sie unter "Aktivieren Ihres Outlook-Add-Ins für mehrere Nachrichten".

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

Weitere Informationen zum Verwalten von Vertraulichkeitsbezeichnungen in Ihrem Add-In finden Sie unter Verwalten von Vertraulichkeitsbezeichnungen in Office-Add-Ins.

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