Office.AddinCommands.EventCompletedOptions interface

Paket:
office

Gibt das Verhalten eines On-Send-Add-Ins, eines Onlinebesprechungsanbieters oder eines mobilen Add-Ins zur Notizprotokollierung an, wenn die Verarbeitung eines Ereignisses in Outlook abgeschlossen ist.

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Eingeschränkt

Anwendbarer Outlook-Modus: Compose

Wichtig:

  • Obwohl Outlook auf Android und iOS bis zu Postfach 1.5 Unterstützung bietet, wird das EventCompletedOptions Objekt in mobilen Add-Ins von Onlinebesprechungsanbietern und Notizprotokollierung unterstützt. Weitere Informationen zur API-Unterstützung in Outlook auf Mobilgeräten finden Sie unter In Outlook auf Mobilgeräten unterstützte Outlook-JavaScript-APIs.

  • Ereignisbasierte Aktivierungs - und integrierte Spambericht-Add-Ins verwenden ein anderes Ereignisobjekt, um zu signalisieren, wenn sie die Verarbeitung eines Ereignisses abgeschlossen haben. Weitere Informationen finden Sie unter Office.MailboxEvent.

Verwendet von

Eigenschaften

allowEvent

Wenn Sie die abgeschlossene 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, festlegen allowEvent , false dass das Senden einer Nachricht abgebrochen wird.

Details zur Eigenschaft

allowEvent

Wenn Sie die abgeschlossene 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, festlegen allowEvent , false dass das Senden einer Nachricht abgebrochen wird.

allowEvent?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe (Outlook):eingeschränkt

Anwendbarer Outlook-Modus: Compose

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