Office.AddinCommands.EventCompletedOptions interface

Paquete:

office

Especifica el comportamiento de un complemento de envío, un complemento de proveedor de reuniones en línea o un complemento móvil de registro de notas cuando finaliza el procesamiento de un evento en Outlook.

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso: restringido

Modo de Outlook aplicable: Compose

Importante: Aunque Outlook en Android y en iOS admiten hasta el buzón 1.5, el EventCompletedOptions objeto es compatible con el proveedor de reuniones en línea y los complementos móviles de registro de notas. Para obtener más información sobre la compatibilidad con API en Outlook en dispositivos móviles, vea API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.

Propiedades

allowEvent

Cuando se usa el método completado para indicar la finalización de un controlador de eventos, este valor indica si el evento controlado debe continuar la ejecución o cancelarse. Por ejemplo, un complemento de envío que controla el ItemSend evento puede establecerse allowEventfalse en para cancelar el envío de un mensaje.

Detalles de las propiedades

allowEvent

Cuando se usa el método completado para indicar la finalización de un controlador de eventos, este valor indica si el evento controlado debe continuar la ejecución o cancelarse. Por ejemplo, un complemento de envío que controla el ItemSend evento puede establecerse allowEventfalse en para cancelar el envío de un mensaje.

allowEvent: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: Buzón 1.8 ]

Nivel mínimo de permiso (Outlook):restringido

Modo de Outlook aplicable: Compose

Ejemplos

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