Office.SmartAlertsEventCompletedOptions interface

Paquet:

outlook

Spécifie le comportement d’un complément Alertes intelligentes lorsqu’il termine le traitement d’un OnMessageSend événement ou OnAppointmentSend .

Remarques

Exemples

// 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.",
                    sendModeOverride: Office.MailboxEnums.SendModeOverride.PromptUser
                }
            );
        } else {
            // If a location is specified, the appointment is sent.
            event.completed({ allowEvent: true });
        }
    });
}

Propriétés

allowEvent

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements, cette valeur indique si l’événement géré doit poursuivre l’exécution ou être annulé. Par exemple, un complément qui gère l’événement ou OnAppointmentSend peut définir falseallowEvent sur OnMessageSend pour annuler l’envoi d’un élément. Pour obtenir un exemple complet, consultez la procédure pas à pas des alertes intelligentes.

errorMessage

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa allowEvent propriété sur false, cette propriété définit le message d’erreur qui sera affiché à l’utilisateur. Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.

Détails de la propriété

allowEvent

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements, cette valeur indique si l’événement géré doit poursuivre l’exécution ou être annulé. Par exemple, un complément qui gère l’événement ou OnAppointmentSend peut définir falseallowEvent sur OnMessageSend pour annuler l’envoi d’un élément. Pour obtenir un exemple complet, consultez la procédure pas à pas des alertes intelligentes.

allowEvent?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : Boîte aux lettres 1.12 ]

Niveau d’autorisation minimal (Outlook) : restreint

Mode Outlook applicable : Composer

errorMessage

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa allowEvent propriété sur false, cette propriété définit le message d’erreur qui sera affiché à l’utilisateur. Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.

errorMessage?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : Boîte aux lettres 1.12 ]

Niveau d’autorisation minimal (Outlook) : restreint

Mode Outlook applicable : Composer