Office.Categories interface

Fügt einem Element Kategorien hinzu. Jede Kategorie muss sich in der Kategoriemasterliste für dieses Postfach befinden und muss daher einen eindeutigen Namen haben, aber mehrere Kategorien können dieselbe Farbe verwenden.

Wichtig: In Outlook im Web und dem neuen Outlook unter Windows können Sie die API nicht zum Verwalten von Kategorien verwenden, die im Verfassenmodus auf eine Nachricht oder ein Terminelement angewendet werden.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Fehler:

• InvalidCategory : Ungültige Kategorien wurden bereitgestellt.

Beispiele

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

Fügt einem Element Kategorien hinzu. Jede Kategorie muss sich in der Kategoriemasterliste für dieses Postfach befinden und muss daher einen eindeutigen Namen haben, aber mehrere Kategorien können dieselbe Farbe verwenden.

Wichtig: In Outlook im Web und dem neuen Outlook unter Windows können Sie die API nicht zum Verwalten von Kategorien verwenden, die im Verfassenmodus auf eine Nachricht oder ein Terminelement angewendet werden.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Fehler:

• InvalidCategory : Ungültige Kategorien wurden bereitgestellt.

Ruft die Kategorien eines Elements ab.

Wichtig:

• Wenn für das Element keine Kategorien vorhanden sind oder je nach Outlook-Version ein leeres Array zurückgegeben wird, stellen Sie sicher, null dass Sie beide Fälle behandeln.

• In Outlook im Web und in Outlook unter Windows können Sie die API nicht verwenden, um Kategorien zu verwalten, die im Verfassenmodus auf eine Nachricht angewendet werden.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Ruft die Kategorien eines Elements ab.

Wichtig:

• Wenn für das Element keine Kategorien vorhanden sind oder je nach Outlook-Version ein leeres Array zurückgegeben wird, stellen Sie sicher, null dass Sie beide Fälle behandeln.

• In Outlook im Web und in Outlook unter Windows können Sie die API nicht verwenden, um Kategorien zu verwalten, die im Verfassenmodus auf eine Nachricht angewendet werden.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Beispiele

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

Entfernt Kategorien aus einem Element.

Wichtig: In Outlook im Web und dem neuen Outlook unter Windows können Sie die API nicht verwenden, um Kategorien zu verwalten, die im Verfassenmodus auf eine Nachricht angewendet werden.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Beispiele

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

Entfernt Kategorien aus einem Element.

Wichtig: In Outlook im Web und dem neuen Outlook unter Windows können Sie die API nicht verwenden, um Kategorien zu verwalten, die im Verfassenmodus auf eine Nachricht angewendet werden.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: Postfach 1.8 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen oder Lesen