Office.SmartAlertsEventCompletedOptions interface

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 de un botón 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 desde un botón 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 se selecciona el botón correspondiente 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 de un botón 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

Importante:

El botón personalizable del cuadro de diálogo Alertas inteligentes varía según el cliente de Outlook y su versión.

• En Outlook en la Web, nueva Outlook en Windows y Outlook clásico en Windows a partir de la versión 2412 (compilación 18324.20000), la cancelLabel propiedad personaliza el texto del botón Tomar acción. El botón Tomar acción solo aparece en el cuadro de diálogo Alertas inteligentes si la commandId opción está configurada en la event.completed llamada. La opción debe configurarse si desea personalizar el texto del botón de diálogo. En esta implementación, el botón No enviar cancela el elemento que se va a enviar. Su texto y funcionalidad no se pueden personalizar. Si anteriormente personalizó el texto del botón No enviar sin asignarle un panel de tareas o un comando de función, el texto personalizado no surtirá efecto en las últimas versiones de cliente de Outlook. Si anteriormente asignó un panel de tareas o un comando de función al botón No enviar , no se necesita ninguna acción adicional para implementar el botón Tomar acción en las versiones más recientes. El botón Tomar acción predeterminado o personalizado aparecerá automáticamente la próxima vez que un usuario reciba un cuadro de diálogo Alertas inteligentes. Aunque no se necesitan cambios en la implementación, se recomienda notificar a los usuarios esta experiencia actualizada.

• En versiones anteriores admitidas de Outlook clásico en Windows (versiones anteriores a la versión 2412 (compilación 18324.20000) que admiten el conjunto de requisitos de buzón 1.14) y Outlook en Mac (versión preliminar), la cancelLabel propiedad personaliza el texto del botón No enviar . El botón No enviar cancela el elemento que se va a enviar.

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 desde un botón 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".

El botón del cuadro de diálogo Alertas inteligentes que abre un panel de tareas o ejecuta una función varía según el cliente y la versión de Outlook. En Outlook en la Web, nuevo Outlook en Windows y Outlook clásico en Windows a partir de la versión 2412 (compilación 18324.20000), el botón Tomar acción abre un panel de tareas o ejecuta una función. En esta implementación, el botón No enviar cancela el elemento que se va a enviar. Su texto y funcionalidad no se pueden personalizar. En versiones anteriores admitidas de Outlook clásico en Windows (versiones anteriores a la versión 2412 (compilación 18324.20000) que admiten el conjunto de requisitos de buzón 1.14) y Outlook en Mac (versión preliminar), el botón No enviar abre un panel de tareas o ejecuta una función.

Si personalizó el texto y la funcionalidad del botón No enviar en el complemento Alertas inteligentes antes de la versión 2412 (compilación 18324.20000) de Outlook clásico en Windows, no se necesita ninguna acción adicional para implementar el botón Tomar acción en las versiones compatibles más recientes. El botón Tomar acción predeterminado o personalizado aparecerá automáticamente la próxima vez que un usuario reciba un cuadro de diálogo Alertas inteligentes. Aunque no se necesitan cambios en la implementación, se recomienda notificar a los usuarios esta experiencia actualizada.

Si especifica un identificador de comando que no existe, en función del cliente de Outlook, el botón Tomar acción o No enviar simplemente cancela el elemento que se va a enviar.

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 .

Al configurar un botón en el cuadro de diálogo Alertas inteligentes para ejecutar una función, también se agrega un botón para la función a la cinta de opciones o a la barra de acciones del cliente de Outlook. Use la contextData opción para distinguir cuándo un usuario ejecuta la función desde el cuadro de diálogo 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 se selecciona el botón correspondiente 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 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 .

• El botón de diálogo que pasa el contextData valor al complemento varía según el cliente de Outlook y su versión. Para obtener más información, vea Personalizar el texto y la funcionalidad de un botón en el cuadro de diálogo.

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

• Al configurar un botón en el cuadro de diálogo Alertas inteligentes para ejecutar una función, también se agrega un botón para la función a la cinta de opciones o a la barra de acciones del cliente de Outlook. Use la contextData opción para distinguir cuándo un usuario ejecuta la función desde 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.

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

Importante: El mensaje de error debe tener 500 caracteres o menos.

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.

errorMessageMarkdown?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: Buzón 1.15 ]

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 .