Office.AddinCommands.EventCompletedOptions interface
Especifica o comportamento de um suplemento ao enviar, suplemento de provedor de reunião online ou suplemento móvel de registro de notas quando conclui o processamento de um evento no Outlook.
Comentários
Conjunto de APIs: Caixa de Correio 1.8
Nível mínimo de permissão: restrito
Modo do Outlook aplicável: Compose
Importante:
Embora o Outlook no Android e no iOS dê suporte até a Caixa de Correio 1.5, o
EventCompletedOptionsobjeto tem suporte em suplementos móveis de provedor de reunião online e de registro de notas. Para obter mais informações sobre o suporte à API no Outlook em dispositivos móveis, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.A ativação baseada em eventos e os suplementos integrados de relatórios de spam usam um objeto de evento diferente para sinalizar quando concluíram o processamento de um evento. Para obter mais informações, consulte Office.MailboxEvent.
Usada por
Propriedades
| allow |
Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos, esse valor indica se o evento manipulado deve continuar a execução ou ser cancelado. Por exemplo, um suplemento ao enviar que manipula o |
Detalhes da propriedade
allowEvent
Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos, esse valor indica se o evento manipulado deve continuar a execução ou ser cancelado. Por exemplo, um suplemento ao enviar que manipula o ItemSend evento pode ser definido allowEvent como false para cancelar o envio de uma mensagem.
allowEvent?: boolean;Valor da propriedade
boolean
Comentários
Conjunto de APIs: Caixa de Correio 1.8
Nível mínimo de permissão (Outlook): restrito
Modo do 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 });
});
}