Office.SmartAlertsEventCompletedOptions interface

Paket:: outlook

Gibt das Verhalten eines Smart Alerts-Add-Ins an, wenn die Verarbeitung eines OnMessageSendOnAppointmentSend oder-Ereignisses abgeschlossen ist.

Hinweise

API-Satz: Postfach 1.12

Mindestberechtigungsstufe (Outlook):eingeschränkt

Anwendbarer Outlook-Modus: Compose

Verwendet von

Office.MailboxEvent: abgeschlossen

Beispiele

// The following example checks whether a location is specified in an appointment before it's sent.
function onAppointmentSendHandler(event) {
    Office.context.mailbox.item.location.getAsync({ asyncContext: event }, asyncResult => {
        const event = asyncResult.asyncContext;
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(asyncResult.error.message);
            // If the add-in is unable to retrieve the appointment's location, the appointment isn't sent.
            event.completed({ allowEvent: false, errorMessage: "Failed to get the appointment's location." });
            return;
        }

        if (asyncResult.value === "") {
            // If no location is specified, the appointment isn't sent and the user is alerted to include a location.
            event.completed(
                {
                    allowEvent: false,
                    cancelLabel: "Add a location",
                    commandId: "msgComposeOpenPaneButton",
                    contextData: JSON.stringify({ a: "aValue", b: "bValue" }),
                    errorMessage: "Don't forget to add a meeting location.",
                    errorMessageMarkdown: "Don't forget to add a meeting location.\n\n**Tip**: For a list of locations, see [Meeting Locations]("https://www.contoso.com/meeting-locations).",
                    sendModeOverride: Office.MailboxEnums.SendModeOverride.PromptUser
                }
            );
        } else {
            // If a location is specified, the appointment is sent.
            event.completed({ allowEvent: true });
        }
    });
}

Eigenschaften

allowEvent	Wenn Sie die abgeschlossene Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, gibt dieser Wert an, ob das behandelte Ereignis die Ausführung fortsetzen oder abgebrochen werden soll. Beispielsweise kann ein Add-In, das das `OnMessageSendOnAppointmentSend` oder-Ereignis behandelt, festlegen `allowEvent` , dass `false` das Senden eines Elements abgebrochen wird. Ein vollständiges Beispiel finden Sie in der exemplarischen Vorgehensweise für intelligente Warnungen.
cancelLabel	Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, und seine `allowEvent` Eigenschaft auf `false`festlegen, passt diese Eigenschaft den Text einer Schaltfläche im Dialogfeld "Intelligente Warnungen" an. Benutzerdefinierter Text darf höchstens 20 Zeichen lang sein. Ein Beispiel finden Sie in der exemplarischen Vorgehensweise für intelligente Warnungen.
commandId	Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren und seine `allowEvent` Eigenschaft auf `false`festzulegen, gibt diese Eigenschaft die ID des Aufgabenbereichs oder der Funktion an, die über eine Schaltfläche im Dialogfeld "Intelligente Warnungen" ausgeführt wird. Ein Beispiel finden Sie in der exemplarischen Vorgehensweise für intelligente Warnungen.
contextData	Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, und seine `allowEvent` Eigenschaft auf `false`festlegen, gibt diese Eigenschaft alle JSON-Daten an, die an das Add-In zur Verarbeitung übergeben werden, wenn die entsprechende Schaltfläche im Dialogfeld "Intelligente Warnungen" ausgewählt wird.
errorMessage	Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren und seine `allowEvent` Eigenschaft auf `false`festzulegen, legt diese Eigenschaft die Fehlermeldung fest, die dem Benutzer angezeigt wird. Ein Beispiel finden Sie in der exemplarischen Vorgehensweise für intelligente Warnungen.
errorMessageMarkdown	Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren und seine `allowEvent` Eigenschaft auf `false`festzulegen, legt diese Eigenschaft die Fehlermeldung fest, die dem Benutzer angezeigt wird. Die Fehlermeldung ist mit Markdown formatiert. Ein Beispiel finden Sie in der exemplarischen Vorgehensweise für intelligente Warnungen.
sendModeOverride	Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren und seine `allowEvent` Eigenschaft auf `false`festzulegen, überschreibt diese Eigenschaft die im Manifest zur Laufzeit angegebene Option für den Sendemodus . Ein Beispiel finden Sie in der exemplarischen Vorgehensweise für intelligente Warnungen.

Details zur Eigenschaft

allowEvent

Wenn Sie die abgeschlossene Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, gibt dieser Wert an, ob das behandelte Ereignis die Ausführung fortsetzen oder abgebrochen werden soll. Beispielsweise kann ein Add-In, das das OnMessageSendOnAppointmentSend oder-Ereignis behandelt, festlegen allowEvent , dass false das Senden eines Elements abgebrochen wird. Ein vollständiges Beispiel finden Sie in der exemplarischen Vorgehensweise für intelligente Warnungen.

allowEvent?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: Postfach 1.12

Mindestberechtigungsstufe (Outlook):eingeschränkt

Anwendbarer Outlook-Modus: Compose

cancelLabel

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, und seine allowEvent Eigenschaft auf falsefestlegen, passt diese Eigenschaft den Text einer Schaltfläche im Dialogfeld "Intelligente Warnungen" an. Benutzerdefinierter Text darf höchstens 20 Zeichen lang sein.

Ein Beispiel finden Sie in der exemplarischen Vorgehensweise für intelligente Warnungen.

cancelLabel?: string;

Eigenschaftswert

string

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe (Outlook):eingeschränkt

Anwendbarer Outlook-Modus: Compose

Wichtig:

Die anpassbare Schaltfläche im Dialogfeld "Intelligente Warnungen" variiert je nach Outlook-Client und Version.

In Outlook im Web, auf Mac (in der Vorschauversion ab Version 16.105 (Build 25121117)), im neuen Outlook unter Windows und im klassischen Outlook unter Windows ab Version 2412 (Build 18324.20000), passt die cancelLabel Eigenschaft den Text der Schaltfläche "Aktion ausführen" an. Die Schaltfläche "Aktion ergreifen " wird nur im Dialogfeld "Intelligente Warnungen" angezeigt, wenn die commandId Option im event.completed Anruf konfiguriert ist. Die Option muss konfiguriert werden, wenn Sie den Text der Dialogschaltfläche anpassen möchten. In dieser Implementierung bricht die Schaltfläche "Nicht senden " das Senden des Elements ab. Der Text und die Funktionalität können nicht angepasst werden. Wenn Sie den Text der Schaltfläche "Nicht senden " zuvor angepasst haben, ohne ihr einen Aufgabenbereich oder einen Funktionsbefehl zuzuweisen, wird der benutzerdefinierte Text in den neuesten Versionen des Outlook-Clients nicht wirksam. Wenn Sie zuvor der Schaltfläche "Nicht senden " einen Aufgabenbereich oder Funktionsbefehl zugewiesen haben, sind keine weiteren Maßnahmen erforderlich, um die Schaltfläche "Aktion ergreifen " in den neuesten Versionen zu implementieren. Die standardmäßige oder benutzerdefinierte Schaltfläche "Aktion ergreifen " wird automatisch angezeigt, wenn ein Benutzer das nächste Mal ein Dialogfeld "Intelligente Warnungen" erhält. Obwohl keine Implementierungsänderungen erforderlich sind, empfehlen wir, Benutzer über diese aktualisierte Oberfläche zu informieren.
Im klassischen Outlook unter Windows (vor Version 2412 (Build 18324.20000) und Outlook unter Mac (vor Version 16.105 (Build 25121117)) passt die cancelLabel Eigenschaft den Text der Schaltfläche " Nicht senden " an. Die Schaltfläche "Nicht senden " bricht das Senden des Elements ab.

commandId

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren und seine allowEvent Eigenschaft auf falsefestzulegen, gibt diese Eigenschaft die ID des Aufgabenbereichs oder der Funktion an, die über eine Schaltfläche im Dialogfeld "Intelligente Warnungen" ausgeführt wird.

Ein Beispiel finden Sie in der exemplarischen Vorgehensweise für intelligente Warnungen.

commandId?: string;

Eigenschaftswert

string

Hinweise

API-Satz: Postfach 1.14 (Unterstützung des Aufgabenbereichs), Postfach 1.15 (Unterstützung von Funktionsbefehlen)

Mindestberechtigungsstufe (Outlook):eingeschränkt

Anwendbarer Outlook-Modus: Compose

Wichtig:

Der commandId Wert muss mit der Aufgabenbereich- oder Funktions-ID übereinstimmen, die im Manifest Ihres Add-Ins angegeben ist. Das Markup hängt vom Typ des Manifests ab, das Ihr Add-In verwendet.

Nur-Add-In-Manifest: Das id Attribut des Control-Elements , das den Aufgabenbereich oder die Funktion darstellt.
Einheitliches Manifest für Microsoft 365: Die "id"-Eigenschaft des Aufgabenbereichs oder des Funktionsbefehls im "controls"-Array.

Die Schaltfläche im Dialogfeld "Intelligente Warnungen", die einen Aufgabenbereich öffnet oder eine Funktion ausführt, variiert je nach Outlook-Client und -Version. In Outlook im Web, auf Mac (in der Vorschau ab Version 16.105 (Build 25121117)), im neuen Outlook unter Windows und im klassischen Outlook unter Windows ab Version 2412 (Build 18324.20000) öffnet die Schaltfläche "Aktion ergreifen" einen Aufgabenbereich oder führt eine Funktion aus. In dieser Implementierung bricht die Schaltfläche "Nicht senden " das Senden des Elements ab. Der Text und die Funktionalität können nicht angepasst werden. In früheren unterstützten Versionen des klassischen Outlook unter Windows (Versionen vor Version 2412 (Build 18324.20000), die den Postfachanforderungssatz 1.14 unterstützen) und Outlook auf Mac öffnet die Schaltfläche "Nicht senden " einen Aufgabenbereich oder führt eine Funktion aus.

Wenn Sie den Text und die Funktionalität der Schaltfläche "Nicht senden " in Ihrem Smart Alerts-Add-In bereits vor Version 2412 (Build 18324.20000) des klassischen Outlook unter Windows oder vor Version 16.105 (Build 25121117) von Outlook für Mac angepasst haben, sind keine weiteren Maßnahmen erforderlich, um die Schaltfläche "Aktion ergreifen " in den neuesten unterstützten Versionen zu implementieren. Die standardmäßige oder benutzerdefinierte Schaltfläche "Aktion ergreifen " wird automatisch angezeigt, wenn ein Benutzer das nächste Mal ein Dialogfeld "Intelligente Warnungen" erhält. Obwohl keine Implementierungsänderungen erforderlich sind, empfehlen wir, Benutzer über diese aktualisierte Oberfläche zu informieren.

Wenn Sie je nach Outlook-Client eine Befehls-ID angeben, die nicht vorhanden ist, bricht die Schaltfläche Aktion ausführen oder nicht senden einfach das Senden des Elements ab.

Wenn Sie die contextData Option in Ihrem event.completed Aufruf angeben, müssen Sie der commandId Option auch einen Aufgabenbereich oder eine Funktions-ID zuweisen. Andernfalls werden die zugewiesenen contextData JSON-Daten ignoriert.

Wenn Sie im Dialogfeld "Intelligente Warnungen" eine Schaltfläche zum Ausführen einer Funktion konfigurieren, wird dem Menüband oder der Aktionsleiste des Outlook-Clients auch eine Schaltfläche für die Funktion hinzugefügt. Verwenden Sie die contextData Option zur Unterscheidung, wenn ein Benutzer die Funktion im Dialogfeld "Intelligente Warnungen" ausführt.

Das Programmieren einer Schaltfläche im Dialogfeld "Intelligente Warnungen" zum Ausführen einer Funktion steht in Outlook auf Mac ab Version 16.105 (Build 25121117) zur Vorschau zur Verfügung. Um dieses Feature zu testen, treten Sie dem Microsoft 365 Insider-Programm bei, und wählen Sie die Option "Betakanal " aus, um auf Office-Betabuilds zuzugreifen.

contextData

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, und seine allowEvent Eigenschaft auf falsefestlegen, gibt diese Eigenschaft alle JSON-Daten an, die an das Add-In zur Verarbeitung übergeben werden, wenn die entsprechende Schaltfläche im Dialogfeld "Intelligente Warnungen" ausgewählt wird.

contextData?: any;

Eigenschaftswert

any

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe (Outlook):eingeschränkt

Anwendbarer Outlook-Modus: Compose

Wichtig:

In Outlook unter Windows wird dieser any Typ ab Version 2402 (Build 17308.20000) unterstützt. In früheren Versionen von Outlook unter Windows wird nur dieser string Typ unterstützt.
Wenn Sie die contextData Option in Ihrem event.completed Aufruf angeben, müssen Sie der commandId Option auch einen Aufgabenbereich oder eine Funktions-ID zuweisen. Andernfalls werden die zugewiesenen contextData JSON-Daten ignoriert.
Die Dialogschaltfläche, die den contextData Wert an das Add-In übergibt, variiert je nach Outlook-Client und Version. Weitere Informationen finden Sie unter Anpassen des Texts und der Funktionalität einer Schaltfläche im Dialogfeld.
Um den Wert der contextData Eigenschaft abzurufen, müssen Sie die JavaScript-Implementierung Ihres Aufgabenbereichs aufrufen Office.context.mailbox.item.getInitializationContextAsync . Wenn Sie eine JSON-Zeichenfolge erstellen JSON.stringify() und sie der contextData Eigenschaft zuweisen, müssen Sie die Zeichenfolge nach dem Abrufen mit JSON.parse() analysieren.
Wenn Sie im Dialogfeld "Intelligente Warnungen" eine Schaltfläche zum Ausführen einer Funktion konfigurieren, wird dem Menüband oder der Aktionsleiste des Outlook-Clients auch eine Schaltfläche für die Funktion hinzugefügt. Verwenden Sie die contextData Option zur Unterscheidung, wenn ein Benutzer die Funktion im Dialogfeld "Intelligente Warnungen" ausführt.
Um zu verhindern, dass der Aufgabenbereich eines Smart Alerts-Add-Ins neu gestartet wird, wenn er bereits geöffnet ist, implementieren Sie einen Handler für das Office.EventType.InitializationContextChanged Ereignis. Anschließend können Sie die Ereignisargumente an die contextData Eigenschaft übergeben.

errorMessage

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren und seine allowEvent Eigenschaft auf falsefestzulegen, legt diese Eigenschaft die Fehlermeldung fest, die dem Benutzer angezeigt wird. Ein Beispiel finden Sie in der exemplarischen Vorgehensweise für intelligente Warnungen.

errorMessage?: string;

Eigenschaftswert

string

Hinweise

API-Satz: Postfach 1.12

Mindestberechtigungsstufe (Outlook):eingeschränkt

Anwendbarer Outlook-Modus: Compose

Wichtig:

Die Fehlermeldung darf höchstens 500 Zeichen lang sein.
Wenn Sie in der errorMessage Eigenschaft keine Meldung angeben, wird stattdessen die folgende Standardmeldung angezeigt: "<Der Add-In-Name> verhindert, dass diese E-Mail gesendet wird."

errorMessageMarkdown

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren und seine allowEvent Eigenschaft auf falsefestzulegen, legt diese Eigenschaft die Fehlermeldung fest, die dem Benutzer angezeigt wird. Die Fehlermeldung ist mit Markdown formatiert. Ein Beispiel finden Sie in der exemplarischen Vorgehensweise für intelligente Warnungen.

errorMessageMarkdown?: string;

Eigenschaftswert

string

Hinweise

API-Satz: Postfach 1.15

Mindestberechtigungsstufe (Outlook):eingeschränkt

Anwendbarer Outlook-Modus: Compose

Wichtig

Die errorMessageMarkdown Eigenschaft steht in Outlook auf Mac ab Version 16.103 (Build 25102433) zur Vorschau zur Verfügung. Um die Eigenschaft zu testen, treten Sie dem Microsoft 365 Insider-Programm bei, und wählen Sie die Option "Betakanal " aus, um auf Office-Betabuilds zuzugreifen.
Die formatierte Fehlermeldung darf höchstens 500 Zeichen umfassen.
Anleitungen zu unterstützten Markdownelementen finden Sie unter Einschränkungen beim Formatieren der Dialognachricht mit Markdown.
Wenn Sie die Dialognachricht mithilfe der errorMessageMarkdown Eigenschaft formatieren, wird empfohlen, mithilfe der errorMessage Eigenschaft auch eine Klartextversion der Nachricht hinzuzufügen. Dadurch wird sichergestellt, dass die Nachricht in Outlook-Clients, die Markdown nicht unterstützen, ordnungsgemäß angezeigt wird.

sendModeOverride

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren und seine allowEvent Eigenschaft auf falsefestzulegen, überschreibt diese Eigenschaft die im Manifest zur Laufzeit angegebene Option für den Sendemodus .

Ein Beispiel finden Sie in der exemplarischen Vorgehensweise für intelligente Warnungen.

sendModeOverride?: MailboxEnums.SendModeOverride | string;

Eigenschaftswert

Office.MailboxEnums.SendModeOverride | string

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe (Outlook):eingeschränkt

Anwendbarer Outlook-Modus: Compose

Wichtig: Kann derzeit sendModeOverride nur auf die Option "Benutzer auffordern" festgelegt werden.

Feedback

War diese Seite hilfreich?