Office.SmartAlertsEventCompletedOptions interface
Especifica el comportamiento de un complemento alertas inteligentes cuando finaliza el procesamiento de un OnMessageSend
evento o OnAppointmentSend
.
Comentarios
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.",
sendModeOverride: Office.MailboxEnums.SendModeOverride.PromptUser
}
);
} else {
// If a location is specified, the appointment is sent.
event.completed({ allowEvent: true });
}
});
}
Propiedades
allow |
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 |
cancel |
Cuando se usa el método completado para indicar la finalización de un controlador de eventos y establecer su Para obtener un ejemplo, consulte el tutorial alertas inteligentes. |
command |
Cuando se usa el método completado para indicar la finalización de un controlador de eventos y establecer su Para obtener un ejemplo, consulte el tutorial alertas inteligentes. |
context |
Cuando se usa el método completado para indicar la finalización de un controlador de eventos y establecer su |
error |
Cuando se usa el método completado para indicar la finalización de un controlador de eventos y se establece su |
send |
Cuando se usa el método completado para indicar la finalización de un controlador de eventos y establecer su 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 allowEvent
false
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: Redacción
cancelLabel
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 establecer su allowEvent
propiedad false
en , 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: versión preliminar del buzón ]
Nivel mínimo de permiso (Outlook):restringido
Modo de Outlook aplicable: Redacción
commandId
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 establecer su allowEvent
propiedad false
en , esta propiedad especifica el identificador del panel de tareas que se abre 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: versión preliminar del buzón ]
Nivel mínimo de permiso (Outlook):restringido
Modo de Outlook aplicable: Redacción
Importante:
El commandId
valor debe coincidir con el identificador del panel de tareas especificado en el manifiesto del complemento. El marcado depende del tipo de manifiesto que use el complemento.
Manifiesto XML:
id
atributo del elemento Control que representa el panel de tareas.Manifiesto unificado para Microsoft 365 (versión preliminar): la propiedad "id" del comando del panel de tareas en la matriz "controls".
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
.
contextData
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 establecer su allowEvent
propiedad false
en , 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: versión preliminar del buzón ]
Nivel mínimo de permiso (Outlook):restringido
Modo de Outlook aplicable: Redacción
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 elstring
tipo .Si especifica la opción en
event.completed
lacontextData
llamada, también debe asignar un identificador de panel de tareas a lacommandId
opción. De lo contrario, se omiten los datos JSON asignados acontextData
.Para recuperar el valor de la
contextData
propiedad, debe llamar aOffice.context.mailbox.item.getInitializationContextAsync
en la implementación de JavaScript del panel de tareas. Si crea una cadena JSON medianteJSON.stringify()
y la asigna a lacontextData
propiedad , debe analizar la cadena medianteJSON.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 false
en , 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: Redacción
sendModeOverride
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 establecer su allowEvent
propiedad false
en , 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: versión preliminar del buzón ]
Nivel mínimo de permiso (Outlook):restringido
Modo de Outlook aplicable: Redacción
Importante: Actualmente, sendModeOverride
solo se puede establecer en la opción preguntar al usuario .
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de