Office.MasterCategories interface

Referenz

Paket:: outlook

Stellt die Kategoriemasterliste für das Postfach dar.

In Outlook kann ein Benutzer Nachrichten und Termine markieren, indem er eine Kategorie verwendet, um sie farbig zu codieren. 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 Delegat- oder freigegebenen Szenarien kann der Delegat die Kategorien in der Masterliste abrufen, aber keine Kategorien hinzufügen oder entfernen.

Hinweise

[ API-Satz: Postfach 1.8 ]

Minimale Berechtigungsstufe: Postfach lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Methoden

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

Details zur Methode

addAsync(categories, options, callback)

Fügt der Masterliste in einem Postfach Kategorien 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 Masterliste im Postfach hinzugefügt werden sollen.

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Minimale Berechtigungsstufe: Postfach lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Fehler:

DuplicateCategory: Eine der bereitgestellten Kategorien ist bereits in der Masterkategorieliste enthalten.
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 der Masterliste in einem Postfach Kategorien 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 Masterliste 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 ]

Minimale Berechtigungsstufe: Postfach lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Fehler:

DuplicateCategory: Eine der bereitgestellten Kategorien ist bereits in der Masterkategorieliste enthalten.
PermissionDenied: Der Benutzer ist nicht berechtigt, diese Aktion auszuführen.

getAsync(options, callback)

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

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 ]

Minimale Berechtigungsstufe: Postfach lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen oder Lesen

getAsync(callback)

Ruft die Masterliste 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 ]

Minimale Berechtigungsstufe: Postfach 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-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 Masterliste eines Postfachs.

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

Parameter

categories: string[]

Die Kategorien, die aus der Masterliste des Postfachs entfernt werden sollen.

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 vom Typ Office.AsyncResultaufgerufen. Wenn beim Entfernen von Kategorien ein Fehler auftritt, enthält die asyncResult.error Eigenschaft einen Fehlercode.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Minimale Berechtigungsstufe: Postfach lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen 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 Masterliste eines Postfachs.

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

Parameter

categories: string[]

Die Kategorien, die aus der Masterliste des Postfachs entfernt werden sollen.

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Minimale Berechtigungsstufe: Postfach lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Fehler:

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

Freigeben über

Office.MasterCategories interface

Hinweise

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

Zusätzliche Ressourcen