Office.SmartAlertsEventCompletedOptions interface

Referencia

Paquete:: outlook

Especifica el comportamiento de un complemento alertas inteligentes cuando finaliza el procesamiento de un OnMessageSend evento o OnAppointmentSend .

Comentarios

[ Conjunto de API: Buzón 1.12 ]

Nivel mínimo de permiso (Outlook):restringido

Modo de Outlook aplicable: Compose

Ejemplos

// The following example checks whether a location is specified in an appointment before it's sent.
function onAppointmentSendHandler(event) {
    Office.context.mailbox.item.location.getAsync({ asyncContext: event }, asyncResult => {
        const event = asyncResult.asyncContext;
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(asyncResult.error.message);
            // If the add-in is unable to retrieve the appointment's location, the appointment isn't sent.
            event.completed({ allowEvent: false, errorMessage: "Failed to get the appointment's location." });
            return;
        }

        if (asyncResult.value === "") {
            // If no location is specified, the appointment isn't sent and the user is alerted to include a location.
            event.completed(
                {
                    allowEvent: false,
                    cancelLabel: "Add a location",
                    commandId: "msgComposeOpenPaneButton",
                    contextData: JSON.stringify({ a: "aValue", b: "bValue" }),
                    errorMessage: "Don't forget to add a meeting location.",
                    errorMessageMarkdown: `
                        Don't forget to add a meeting location.\n\n
                        **Tip**: For a list of locations,
                        see [Meeting Locations]("https://www.contoso.com/meeting-locations).`,
                    sendModeOverride: Office.MailboxEnums.SendModeOverride.PromptUser
                }
            );
        } else {
            // If a location is specified, the appointment is sent.
            event.completed({ allowEvent: true });
        }
    });
}

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 que controla el OnMessageSend evento o OnAppointmentSend puede establecerse allowEventfalse en para cancelar el envío de un elemento. Para obtener un ejemplo completo, consulte el tutorial alertas inteligentes.

errorMessage

Cuando se usa el método completado para indicar la finalización de un controlador de eventos y establecer su allowEvent propiedad falseen , esta propiedad establece el mensaje de error que se mostrará al usuario. Para obtener un ejemplo, consulte el tutorial alertas inteligentes.