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 seine allowEvent -Eigenschaft auf falsefestzulegen, passt diese Eigenschaft den Text der Schaltfläche Nicht senden 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 ausgeführt wird, wenn im Dialogfeld Intelligente Warnungen die Schaltfläche Don't Send (Nicht senden ) ausgewählt ist.

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 im Dialogfeld Smart Alerts die Schaltfläche Don't Send (Nicht senden ) 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 seine allowEvent -Eigenschaft auf falsefestzulegen, passt diese Eigenschaft den Text der Schaltfläche Nicht senden 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

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 ausgeführt wird, wenn im Dialogfeld Intelligente Warnungen die Schaltfläche Don't Send (Nicht senden ) ausgewählt ist.

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".

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.

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 im Dialogfeld Smart Alerts die Schaltfläche Don't Send (Nicht senden ) 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 commandId Option auch eine Aufgabenbereich-ID zuweisen. Andernfalls werden die JSON-Daten ignoriert, die zugewiesen contextData sind.

  • 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.

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

errorMessageMarkdown

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.

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: Postfachvorschau ]

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.