Office.SmartAlertsEventCompletedOptions interface

  • Référence
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

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

Niveau d’autorisation minimal (Outlook) : restreint

Mode Outlook applicable : Compose

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.",
                    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 });
        }
    });
}

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

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é personnalise le texte du bouton Ne pas envoyer dans la boîte de dialogue Alertes intelligentes. Le texte personnalisé doit contenir 20 caractères ou moins.

Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.
commandId

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é falsesur , cette propriété spécifie l’ID du volet Office ou de la fonction qui s’exécute lorsque le bouton Ne pas envoyer est sélectionné dans la boîte de dialogue Alertes intelligentes.

Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.
contextData

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é spécifie toutes les données JSON transmises au complément pour traitement lorsque le bouton Ne pas envoyer est sélectionné dans la boîte de dialogue 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 affiché à l’utilisateur. Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.
errorMessageMarkdown

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 affiché à l’utilisateur. Le message d’erreur est mis en forme à l’aide de Markdown. Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.
sendModeOverride

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é remplace l’option de mode d’envoi spécifiée dans le manifeste au moment de l’exécution.

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 : Compose

cancelLabel

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é personnalise le texte du bouton Ne pas envoyer dans la boîte de dialogue Alertes intelligentes. Le texte personnalisé doit contenir 20 caractères ou moins.

Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.

cancelLabel?: string;

Valeur de propriété

string

Remarques

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

Niveau d’autorisation minimal (Outlook) : restreint

Mode Outlook applicable : Compose

commandId

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é falsesur , cette propriété spécifie l’ID du volet Office ou de la fonction qui s’exécute lorsque le bouton Ne pas envoyer est sélectionné dans la boîte de dialogue Alertes intelligentes.

Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.

commandId?: string;

Valeur de propriété

string

Remarques

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

Niveau d’autorisation minimal (Outlook) : restreint

Mode Outlook applicable : Compose

Important:

La commandId valeur doit correspondre au volet Office ou à l’ID de fonction spécifié dans le manifeste de votre complément. Le balisage dépend du type de manifeste utilisé par votre complément.

  • Manifeste de complément uniquement : id attribut de l’élément Control représentant la fonction ou le volet Office.

  • Manifeste unifié pour Microsoft 365 : propriété « id » du volet Office ou de la commande de fonction dans le tableau « controls ».

Si vous spécifiez l’option contextData dans votre event.completed appel, vous devez également affecter un ID de volet office ou de fonction à l’option commandId . Sinon, les données JSON affectées à contextData sont ignorées.

contextData

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é spécifie toutes les données JSON transmises au complément pour traitement lorsque le bouton Ne pas envoyer est sélectionné dans la boîte de dialogue Alertes intelligentes.

contextData?: any;

Valeur de propriété

any

Remarques

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

Niveau d’autorisation minimal (Outlook) : restreint

Mode Outlook applicable : Compose

Important:

  • Dans Outlook sur Windows, le any type est pris en charge à partir de la version 2402 (build 17308.20000). Dans les versions antérieures d’Outlook sur Windows, seul le string type est pris en charge.

  • Si vous spécifiez l’option contextData dans votre event.completed appel, vous devez également affecter un ID de volet Office à l’option commandId . Sinon, les données JSON affectées à contextData sont ignorées.

  • Pour récupérer la valeur de la contextData propriété, vous devez appeler Office.context.mailbox.item.getInitializationContextAsync dans l’implémentation JavaScript de votre volet Office. Si vous créez une chaîne JSON à l’aide JSON.stringify() de et que vous l’attribuez à la contextData propriété , vous devez analyser la chaîne à l’aide JSON.parse() de une fois que vous l’avez récupérée.

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 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 : Compose

errorMessageMarkdown

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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 affiché à l’utilisateur. Le message d’erreur est mis en forme à l’aide de Markdown. Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.

errorMessageMarkdown?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal (Outlook) : restreint

Mode Outlook applicable : Compose

Important

  • Le message d’erreur mis en forme doit contenir au maximum 500 caractères.

  • Pour obtenir des conseils sur les éléments Markdown pris en charge, consultez Limitations de la mise en forme du message de boîte de dialogue à l’aide de Markdown.

  • Si vous mettez en forme le message de boîte de dialogue à l’aide de la errorMessageMarkdown propriété , nous vous recommandons d’ajouter également une version en texte clair du message à l’aide de la errorMessage propriété . Cela garantit que le message s’affiche correctement dans les clients Outlook qui ne prennent pas en charge Markdown.

sendModeOverride

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é remplace l’option de mode d’envoi spécifiée dans le manifeste au moment de l’exécution.

Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.

sendModeOverride?: MailboxEnums.SendModeOverride | string;

Valeur de propriété

Office.MailboxEnums.SendModeOverride | string

Remarques

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

Niveau d’autorisation minimal (Outlook) : restreint

Mode Outlook applicable : Compose

Important : Actuellement, sendModeOverride ne peut être défini que sur l’option d’invite utilisateur .