Office.SmartAlertsEventCompletedOptions interface

Paquete:

outlook

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

Comentarios

Conjunto de API: Buzón 1.12

Nivel mínimo de permisos (Outlook):restringido

Modo de Outlook aplicable: Compose

Usada por

• Office.MailboxEvent: completed

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 utiliza el método completed para indicar la finalización de un controlador de eventos, este valor indica si el evento controlado debe continuar con la ejecución o cancelarse. Por ejemplo, un complemento que controla el OnMessageSend evento o OnAppointmentSend se puede establecer allowEvent para false cancelar el envío de un elemento. Para obtener una muestra completa, consulte el tutorial de alertas inteligentes.
cancelLabel	Cuando utiliza el método completed para indicar la finalización de un controlador de eventos y establece su allowEvent propiedad en false, 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 de alertas inteligentes.
commandId	Cuando se utiliza el método completed para indicar la finalización de un controlador de eventos y se establece su allowEvent propiedad en false, esta propiedad especifica el identificador del panel de tareas o función que se ejecuta desde un botón del cuadro de diálogo Alertas inteligentes. Para obtener un ejemplo, consulte el tutorial de alertas inteligentes.
contextData	Cuando se utiliza el método completed para indicar la finalización de un controlador de eventos y se establece su allowEvent propiedad en false, esta propiedad especifica cualquier dato JSON que se pase al complemento para su procesamiento cuando se seleccione el botón aplicable en el cuadro de diálogo Alertas inteligentes.
errorMessage	Cuando utiliza el método completed para indicar la finalización de un controlador de eventos y establece su allowEvent propiedad en false, esta propiedad establece el mensaje de error que se muestra al usuario. Para obtener un ejemplo, consulte el tutorial de alertas inteligentes.
errorMessageMarkdown	Cuando utiliza el método completed para indicar la finalización de un controlador de eventos y establece su allowEvent propiedad en false, esta propiedad establece el mensaje de error que se muestra al usuario. El mensaje de error tiene formato de Markdown. Para obtener un ejemplo, consulte el tutorial de alertas inteligentes.
sendModeOverride	Cuando utiliza el método completed para indicar la finalización de un controlador de eventos y establece su allowEvent propiedad en false, 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 de alertas inteligentes.

Detalles de las propiedades

allowEvent

Cuando utiliza el método completed para indicar la finalización de un controlador de eventos, este valor indica si el evento controlado debe continuar con la ejecución o cancelarse. Por ejemplo, un complemento que controla el OnMessageSend evento o OnAppointmentSend se puede establecer allowEvent para false cancelar el envío de un elemento. Para obtener una muestra completa, consulte el tutorial de alertas inteligentes.

allowEvent?: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: Buzón 1.12

Nivel mínimo de permisos (Outlook):restringido

Modo de Outlook aplicable: Compose

cancelLabel

Cuando utiliza el método completed para indicar la finalización de un controlador de eventos y establece su allowEvent propiedad en false, 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 de alertas inteligentes.

cancelLabel?: string;

Valor de propiedad

string

Comentarios

Conjunto de API: Buzón 1.14

Nivel mínimo de permisos (Outlook):restringido

Modo de Outlook aplicable: Compose

Importante:

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

• En Outlook en la Web, en Mac (en versión preliminar a partir de la versión 16.105 (compilación 25121117)), el nuevo Outlook en Windows y el 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 Realizar acción. El botón Realizar acción solo aparece en el cuadro de diálogo de 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. El texto y la 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 versiones más recientes de cliente de Outlook. Si anteriormente asignó un panel de tareas o un comando de función al botón No enviar , no es necesario realizar ninguna acción adicional para implementar el botón Realizar acción en las versiones más recientes. El botón Tomar medidas predeterminado o personalizado aparecerá automáticamente la próxima vez que un usuario reciba un cuadro de diálogo de alertas inteligentes. Aunque no se necesitan cambios de implementación, se recomienda notificar a los usuarios esta experiencia actualizada.

• En Outlook para Windows clásico (antes de la versión 2412 (compilación 18324.20000) y Outlook para Mac (antes de la versión 16.105 (compilación 25121117)), 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 utiliza el método completed para indicar la finalización de un controlador de eventos y se establece su allowEvent propiedad en false, esta propiedad especifica el identificador del panel de tareas o función que se ejecuta desde un botón del cuadro de diálogo Alertas inteligentes.

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

commandId?: string;

Valor de propiedad

string

Comentarios

Conjunto de API: Buzón 1.14 (compatibilidad con el panel de tareas), Buzón 1.15 (compatibilidad con comandos de función)

Nivel mínimo de permisos (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: el id atributo del elemento de 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 en función del cliente y la versión de Outlook. En Outlook en la Web, en Mac (en versión preliminar a partir de la versión 16.105 (compilación 25121117)), el nuevo Outlook en Windows y el Outlook clásico en Windows a partir de la versión 2412 (compilación 18324.20000), el botón Realizar 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. El texto y la funcionalidad no se pueden personalizar. En versiones anteriores compatibles 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, el botón No enviar abre un panel de tareas o ejecuta una función.

Si ya 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 o antes de la versión 16.105 (compilación 25121117) de Outlook en Mac, no es necesario realizar ninguna acción adicional para implementar el botón Realizar acción en las versiones compatibles más recientes. El botón Tomar medidas predeterminado o personalizado aparecerá automáticamente la próxima vez que un usuario reciba un cuadro de diálogo de alertas inteligentes. Aunque no se necesitan cambios de implementación, se recomienda notificar a los usuarios esta experiencia actualizada.

Si especifica un id. de comando que no existe, dependiendo de su cliente de Outlook, el botón Realizar acción o No enviar simplemente cancela el elemento que se envía.

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

Cuando configura 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 o 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.

La programación de un botón en el cuadro de diálogo de alertas inteligentes para ejecutar una función está disponible para la vista previa en Outlook en Mac a partir de la versión 16.105 (compilación 25121117). Para probar esta característica, únase al programa Microsoft 365 Insider y seleccione la opción de canal beta para acceder a las compilaciones beta de Office.

contextData

Cuando se utiliza el método completed para indicar la finalización de un controlador de eventos y se establece su allowEvent propiedad en false, esta propiedad especifica cualquier dato JSON que se pase al complemento para su procesamiento cuando se seleccione el botón aplicable 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 permisos (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 asignarle un panel de tareas o un identificador de commandId función. De lo contrario, se omiten los datos JSON asignados contextData .

• El botón de cuadro de diálogo que pasa el contextData valor al complemento varía en función del 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 la implementación de JavaScript del panel de tareas. Si crea una cadena JSON y JSON.stringify() la asigna a la contextData propiedad, debe analizar la cadena una JSON.parse() vez que la recupere.

• Cuando configura 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 o 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.

• Para evitar que el panel de tareas de un complemento de alertas inteligentes se vuelva a iniciar si ya está abierto, implemente un controlador para el Office.EventType.InitializationContextChanged evento. A continuación, puede pasar los argumentos de evento a la contextData propiedad.

errorMessage

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

errorMessage?: string;

Valor de propiedad

string

Comentarios

Conjunto de API: Buzón 1.12

Nivel mínimo de permisos (Outlook):restringido

Modo de Outlook aplicable: Compose

Importante:

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

• Si no especifica un mensaje en la errorMessage propiedad, se mostrará el siguiente mensaje predeterminado en su lugar: "<El nombre> del complemento impide que se envíe este correo electrónico".

errorMessageMarkdown

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

errorMessageMarkdown?: string;

Valor de propiedad

string

Comentarios

Conjunto de API: Buzón 1.15

Nivel mínimo de permisos (Outlook):restringido

Modo de Outlook aplicable: Compose

Importante

• La errorMessageMarkdown propiedad está disponible para la versión preliminar en Outlook en Mac a partir de la versión 16.103 (compilación 25102433). Para probar la propiedad, únase al programa Microsoft 365 Insider y seleccione la opción de canal beta para acceder a las compilaciones beta de Office.

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

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

• Si da formato al mensaje de diálogo con la errorMessageMarkdown propiedad, le recomendamos que agregue también una versión en texto sin formato del mensaje con la errorMessage propiedad. Así se asegura de que el mensaje se muestre correctamente en los clientes de Outlook que no admiten Markdown.

sendModeOverride

Cuando utiliza el método completed para indicar la finalización de un controlador de eventos y establece su allowEvent propiedad en false, 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 de 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 permisos (Outlook):restringido

Modo de Outlook aplicable: Compose

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