Office.AddinCommands.EventCompletedOptions interface

Paquet:

office

Spécifie le comportement d’un complément d’envoi, d’un complément de fournisseur de réunion en ligne ou d’un complément mobile de journalisation des notes lorsqu’il termine le traitement d’un événement dans Outlook.

Remarques

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

Niveau d’autorisation minimal : restreint

Mode Outlook applicable : Compose

Important : Bien qu’Outlook sur Android et sur iOS prennent en charge jusqu’à Boîte aux lettres 1.5, l’objet est pris en charge dans les EventCompletedOptions compléments mobiles de fournisseur de réunion en ligne et de journalisation des notes. Pour plus d’informations sur la prise en charge des API dans Outlook sur les appareils mobiles, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

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 d’envoi qui gère l’événement peut définir allowEventfalse sur ItemSend pour annuler l’envoi d’un message.

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 d’envoi qui gère l’événement peut définir allowEventfalse sur ItemSend pour annuler l’envoi d’un message.

allowEvent: boolean;

Valeur de propriété

boolean

Remarques

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

Niveau d’autorisation minimal (Outlook) : restreint

Mode Outlook applicable : Compose

Exemples

// In this example, the checkMessage function was registered as an event handler for ItemSend.
function checkMessage(event) {
    // Get the item being sent.
    const outgoingMsg = Office.context.mailbox.item;

    // Check if subject contains "BLOCK".
    outgoingMsg.subject.getAsync(function (result) {
        // Subject is in `result.value`.
        // If search term "BLOCK" is found, don't send the message.
        const notFound = -1;
        const allowEvent = (result.value.indexOf('BLOCK') === notFound);
        event.completed({ allowEvent: allowEvent });
    });
}