Share via

Office.DisplayedBody interface

  • Referenz
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 Textkörper einer Nachricht angezeigten Inhalt vorübergehend im Lesemodus festzulegen.

Hinweise

[ API-Satz: Postfachvorschau ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Methoden

setAsync(data, options, callback)

Legt den im Textkörper 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 Textkörper einer Nachricht angezeigten Inhalt vorübergehend im Lesemodus fest. Der Festgelegtinhalt 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 Textkörper 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 & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

data

string

Die Zeichenfolge, die vorübergehend im Textkörper einer Nachricht angezeigt werden soll. Die Zeichenfolge ist auf 1.000.000 Zeichen begrenzt.

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

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. coercionType: Das Format der Daten, die vorübergehend angezeigt werden sollen. Der Zeichenfolge im data-Parameter wird in dieses Format konvertiert.

callback

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Alle aufgetretenen Fehler werden in der asyncResult.error-Eigenschaft bereitgestellt.

Gibt zurück

void

Hinweise

[ API-Satz: Postfachvorschau ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Empfohlen: Rufen Sie Office.context.mailbox.item.body.getTypeAsync auf, und übergeben Sie dann den zurückgegebenen Wert an den options.coercionType Parameter.

Wichtig:

  • Wenn mehrere Add-Ins, die implementieren setAsync , gleichzeitig ausgeführt werden, wird der Inhalt des letzten Add-Ins, das den setAsync Vorgang abgeschlossen hat, im Text angezeigt.

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

  • Wenn Sie eine Nachricht nach dem Aufrufen setAsyncvon speichern, wird der ursprüngliche Inhalt des Nachrichtentexts 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 Textkörper einer Nachricht angezeigten Inhalt vorübergehend im Lesemodus fest. Der Festgelegtinhalt 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 Textkörper einer Nachricht angezeigt werden soll. Die Zeichenfolge ist auf 1.000.000 Zeichen begrenzt.

callback

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Alle aufgetretenen Fehler werden in der asyncResult.error-Eigenschaft bereitgestellt.

Gibt zurück

void

Hinweise

[ API-Satz: Postfachvorschau ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

  • Wenn mehrere Add-Ins, die implementieren setAsync , gleichzeitig ausgeführt werden, wird der Inhalt des letzten Add-Ins, das den setAsync Vorgang abgeschlossen hat, im Text angezeigt.

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

  • Wenn Sie eine Nachricht nach dem Aufrufen setAsyncvon speichern, wird der ursprüngliche Inhalt des Nachrichtentexts 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 body 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 bodyText = $("#body-text-field")
  .val()
  .toString();
Office.context.mailbox.item.display.body.setAsync(bodyText, (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 body.");
});