Office.AddinCommands.EventCompletedOptions interface

Пакет:

office

Указывает поведение надстройки при отправке, надстройки поставщика онлайн-собраний или мобильной надстройки с ведением журнала заметок , когда она завершает обработку события в Outlook.

Комментарии

[ Набор API: Почтовый ящик 1.8 ]

Минимальный уровень разрешений: ограниченный

Применимый режим Outlook: Compose

Важно! Хотя Outlook в Android и в iOS поддерживает до почтового ящика 1.5, EventCompletedOptions объект поддерживается в мобильных надстройках поставщика собраний по сети и ведения журнала заметок. Дополнительные сведения о поддержке API в Outlook на мобильных устройствах см. в статье API JavaScript, поддерживаемые в Outlook на мобильных устройствах.

Свойства

allowEvent

При использовании метода completed для сигнала о завершении обработчика событий это значение указывает, следует ли продолжить выполнение обработанного события или отменить его. Например, надстройка при отправке, которая обрабатывает ItemSend событие, может задать значение allowEvent , false чтобы отменить отправку сообщения.

Сведения о свойстве

allowEvent

При использовании метода completed для сигнала о завершении обработчика событий это значение указывает, следует ли продолжить выполнение обработанного события или отменить его. Например, надстройка при отправке, которая обрабатывает ItemSend событие, может задать значение allowEvent , false чтобы отменить отправку сообщения.

allowEvent: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: Почтовый ящик 1.8 ]

Минимальный уровень разрешений (Outlook):ограниченный

Применимый режим Outlook: Compose

Примеры

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