Office.DisplayedSubject interface

Paket:
outlook

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt eine Methode bereit, um den im Betreff einer Nachricht angezeigten Inhalt vorübergehend in den Lesemodus zu versetzen.

Hinweise

API-Satz: Postfachvorschau

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachricht lesen

Verwendet von

Methoden

setAsync(data, options, callback)

Legt den im Betreff einer Nachricht angezeigten Inhalt vorübergehend im Lesemodus fest. Der festgelegte Inhalt bleibt sichtbar, bis der Benutzer zu einer anderen Nachricht wechselt oder das Fenster der aktuellen Nachricht schließt.
setAsync(data, callback)

Legt den im Betreff einer Nachricht angezeigten Inhalt vorübergehend im Lesemodus fest. Der festgelegte Inhalt bleibt sichtbar, bis der Benutzer zu einer anderen Nachricht wechselt oder das Fenster der aktuellen Nachricht schließt.

Details zur Methode

setAsync(data, options, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Legt den im Betreff einer Nachricht angezeigten Inhalt vorübergehend im Lesemodus fest. Der festgelegte Inhalt bleibt sichtbar, bis der Benutzer zu einer anderen Nachricht wechselt oder das Fenster der aktuellen Nachricht schließt.

setAsync(data: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

data

string

Die Zeichenfolge, die vorübergehend im Betreff einer Nachricht angezeigt werden soll. Die Zeichenfolge ist auf 255 Zeichen beschränkt.

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. Alle aufgetretenen Fehler werden in der asyncResult.error-Eigenschaft bereitgestellt.

Gibt zurück

void

Hinweise

API-Satz: Postfachvorschau

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

  • Wenn mehrere Add-Ins, die den Vorgang implementieren setAsync , gleichzeitig ausgeführt werden, wird der Inhalt, der vom letzten Add-In festgelegt wurde, das den setAsync Vorgang abgeschlossen hat, im Betrefffeld angezeigt.

  • Der mit der setAsync Methode festgelegte Inhalt wird nur angezeigt, während der Benutzer das Element anzeigt. Sie werden nicht in Outlook zwischengespeichert und nicht mit anderen Outlook-Clients synchronisiert.

  • Wenn Sie eine Nachricht nach einem Anruf setAsyncspeichern, wird der ursprüngliche Betreff im gespeicherten Element angezeigt.

  • Die setAsync Methode wird für mehrere ausgewählte Nachrichten nicht unterstützt.

setAsync(data, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Legt den im Betreff einer Nachricht angezeigten Inhalt vorübergehend im Lesemodus fest. Der festgelegte Inhalt bleibt sichtbar, bis der Benutzer zu einer anderen Nachricht wechselt oder das Fenster der aktuellen Nachricht schließt.

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

Parameter

data

string

Die Zeichenfolge, die vorübergehend im Betreff einer Nachricht angezeigt werden soll. Die Zeichenfolge ist auf 255 Zeichen beschränkt.

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. Alle aufgetretenen Fehler werden in der asyncResult.error-Eigenschaft bereitgestellt.

Gibt zurück

void

Hinweise

API-Satz: Postfachvorschau

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

  • Wenn mehrere Add-Ins, die den Vorgang implementieren setAsync , gleichzeitig ausgeführt werden, wird der Inhalt, der vom letzten Add-In festgelegt wurde, das den setAsync Vorgang abgeschlossen hat, im Betrefffeld angezeigt.

  • Der mit der setAsync Methode festgelegte Inhalt wird nur angezeigt, während der Benutzer das Element anzeigt. Sie werden nicht in Outlook zwischengespeichert und nicht mit anderen Outlook-Clients synchronisiert.

  • Wenn Sie eine Nachricht nach einem Anruf setAsyncspeichern, wird der ursprüngliche Betreff im gespeicherten Element angezeigt.

  • Die setAsync Methode wird für mehrere ausgewählte Nachrichten nicht unterstützt.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/set-displayed-body-subject.yaml

// This snippet temporarily sets the content displayed in the subject field of a message in read mode.
// The set content will remain visible until the user switches to a different message in the Reading Pane or closes the window of the current message.
const subjectText = (document.getElementById("subject-text-field") as HTMLInputElement).value;
Office.context.mailbox.item.display.subject.setAsync(subjectText, (asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Action failed with error: ${asyncResult.error.message}`);
    return;
  }

  console.log("Temporarily set the content displayed in the subject field.");
});