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.

errorMessage

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