Conjunto de requisitos de la API de complementos de Outlook 1.3

El subconjunto de API de complementos de Outlook de la API de JavaScript de Office incluye objetos, métodos, propiedades y eventos que puede usar en un complemento de Outlook.

Nota:

Esta documentación es para un conjunto de requisitos que no sea el último conjunto de requisitos.

Novedades de la versión 1.3

El conjunto de requisitos de buzón 1.3 incluye todas las características del conjunto de requisitos 1.2. Se han agregado las siguientes características.

  • Agregada compatibilidad con comandos de función. Para obtener más información, vea Comandos de complemento.

  • Se ha agregado un método para guardar un elemento que se está redactando como borrador.

  • Se ha agregado un método para cerrar un elemento que se está redactando.

  • Se han agregado métodos para obtener o establecer todo el cuerpo de un mensaje o una cita. Para obtener más información, consulte Obtener o establecer el cuerpo de un mensaje o una cita en Outlook.

  • Se han agregado métodos para convertir identificadores de elementos entre los formatos EWS y REST.

    Importante

    Los tokens de identidad de usuario y los tokens de devolución de llamada de Exchange Online heredados ya no se admiten y están desactivados en todos los inquilinos de Microsoft 365. Si un complemento de Outlook requiere acceso de usuario delegado o identidad de usuario, se recomienda usar MSAL (Biblioteca de autenticación de Microsoft) y la autenticación de aplicaciones anidadas (NAA). Los tokens de identidad de usuario de Exchange aún se admiten para Exchange local.

  • Se han agregado una propiedad y métodos para agregar, obtener, reemplazar y quitar mensajes de notificación de un elemento.

Lista de API

En la tabla siguiente se enumeran las API introducidas en el conjunto de requisitos de buzón 1.3. Para ver la documentación de referencia de API de todas las API admitidas por el conjunto de requisitos de buzón 1.3 o versiones anteriores, consulte API de Outlook.

Clase Campos Descripción
AppointmentCompose close() Cierra el elemento actual que se está redactando.
notificationMessages Obtiene los mensajes de notificación de un elemento.
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Guarda un elemento de forma asincrónica.
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Guarda un elemento de forma asincrónica.
AppointmentRead notificationMessages Obtiene los mensajes de notificación de un elemento.
Cuerpo getAsync(coercionType: Office.CoercionType | string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Devuelve todo el cuerpo actual en el formato especificado por coercionType.
getAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: cadena> Office.AsyncResult<) => void) Devuelve todo el cuerpo actual en el formato especificado por coercionType.
setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Reemplaza todo el cuerpo con el texto especificado.
setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<void>) => void) Reemplaza todo el cuerpo con el texto especificado.
Buzón convertToEwsId(id: string, restVersion: MailboxEnums.RestVersion | string) Convierte un identificador admitido al formato de servicios Web Exchange (EWS).
convertToRestId(id: string, restVersion: MailboxEnums.RestVersion | string) Convierte un identificador admitido en formato REST.
MessageCompose close() Cierra el elemento actual que se está redactando.
notificationMessages Obtiene los mensajes de notificación de un elemento.
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Guarda de forma asincrónica el mensaje actual como borrador.
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Guarda de forma asincrónica el mensaje actual como borrador.
MessageRead notificationMessages Obtiene los mensajes de notificación de un elemento.
NotificationMessageDetails icon Referencia a un icono personalizado que se define en el manifiesto.
key El identificador para el mensaje de notificación.
message El texto del mensaje de notificación.
persistente Especifica si el mensaje debe ser persistente.
type Especifica el ItemNotificationMessageType del mensaje.
NotificationMessages addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void) Agrega una notificación a un elemento.
addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Agrega una notificación a un elemento.
getAllAsync(callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void) Devuelve todas las claves y los mensajes de un elemento.
getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void) Devuelve todas las claves y los mensajes de un elemento.
removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Quita un mensaje de notificación de un elemento.
removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Quita un mensaje de notificación de un elemento.
replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void) Reemplaza un mensaje de notificación que tiene una clave determinada con otro mensaje.
replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Reemplaza un mensaje de notificación que tiene una clave determinada con otro mensaje.
ItemNotificationMessageType ErrorMessage El mensaje de notificación es un mensaje de error.
Mensaje informativo El mensaje de notificación es un mensaje informativo.
ProgressIndicator El mensaje de notificación es un indicador de progreso.
RestVersion Beta Beta.
v1_0 Versión 1.0.
v2_0 Versión 2.0.

Vea también

  • Last updated on