Partager via

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

[ 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 d’un bouton 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 à partir d’un bouton dans la boîte de dialogue Alertes actives.

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 applicable 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 d’un bouton 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

Important:

Le bouton personnalisable dans la boîte de dialogue Alertes intelligentes varie en fonction du client Outlook et de sa version.

  • Dans Outlook sur le web, nouveau Outlook sur Windows et Outlook classique sur Windows à partir de la version 2412 (build 18324.20000), la cancelLabel propriété personnalise le texte du bouton Action. Le bouton Action s’affiche uniquement dans la boîte de dialogue Alertes intelligentes si l’option commandId est configurée dans l’appel event.completed . L’option doit être configurée si vous souhaitez personnaliser le texte du bouton de boîte de dialogue. Dans cette implémentation, le bouton Ne pas envoyer annule l’élément envoyé. Son texte et ses fonctionnalités ne peuvent pas être personnalisés. Si vous avez précédemment personnalisé le texte du bouton Ne pas envoyer sans lui attribuer une commande de volet office ou de fonction, votre texte personnalisé n’entrera pas en vigueur dans les dernières versions du client Outlook. Si vous avez précédemment affecté une commande de volet office ou de fonction au bouton Ne pas envoyer , aucune action supplémentaire n’est nécessaire pour implémenter le bouton Action dans les versions les plus récentes. Le bouton Prendre une action par défaut ou personnalisé apparaît automatiquement la prochaine fois qu’un utilisateur recevra une boîte de dialogue Alertes intelligentes. Bien qu’aucune modification de l’implémentation ne soit nécessaire, nous vous recommandons d’informer les utilisateurs de cette expérience mise à jour.

  • Dans les versions antérieures prises en charge d’Outlook classique sur Windows (versions antérieures à la version 2412 (build 18324.20000) qui prennent en charge l’ensemble de conditions requises de boîte aux lettres 1.14) et Outlook sur Mac, la cancelLabel propriété personnalise le texte du bouton Ne pas envoyer . Le bouton Ne pas envoyer annule l’élément envoyé.

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 à partir d’un bouton dans la boîte de dialogue Alertes actives.

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 (prise en charge du volet Office), Boîte aux lettres 1.15 (prise en charge des commandes de fonction) ]

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

Le bouton de la boîte de dialogue Alertes intelligentes qui ouvre un volet Office ou exécute une fonction varie en fonction du client Et de la version d’Outlook. Dans Outlook sur le web, nouvel Outlook sur Windows et Outlook sur Windows classique à partir de la version 2412 (build 18324.20000), le bouton Action ouvre un volet Office ou exécute une fonction. Dans cette implémentation, le bouton Ne pas envoyer annule l’élément envoyé. Son texte et ses fonctionnalités ne peuvent pas être personnalisés. Dans les versions antérieures prises en charge d’Outlook classique sur Windows (versions antérieures à la version 2412 (build 18324.20000) qui prennent en charge l’ensemble de conditions requises pour les boîtes aux lettres 1.14) et Outlook sur Mac, le bouton Ne pas envoyer ouvre un volet Office ou exécute une fonction.

Si vous avez personnalisé le texte et les fonctionnalités du bouton Ne pas envoyer dans votre complément Alertes intelligentes avant la version 2412 (build 18324.20000) d’Outlook classique sur Windows, aucune action supplémentaire n’est nécessaire pour implémenter le bouton Agir dans les dernières versions prises en charge. Le bouton Prendre une action par défaut ou personnalisé apparaît automatiquement la prochaine fois qu’un utilisateur recevra une boîte de dialogue Alertes intelligentes. Bien qu’aucune modification de l’implémentation ne soit nécessaire, nous vous recommandons d’informer les utilisateurs de cette expérience mise à jour.

Si vous spécifiez un ID de commande qui n’existe pas, en fonction de votre client Outlook, le bouton Effectuer une action ou Ne pas envoyer annule simplement l’élément envoyé.

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.

Lorsque vous configurez un bouton dans la boîte de dialogue Alertes intelligentes pour exécuter une fonction, un bouton pour la fonction est également ajouté au ruban ou à la barre d’action du client Outlook. Utilisez l’option contextData pour distinguer le moment où un utilisateur exécute la fonction de la boîte de dialogue 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 applicable 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 ou de fonction à l’option commandId . Sinon, les données JSON affectées à contextData sont ignorées.

  • Le bouton de boîte de dialogue qui transmet la contextData valeur au complément varie en fonction du client Outlook et de sa version. Pour plus d’informations, consultez Personnaliser le texte et les fonctionnalités d’un bouton dans la boîte de dialogue.

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

  • Lorsque vous configurez un bouton dans la boîte de dialogue Alertes intelligentes pour exécuter une fonction, un bouton pour la fonction est également ajouté au ruban ou à la barre d’action du client Outlook. Utilisez l’option contextData pour distinguer le moment où un utilisateur exécute la fonction de la boîte de dialogue Alertes intelligentes.

  • Pour empêcher le volet Office d’un complément Alertes intelligentes de se relancer s’il est déjà ouvert, implémentez un gestionnaire pour l’événement Office.EventType.InitializationContextChanged . Vous pouvez ensuite passer les arguments d’événement à la contextData propriété .

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

Important : le message d’erreur doit contenir au maximum 500 caractères.

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.

errorMessageMarkdown?: string;

Valeur de propriété

string

Remarques

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

Niveau d’autorisation minimal (Outlook) : restreint

Mode Outlook applicable : Compose

Important

  • La errorMessageMarkdown propriété est disponible en préversion dans Outlook sur Mac à partir de la version 16.103 (build 25102433). Pour tester la propriété, rejoignez le programme Microsoft 365 Insider et sélectionnez l’option Canal bêta pour accéder aux builds bêta d’Office.

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