Freigeben über

Office.SmartAlertsEventCompletedOptions interface

  • Referenz
Paket:
outlook

Gibt das Verhalten eines Smart Alerts-Add-Ins an, wenn es die Verarbeitung eines - oder OnAppointmentSend -OnMessageSendEreignisses abgeschlossen hat.

Hinweise

[ API-Satz: Postfach 1.12 ]

Mindestberechtigungsstufe (Outlook): eingeschränkt

Anwendbarer Outlook-Modus: Compose

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 completed-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 OnMessageSend Ereignis oder OnAppointmentSend behandelt, auf false festlegenallowEvent, um das Senden eines Elements abzubrechen. Ein vollständiges Beispiel finden Sie in der exemplarischen Vorgehensweise zu intelligenten Warnungen.
cancelLabel

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und dessen allowEvent Eigenschaft auf falsefestzulegen, passt diese Eigenschaft den Text einer Schaltfläche im Dialogfeld Intelligente Warnungen an. Benutzerdefinierter Text muss maximal 20 Zeichen lang sein.

Ein Beispiel finden Sie in der exemplarischen Vorgehensweise zu intelligenten Warnungen.
commandId

Wenn Sie die completed-Methode verwenden, um die Vervollständigung 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 zu intelligenten Warnungen.
contextData

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine allowEvent -Eigenschaft auf falsefestzulegen, 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 ist.
errorMessage

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und dessen allowEvent -Eigenschaft auf falsefestzulegen, legt diese Eigenschaft die fehlermeldung fest, die dem Benutzer angezeigt wird. Ein Beispiel finden Sie in der exemplarischen Vorgehensweise zu intelligenten Warnungen.
errorMessageMarkdown

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und dessen allowEvent -Eigenschaft auf falsefestzulegen, legt diese Eigenschaft die fehlermeldung fest, die dem Benutzer angezeigt wird. Die Fehlermeldung wird mithilfe von Markdown formatiert. Ein Beispiel finden Sie in der exemplarischen Vorgehensweise zu intelligenten Warnungen.
sendModeOverride

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine allowEvent -Eigenschaft auf falsefestzulegen, überschreibt diese Eigenschaft die im Manifest angegebene Sendemodusoption zur Laufzeit.

Ein Beispiel finden Sie in der exemplarischen Vorgehensweise zu intelligenten Warnungen.

Details zur Eigenschaft

allowEvent

Wenn Sie die completed-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 OnMessageSend Ereignis oder OnAppointmentSend behandelt, auf false festlegenallowEvent, um das Senden eines Elements abzubrechen. Ein vollständiges Beispiel finden Sie in der exemplarischen Vorgehensweise zu intelligenten 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 die Vervollständigung eines Ereignishandlers zu signalisieren und dessen allowEvent Eigenschaft auf falsefestzulegen, passt diese Eigenschaft den Text einer Schaltfläche im Dialogfeld Intelligente Warnungen an. Benutzerdefinierter Text muss maximal 20 Zeichen lang sein.

Ein Beispiel finden Sie in der exemplarischen Vorgehensweise zu intelligenten 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, dem neuen Outlook unter Windows und dem 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 ausführen wird nur im Dialogfeld Intelligente Warnungen angezeigt, wenn die commandId Option im event.completed Aufruf konfiguriert ist. Die Option muss konfiguriert werden, wenn Sie den Text der Dialogfeldschaltfläche anpassen möchten. In dieser Implementierung bricht die Schaltfläche Nicht senden das gesendete Element ab. Text und Funktionalität können nicht angepasst werden. Wenn Sie zuvor den Text der Schaltfläche "Nicht senden " angepasst haben, ohne ihr einen Aufgabenbereich oder Funktionsbefehl zuzuweisen, wird Ihr benutzerdefinierter Text in den neuesten Outlook-Clientversionen nicht wirksam. Wenn Sie der Schaltfläche "Nicht senden " zuvor einen Aufgabenbereich- oder Funktionsbefehl zugewiesen haben, ist keine zusätzliche Aktion erforderlich, um die Schaltfläche Aktion ausführen in den neuesten Versionen zu implementieren. Die standardmäßige oder angepasste Schaltfläche Aktion ausführen wird automatisch angezeigt, wenn ein Benutzer das nächste Mal ein Dialogfeld für intelligente Warnungen erhält. Obwohl keine Implementierungsänderungen erforderlich sind, empfehlen wir, die Benutzer über diese aktualisierte Benutzeroberfläche zu benachrichtigen.

  • 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 für Mac (Vorschau) passt die cancelLabel Eigenschaft den Text der Schaltfläche "Nicht senden " an. Die Schaltfläche Nicht senden bricht das gesendete Element ab.

commandId

Wenn Sie die completed-Methode verwenden, um die Vervollständigung 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 zu intelligenten Warnungen.

commandId?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe (Outlook): eingeschränkt

Anwendbarer Outlook-Modus: Compose

Wichtig:

Der commandId Wert muss mit der Aufgabenbereichs- 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 Eigenschaft "id" des Aufgabenbereichs oder Funktionsbefehls im Array "controls".

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, dem neuen Outlook unter Windows und dem klassischen Outlook unter Windows ab Version 2412 (Build 18324.20000) öffnet die Schaltfläche Aktion ausführen einen Aufgabenbereich oder führt eine Funktion aus. In dieser Implementierung bricht die Schaltfläche Nicht senden das gesendete Element ab. Text und 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 für Mac (Vorschau) ö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 vor Version 2412 (Build 18324.20000) des klassischen Outlook unter Windows angepasst haben, ist keine zusätzliche Aktion erforderlich, um die Schaltfläche Aktion ausführen in den neuesten unterstützten Versionen zu implementieren. Die standardmäßige oder angepasste Schaltfläche Aktion ausführen wird automatisch angezeigt, wenn ein Benutzer das nächste Mal ein Dialogfeld für intelligente Warnungen erhält. Obwohl keine Implementierungsänderungen erforderlich sind, empfehlen wir, die Benutzer über diese aktualisierte Benutzeroberfläche zu benachrichtigen.

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

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

Wenn Sie eine Schaltfläche im Dialogfeld Smart Alerts 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, um zu unterscheiden, wann ein Benutzer die Funktion aus dem Dialogfeld Smart Alerts ausführt.

contextData

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine allowEvent -Eigenschaft auf falsefestzulegen, 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 ist.

contextData?: any;

Eigenschaftswert

any

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe (Outlook): eingeschränkt

Anwendbarer Outlook-Modus: Compose

Wichtig:

  • In Outlook unter Windows wird der any Typ ab Version 2402 (Build 17308.20000) unterstützt. In früheren Versionen von Outlook unter Windows wird nur der string Typ unterstützt.

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

  • Die Dialogfeldschaltfläche, die den contextData Wert an das Add-In übergibt, variiert je nach Outlook-Client und seiner 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 in der JavaScript-Implementierung Ihres Aufgabenbereichs aufrufen Office.context.mailbox.item.getInitializationContextAsync . Wenn Sie eine JSON-Zeichenfolge mit JSON.stringify() erstellen und der contextData -Eigenschaft zuweisen, müssen Sie die Zeichenfolge mit JSON.parse() analysieren, sobald Sie sie abgerufen haben.

  • Wenn Sie eine Schaltfläche im Dialogfeld Smart Alerts 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, um zu unterscheiden, wann ein Benutzer die Funktion aus dem Dialogfeld Smart Alerts ausführt.

errorMessage

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und dessen allowEvent -Eigenschaft auf falsefestzulegen, legt diese Eigenschaft die fehlermeldung fest, die dem Benutzer angezeigt wird. Ein Beispiel finden Sie in der exemplarischen Vorgehensweise zu intelligenten Warnungen.

errorMessage?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: Postfach 1.12 ]

Mindestberechtigungsstufe (Outlook): eingeschränkt

Anwendbarer Outlook-Modus: Compose

Wichtig: Die Fehlermeldung muss maximal 500 Zeichen lang sein.

errorMessageMarkdown

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und dessen allowEvent -Eigenschaft auf falsefestzulegen, legt diese Eigenschaft die fehlermeldung fest, die dem Benutzer angezeigt wird. Die Fehlermeldung wird mithilfe von Markdown formatiert. Ein Beispiel finden Sie in der exemplarischen Vorgehensweise zu intelligenten Warnungen.

errorMessageMarkdown?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: Postfach 1.15 ]

Mindestberechtigungsstufe (Outlook): eingeschränkt

Anwendbarer Outlook-Modus: Compose

Wichtig

  • Die formatierte Fehlermeldung muss maximal 500 Zeichen lang sein.

  • Anleitungen zu unterstützten Markdownelementen finden Sie unter Einschränkungen beim Formatieren der Dialogmeldung mithilfe von Markdown.

  • Wenn Sie die Dialognachricht mit der errorMessageMarkdown -Eigenschaft formatieren, empfiehlt es sich, auch eine Klartextversion der Nachricht mithilfe der errorMessage -Eigenschaft hinzuzufügen. Dadurch wird sichergestellt, dass die Meldung in Outlook-Clients, die Markdown nicht unterstützen, ordnungsgemäß angezeigt wird.

sendModeOverride

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine allowEvent -Eigenschaft auf falsefestzulegen, überschreibt diese Eigenschaft die im Manifest angegebene Sendemodusoption zur Laufzeit.

Ein Beispiel finden Sie in der exemplarischen Vorgehensweise zu intelligenten 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: Derzeit sendModeOverride kann nur auf die Option benutzereingabeaufforderung festgelegt werden.