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 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 Betreff 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, callback)	Legt den im Betreff 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 Betreff 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, 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: 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 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 Betrefffeld 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 speichern, nachdem Sie aufgerufen haben setAsync, 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 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 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, 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 Betrefffeld 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 speichern, nachdem Sie aufgerufen haben setAsync, 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 = $("#subject-text-field")
  .val()
  .toString();
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.");
});