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.
cancelLabel

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 personaliza el texto del botón No enviar en el cuadro de diálogo Alertas inteligentes. El texto personalizado debe tener 20 caracteres o menos.

Para obtener un ejemplo, consulte el tutorial alertas inteligentes.
commandId

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 especifica el identificador del panel de tareas o la función que se ejecuta cuando el botón No enviar está seleccionado en el cuadro de diálogo Alertas inteligentes.

Para obtener un ejemplo, consulte el tutorial alertas inteligentes.
contextData

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 especifica los datos JSON pasados al complemento para su procesamiento cuando el botón No enviar está seleccionado en el cuadro de diálogo Alertas inteligentes.
errorMessage

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

Cuando se usa el método completado para indicar la finalización de un controlador de eventos y se establece su allowEvent propiedad falseen , esta propiedad establece el mensaje de error que se muestra al usuario. El mensaje de error tiene formato mediante Markdown. Para obtener un ejemplo, consulte el tutorial alertas inteligentes.
sendModeOverride

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 invalida la opción de modo de envío especificada en el manifiesto en tiempo de ejecución.

Para obtener un ejemplo, consulte el tutorial alertas inteligentes.

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 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.

allowEvent?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: Buzón 1.12 ]

Nivel mínimo de permiso (Outlook):restringido

Modo de Outlook aplicable: Compose

cancelLabel

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 personaliza el texto del botón No enviar en el cuadro de diálogo Alertas inteligentes. El texto personalizado debe tener 20 caracteres o menos.

Para obtener un ejemplo, consulte el tutorial alertas inteligentes.

cancelLabel?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso (Outlook):restringido

Modo de Outlook aplicable: Compose

commandId

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 especifica el identificador del panel de tareas o la función que se ejecuta cuando el botón No enviar está seleccionado en el cuadro de diálogo Alertas inteligentes.

Para obtener un ejemplo, consulte el tutorial alertas inteligentes.

commandId?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso (Outlook):restringido

Modo de Outlook aplicable: Compose

Importante:

El commandId valor debe coincidir con el panel de tareas o el identificador de función especificado en el manifiesto del complemento. El marcado depende del tipo de manifiesto que use el complemento.

  • Manifiesto de solo complemento: id atributo del elemento Control que representa el panel de tareas o la función.

  • Manifiesto unificado para Microsoft 365: la propiedad "id" del panel de tareas o el comando de función de la matriz "controls".

Si especifica la opción en event.completed la contextData llamada, también debe asignar un panel de tareas o un identificador de función a la commandId opción. De lo contrario, se omiten los datos JSON asignados a contextData .

contextData

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 especifica los datos JSON pasados al complemento para su procesamiento cuando el botón No enviar está seleccionado en el cuadro de diálogo Alertas inteligentes.

contextData?: any;

Valor de propiedad

any

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso (Outlook):restringido

Modo de Outlook aplicable: Compose

Importante:

  • En Outlook en Windows, el tipo se admite a partir de la any versión 2402 (compilación 17308.20000). En versiones anteriores de Outlook en Windows, solo se admite el string tipo .

  • Si especifica la opción en event.completed la contextData llamada, también debe asignar un identificador de panel de tareas a la commandId opción. De lo contrario, se omiten los datos JSON asignados a contextData .

  • Para recuperar el valor de la contextData propiedad, debe llamar a Office.context.mailbox.item.getInitializationContextAsync en la implementación de JavaScript del panel de tareas. Si crea una cadena JSON mediante JSON.stringify() y la asigna a la contextData propiedad , debe analizar la cadena mediante JSON.parse() una vez que la recupere.

errorMessage

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

errorMessage?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: Buzón 1.12 ]

Nivel mínimo de permiso (Outlook):restringido

Modo de Outlook aplicable: Compose

errorMessageMarkdown

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

errorMessageMarkdown?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

Nivel mínimo de permiso (Outlook):restringido

Modo de Outlook aplicable: Compose

Importante

  • El mensaje de error con formato debe tener 500 caracteres o menos.

  • Para obtener instrucciones sobre los elementos Markdown admitidos, vea Limitaciones para dar formato al mensaje de diálogo mediante Markdown.

  • Si aplica formato al mensaje de diálogo mediante la errorMessageMarkdown propiedad , se recomienda agregar también una versión de texto no cifrado del mensaje mediante la errorMessage propiedad . Esto garantiza que el mensaje se muestre correctamente en los clientes de Outlook que no admiten Markdown.

sendModeOverride

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 invalida la opción de modo de envío especificada en el manifiesto en tiempo de ejecución.

Para obtener un ejemplo, consulte el tutorial alertas inteligentes.

sendModeOverride?: MailboxEnums.SendModeOverride | string;

Valor de propiedad

Office.MailboxEnums.SendModeOverride | string

Comentarios

[ Conjunto de API: Buzón 1.14 ]

Nivel mínimo de permiso (Outlook):restringido

Modo de Outlook aplicable: Compose

Importante: Actualmente, sendModeOverride solo se puede establecer en la opción preguntar al usuario .