Office.Categories interface

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig: In Outlook im Web und im neuen Outlook unter Windows können Sie die API nicht verwenden, um Kategorien zu verwalten, die auf eine Nachricht oder ein Terminelement im Compose-Modus angewendet werden.

Fehler:

• InvalidCategory : Ungültige Kategorien wurden angegeben.

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 Kategorien-Master-Liste für dieses Postfach befinden und daher einen eindeutigen Namen haben, aber mehrere Kategorien können dieselbe Farbe verwenden.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig: In Outlook im Web und im neuen Outlook unter Windows können Sie die API nicht verwenden, um Kategorien zu verwalten, die auf eine Nachricht oder ein Terminelement im Compose-Modus angewendet werden.

Fehler:

• InvalidCategory : Ungültige Kategorien wurden angegeben.

Ruft die Kategorien eines Elements ab.

Wichtig:

• Wenn das Element keine Kategorien enthält oder je nach Outlook-Version ein leeres Array zurückgegeben wird, müssen Sie daher sicherstellen, null dass Sie beide Fälle behandeln.

• In Outlook im Web und im neuen Outlook unter Windows können Sie die API nicht verwenden, um Kategorien zu verwalten, die auf eine Nachricht im Compose-Modus 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: Compose oder Lesen

Ruft die Kategorien eines Elements ab.

Wichtig:

• Wenn das Element keine Kategorien enthält oder je nach Outlook-Version ein leeres Array zurückgegeben wird, müssen Sie daher sicherstellen, null dass Sie beide Fälle behandeln.

• In Outlook im Web und im neuen Outlook unter Windows können Sie die API nicht verwenden, um Kategorien zu verwalten, die auf eine Nachricht im Compose-Modus 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: Compose 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.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig: In Outlook im Web und im neuen Outlook unter Windows können Sie die API nicht verwenden, um Kategorien zu verwalten, die auf eine Nachricht oder ein Terminelement im Compose-Modus angewendet werden.

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.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig: In Outlook im Web und im neuen Outlook unter Windows können Sie die API nicht verwenden, um Kategorien zu verwalten, die auf eine Nachricht oder ein Terminelement im Compose-Modus angewendet werden.