Office.AddinCommands.EventCompletedOptions interface

  • Referenz
Paket:
office

Gibt das Verhalten eines On-Send-Add-Ins in Outlook an, wenn es die Verarbeitung eines ItemSend Ereignisses abgeschlossen hat.

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: eingeschränkt

Anwendbarer Outlook-Modus: Verfassen

Eigenschaften

allowEvent

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, gibt dieser Wert an, ob das behandelte Ereignis die Ausführung fortsetzen oder abgebrochen werden soll. Beispielsweise kann ein On-Send-Add-In, das das ItemSend Ereignis behandelt, auf false festlegenallowEvent, um das Senden einer Nachricht abzubrechen.

Details zur Eigenschaft

allowEvent

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, gibt dieser Wert an, ob das behandelte Ereignis die Ausführung fortsetzen oder abgebrochen werden soll. Beispielsweise kann ein On-Send-Add-In, das das ItemSend Ereignis behandelt, auf false festlegenallowEvent, um das Senden einer Nachricht abzubrechen.

allowEvent?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe (Outlook): eingeschränkt

Anwendbarer Outlook-Modus: Verfassen

Beispiele

// 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 });
    });
}