Office.MasterCategories interface

Stellt die Kategorien-Master-Liste im Postfach dar.

In Outlook kann ein Benutzer Nachrichten und Termine mit Tags versehen, indem er sie mithilfe einer Kategorie farblich kennzeichnet. Kategorien werden vom Benutzer in einer Masterliste in seinem Postfach definiert. Anschließend können beliebig viele Kategorien auf ein Element angewendet werden.

Wichtig: In Stellvertretungs- oder freigegebenen Szenarien kann die Stellvertretung die Kategorien in der Master-Liste abrufen, aber keine Kategorien hinzufügen oder entfernen.

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Lese-/Schreibpostfach

Anwendbarer Outlook-Modus: Compose oder Lesen

Verwendet von

Office.Mailbox: masterCategories

Methoden

addAsync(categories, options, callback)	Fügt Kategorien zur Master-Liste für ein Postfach hinzu. Jede Kategorie muss einen eindeutigen Namen haben, aber mehrere Kategorien können dieselbe Farbe verwenden.
addAsync(categories, callback)	Fügt Kategorien zur Master-Liste für ein Postfach hinzu. Jede Kategorie muss einen eindeutigen Namen haben, aber mehrere Kategorien können dieselbe Farbe verwenden.
getAsync(options, callback)	Ruft die Master-Liste der Kategorien für ein Postfach ab.
getAsync(callback)	Ruft die Master-Liste der Kategorien für ein Postfach ab.
removeAsync(categories, options, callback)	Entfernt Kategorien aus der Master-Liste für ein Postfach.
removeAsync(categories, callback)	Entfernt Kategorien aus der Master-Liste für ein Postfach.

addAsync(categories, options, callback)

Fügt Kategorien zur Master-Liste für ein Postfach hinzu. Jede Kategorie muss einen eindeutigen Namen haben, aber mehrere Kategorien können dieselbe Farbe verwenden.

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

Parameter

categories: Office.CategoryDetails[]

Die Kategorien, die der Master-Liste im Postfach hinzugefügt werden sollen.

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 vom Typ Office.AsyncResultaufgerufen.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Lese-/Schreibpostfach

Anwendbarer Outlook-Modus: Compose oder Lesen

Fehler:

DuplicateCategory : Eine der bereitgestellten Kategorien befindet sich bereits in der Liste der Master-Kategorien.
PermissionDenied : Der Benutzer ist nicht berechtigt, diese Aktion auszuführen.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-master-categories.yaml

const masterCategoriesToAdd = [
  {
    displayName: "TestCategory",
    color: Office.MailboxEnums.CategoryColor.Preset0
  }
];

Office.context.mailbox.masterCategories.addAsync(masterCategoriesToAdd, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Successfully added categories to master list");
  } else {
    console.log("masterCategories.addAsync call failed with error: " + asyncResult.error.message);
  }
});

addAsync(categories, callback)

Fügt Kategorien zur Master-Liste für ein Postfach hinzu. Jede Kategorie muss einen eindeutigen Namen haben, aber mehrere Kategorien können dieselbe Farbe verwenden.

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

Parameter

categories: Office.CategoryDetails[]

Die Kategorien, die der Master-Liste im Postfach hinzugefügt werden sollen.

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

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Lese-/Schreibpostfach

Anwendbarer Outlook-Modus: Compose oder Lesen

Fehler:

DuplicateCategory : Eine der bereitgestellten Kategorien befindet sich bereits in der Liste der Master-Kategorien.
PermissionDenied : Der Benutzer ist nicht berechtigt, diese Aktion auszuführen.

getAsync(options, callback)

Ruft die Master-Liste der Kategorien für ein Postfach ab.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => 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<Office.CategoryDetails[]>) => void

Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Wenn das Hinzufügen von Kategorien fehlschlägt, enthält die asyncResult.error Eigenschaft einen Fehlercode.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Lese-/Schreibpostfach

Anwendbarer Outlook-Modus: Compose oder Lesen

getAsync(callback)

Ruft die Master-Liste der Kategorien für ein Postfach ab.

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

Parameter

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

Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Lese-/Schreibpostfach

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-master-categories.yaml

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Master categories:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories in the master list.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

removeAsync(categories, options, callback)

Entfernt Kategorien aus der Master-Liste für ein Postfach.

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

Parameter

categories: string[]

Die Kategorien, die aus der Master-Liste im Postfach entfernt werden sollen.

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 vom Typ Office.AsyncResultaufgerufen. Wenn das Entfernen von Kategorien fehlschlägt, enthält die asyncResult.error Eigenschaft einen Fehlercode.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Lese-/Schreibpostfach

Anwendbarer Outlook-Modus: Compose oder Lesen

Fehler:

PermissionDenied : Der Benutzer ist nicht berechtigt, diese Aktion auszuführen.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-master-categories.yaml

const masterCategoriesToRemove = ["TestCategory"];

Office.context.mailbox.masterCategories.removeAsync(masterCategoriesToRemove, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Successfully removed categories from master list");
  } else {
    console.log("masterCategories.removeAsync call failed with error: " + asyncResult.error.message);
  }
});

removeAsync(categories, callback)

Entfernt Kategorien aus der Master-Liste für ein Postfach.

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

Parameter

categories: string[]

Die Kategorien, die aus der Master-Liste im Postfach entfernt werden sollen.

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

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Wenn das Entfernen von Kategorien fehlschlägt, enthält die asyncResult.error Eigenschaft einen Fehlercode.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Lese-/Schreibpostfach

Anwendbarer Outlook-Modus: Compose oder Lesen

Fehler:

PermissionDenied : Der Benutzer ist nicht berechtigt, diese Aktion auszuführen.

Hinweise

Verwendet von

Methoden

Details zur Methode

addAsync(categories, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

addAsync(categories, callback)

Parameter

Gibt zurück

Hinweise

getAsync(options, callback)

Parameter

Gibt zurück

Hinweise

getAsync(callback)

Parameter

Gibt zurück

Hinweise

Beispiele

removeAsync(categories, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

removeAsync(categories, callback)

Parameter

Gibt zurück

Hinweise

Feedback