Office.SmartAlertsEventCompletedOptions interface

Paquet:: outlook

Spécifie le comportement d’un complément Smart Alerts lorsqu’il termine de traiter un OnMessageSend événement OR OnAppointmentSend .

Remarques

Jeu d’API : Boîte aux lettres 1.12

Niveau d’autorisation minimal (Outlook) : restreint

Mode Outlook applicable : Compose

Utilisateur

Office.MailboxEvent : terminé

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 la fin d’un gestionnaire d’événements, cette valeur indique si l’événement géré doit continuer l’exécution ou être annulé. Par exemple, un complément qui gère l’événement `OnMessageSend` ou `OnAppointmentSend` peut être configuré `allowEventfalse` 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 la fin d’un gestionnaire d’événements et 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 comporter au moins 20 caractères. Pour obtenir un exemple, consultez la procédure pas à pas des alertes intelligentes.
commandId	Lorsque vous utilisez la méthode completed pour signaler la fin d’un gestionnaire d’événements et que vous définissez sa `allowEvent` propriété sur `false`, cette propriété spécifie l’ID du volet Office ou de la fonction qui s’exécute à partir d’un bouton de la boîte de dialogue Alertes intelligentes. Pour obtenir un exemple, consultez la procédure pas à pas des alertes intelligentes.
contextData	Lorsque vous utilisez la méthode completed pour signaler la fin 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 la fin 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 des alertes intelligentes.
errorMessageMarkdown	Lorsque vous utilisez la méthode completed pour signaler la fin 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 des alertes intelligentes.
sendModeOverride	Lorsque vous utilisez la méthode completed pour signaler la fin 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 des alertes intelligentes.

Détails de la propriété

allowEvent

Lorsque vous utilisez la méthode completed pour signaler la fin d’un gestionnaire d’événements, cette valeur indique si l’événement géré doit continuer l’exécution ou être annulé. Par exemple, un complément qui gère l’événement OnMessageSend ou OnAppointmentSend peut être configuré allowEventfalse 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

Jeu 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 la fin d’un gestionnaire d’événements et 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 comporter au moins 20 caractères.

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

cancelLabel?: string;

Valeur de propriété

string

Remarques

Jeu 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, sur Mac (en préversion à partir de la version 16.105 (build 25121117)), 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 Agir. Le bouton Agir n’apparaît dans la boîte de dialogue Alertes intelligentes que 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 affecter un volet Office ou une commande de fonction, votre texte personnalisé ne prendra pas effet dans les dernières versions du client Outlook. Si vous avez précédemment affecté un volet Office ou une commande de fonction au bouton Ne pas envoyer , aucune action supplémentaire n’est nécessaire pour implémenter le bouton Agir dans les versions les plus récentes. Le bouton Agir par défaut ou personnalisé s’affiche automatiquement la prochaine fois qu’un utilisateur reçoit une boîte de dialogue Alertes intelligentes. Bien qu’aucune modification d’implémentation ne soit nécessaire, nous vous recommandons d’informer les utilisateurs de cette expérience mise à jour.
Dans Outlook sur Windows classique (antérieur à la version 2412 (build 18324.20000) et Outlook sur Mac (antérieur à la version 16.105 (build 25121117)), 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 la fin d’un gestionnaire d’événements et que vous définissez sa allowEvent propriété sur false, cette propriété spécifie l’ID du volet Office ou de la fonction qui s’exécute à partir d’un bouton de la boîte de dialogue Alertes intelligentes.

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

commandId?: string;

Valeur de propriété

string

Remarques

Jeu 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 de contrôle représentant le volet Office ou la fonction.
Manifeste unifié pour Microsoft 365 : propriété « id » du volet Office ou 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 selon le client et la version d’Outlook. Dans Outlook sur le web, sur Mac (en préversion à partir de la version 16.105 (build 25121117)), la nouvelle version d’Outlook sur Windows et Outlook sur Windows classique à partir de la version 2412 (build 18324.20000), le bouton Prendre une 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 le jeu de conditions requises de la boîte aux lettres 1.14) et d’Outlook sur Mac, le bouton Ne pas envoyer ouvre un volet Office ou exécute une fonction.

Si vous avez déjà 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 ou avant la version 16.105 (build 25121117) d’Outlook sur Mac, aucune action supplémentaire n’est nécessaire pour implémenter le bouton Agir dans les dernières versions prises en charge. Le bouton Agir par défaut ou personnalisé s’affiche automatiquement la prochaine fois qu’un utilisateur reçoit une boîte de dialogue Alertes intelligentes. Bien qu’aucune modification d’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 Agir ou Ne pas envoyer annule simplement l’élément envoyé.

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

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

La programmation d’un bouton dans la boîte de dialogue Alertes intelligentes pour exécuter une fonction est disponible en préversion dans Outlook sur Mac à partir de la version 16.105 (Build 25121117). Pour tester cette fonctionnalité, rejoignez le programme Microsoft 365 Insider et sélectionnez l’option Canal bêta pour accéder aux builds bêta d’Office.

contextData

Lorsque vous utilisez la méthode completed pour signaler la fin 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

Jeu d’API : Boîte aux lettres 1.14

Niveau d’autorisation minimal (Outlook) : restreint

Mode Outlook applicable : Compose

Important:

Dans Outlook sur Windows, le type est pris en charge à partir de la any 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 lors de votre event.completed appel, vous devez également lui affecter un volet Office ou un ID de commandId fonction. Sinon, les données JSON affectées sont contextData ignorées.
Le bouton de dialogue qui transmet la contextData valeur au complément varie en fonction du client Outlook et de sa version. Pour plus d’informations, voir 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 faire appel Office.context.mailbox.item.getInitializationContextAsync à l’implémentation JavaScript de votre volet Office. Si vous créez une chaîne JSON à l’aide JSON.stringify() de la propriété et que vous l’attribuez à la contextData propriété, vous devez analyser la chaîne à l’aide d’une JSON.parse() fois que vous l’avez récupérée.
Lorsque vous configurez un bouton de la boîte de dialogue Alertes intelligentes pour exécuter une fonction, un bouton correspondant à la fonction est également ajouté au ruban ou à la barre d’action du client Outlook. Utilisez l’option contextData permettant de distinguer quand un utilisateur exécute la fonction dans la boîte de dialogue Alertes intelligentes.
Pour empêcher le volet Office d’un complément Alertes intelligentes de redémarrer s’il est déjà ouvert, implémentez un gestionnaire pour l’événement Office.EventType.InitializationContextChanged . Vous pouvez ensuite transmettre les arguments de l’événement à la contextData propriété.

errorMessage

Lorsque vous utilisez la méthode completed pour signaler la fin 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 des alertes intelligentes.

errorMessage?: string;

Valeur de propriété

string

Remarques

Jeu 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 moins 500 caractères.
Si vous ne spécifiez pas de message dans la errorMessage propriété, le message par défaut suivant s’affiche à la place : «< Le nom> du complément empêche l’envoi de cet e-mail ».

errorMessageMarkdown

Lorsque vous utilisez la méthode completed pour signaler la fin 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 des alertes intelligentes.

errorMessageMarkdown?: string;

Valeur de propriété

string

Remarques

Jeu 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 comporter au moins 500 caractères.
Pour obtenir des instructions sur les éléments Markdown pris en charge, consultez Limitations à la mise en forme du message de dialogue à l’aide de Markdown.
Si vous mettez en forme le message de la boîte de dialogue à l’aide de la errorMessageMarkdown propriété, nous vous recommandons d’ajouter également une version en texte brut 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 la fin 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 des alertes intelligentes.

sendModeOverride?: MailboxEnums.SendModeOverride | string;

Valeur de propriété

Office.MailboxEnums.SendModeOverride | string

Remarques

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

Commentaires

Cette page a-t-elle été utile ?