Office.AddinCommands.EventCompletedOptions interface

Pacote:

office

Especifica o comportamento de um suplemento no envio, suplemento de fornecedor de reunião online ou suplemento móvel de registo de notas quando concluir o processamento de um evento no Outlook.

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: restrito

Modo Outlook aplicável: Compose

Importante: embora o Outlook para Android e no iOS suporte até à Caixa de Correio 1.5, o EventCompletedOptions objeto é suportado no fornecedor de reuniões online e nos suplementos móveis de registo de notas. Para obter mais informações sobre o suporte de API no Outlook em dispositivos móveis, consulte ApIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.

Propriedades

allowEvent

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos, este valor indica se o evento processado deve continuar a execução ou se deve ser cancelado. Por exemplo, um suplemento no envio que processa o ItemSend evento pode ser definido allowEvent para false cancelar o envio de uma mensagem.

Detalhes da propriedade

allowEvent

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos, este valor indica se o evento processado deve continuar a execução ou se deve ser cancelado. Por exemplo, um suplemento no envio que processa o ItemSend evento pode ser definido allowEvent para false cancelar o envio de uma mensagem.

allowEvent: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão (Outlook): restrito

Modo Outlook aplicável: Compose

Exemplos

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