Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
El subconjunto de api de complemento de Outlook de la API de JavaScript de Office incluye objetos, métodos, propiedades y eventos que puede usar en un complemento de Outlook.
Las API de versión preliminar están sujetas a cambios y no están diseñadas para su uso en un entorno de producción. Le recomendamos que solo las pruebe en entornos de desarrollo y pruebas. No use las API de versión preliminar en un entorno de producción o en documentos críticos para la empresa.
Usar las API en versión preliminar:
Debe usar la versión preliminar de la biblioteca de API de JavaScript de Office desde la red de entrega de contenido (CDN) deOffice.js. El tipo de archivo de definición para la compilación TypeScript e IntelliSense se encuentra en la CDN y DefinitelyTyped. Puede instalar estos tipos con
npm install --save-dev @types/office-js-preview(asegúrese de quitar los tipos para@types/office-jssi los ha instalado anteriormente).Es posible que tenga que unirse al programa Microsoft 365 Insider para acceder a compilaciones de Office más recientes en Outlook en Windows y en Mac.
Es posible que tenga que configurar la opción Versión dirigida en el inquilino de Microsoft 365 para obtener una vista previa de las características de Outlook en la Web. Para obtener más información, consulte la sección "Versión dirigida" de Configuración de las opciones de versión Standard o De destino.
El conjunto de requisitos de versión preliminar incluye todas las características del conjunto de requisitos 1.15.
Importante
Esta documentación es para un conjunto de requisitos de versión preliminar. Este conjunto de requisitos aún no está totalmente implementado y los clientes no notificarán con precisión la compatibilidad con él. No debe especificar este conjunto de requisitos en el manifiesto del complemento.
Características de la versión preliminar
Las características siguientes están en versión preliminar.
- Se ha agregado un evento y objetos para admitir el descifrado de un mensaje y sus datos adjuntos.
- Compatibilidad extendida con la
contentIdpropiedad para obtener el identificador de contenido de los datos adjuntos insertados en Outlook clásico en Windows. - Se ha agregado un método para comprobar si los tokens de Exchange Web Services (EWS) son compatibles con una organización.
- Se han actualizado las API de destinatarios para aumentar el número máximo de destinatarios de un campo de destino a 1000.
- Se ha aumentado el límite de objetos SessionData a 2.621.440 caracteres.
- Compatibilidad ampliada con la
errorMessageMarkdownpropiedad delevent.completedmétodo para complementos de alertas inteligentes en Outlook en Mac. - Se ha agregado una propiedad para obtener o establecer si una cita es un evento de todo el día.
- Se han agregado eventos para activar un complemento basado en eventos en un mensaje en modo de lectura cuando contiene determinados tipos de datos adjuntos o encabezados de Internet personalizados.
- Se ha agregado una propiedad y objetos para establecer temporalmente el cuerpo o el asunto mostrados en modo de lectura.
Lista de API
En la tabla siguiente se enumeran las API de JavaScript de Outlook actualmente en versión preliminar. Para ver la documentación de referencia de API para todas las API de JavaScript de Outlook (incluidas las API de versión preliminar y las API publicadas anteriormente), consulte API de Outlook.
| Clase | Campos | Descripción |
|---|---|---|
| AppointmentCompose | isAllDayEvent | Obtiene o establece la propiedad Office.IsAllDayEvent de una cita. |
| AppointmentRead | isAllDayEvent | Devuelve un valor booleano que indica si el evento está todo el día. |
| DecryptedMessageAttachment | attachmentType | Especifica el tipo de datos adjuntos. |
| content | Especifica el contenido codificado en Base64 de los datos adjuntos. | |
| contentId | Especifica el identificador de contenido de los datos adjuntos insertados. | |
| isInline | Si es true, especifica que los datos adjuntos descifrados aparecen como una imagen en el cuerpo del mensaje en lugar de en la lista de datos adjuntos. | |
| name | Especifica el nombre de los datos adjuntos. | |
| ruta de acceso | Especifica la ruta de acceso de referencia de dirección URL de los datos adjuntos si su tipo es MailboxEnums.AttachmentType.Cloud. |
|
| DecryptedMessageBody | coercionType | Especifica el formato del cuerpo de un mensaje. |
| content | Especifica el contenido que se muestra en el cuerpo del mensaje. | |
| Diagnóstico | ews | Obtiene un objeto para identificar si los tokens de devolución de llamada de Exchange Web Services (EWS) son compatibles con una organización. |
| Display | body | Obtiene un objeto para establecer temporalmente el contenido mostrado en el cuerpo de un mensaje en modo de lectura. |
| subject | Obtiene un objeto para establecer temporalmente el contenido mostrado en el asunto de un mensaje en modo de lectura. | |
| DisplayedBody | setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece temporalmente el contenido que se muestra en el cuerpo de un mensaje en modo de lectura. |
| setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece temporalmente el contenido que se muestra en el cuerpo de un mensaje en modo de lectura. | |
| DisplayedSubject | setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece temporalmente el contenido mostrado en el asunto de un mensaje en modo de lectura. |
| setAsync(data: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece temporalmente el contenido mostrado en el asunto de un mensaje en modo de lectura. | |
| Ews | getTokenStatusAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void) | Obtiene el estado de los tokens de devolución de llamada de EWS en una organización. |
| getTokenStatusAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void) | Obtiene el estado de los tokens de devolución de llamada de EWS en una organización. | |
| IsAllDayEvent | getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void) | Obtiene el valor booleano que indica si el evento es todo el día o no. |
| getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void) | Obtiene el valor booleano que indica si el evento es todo el día o no. | |
| setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece el estado de evento de todo el día de una cita. | |
| setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece el estado de evento de todo el día de una cita. | |
| MailboxEvent | completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions | MessageDecryptEventCompletedOptions) | Indica que el complemento basado en eventos, informes de correo no deseado o descifrado (versión preliminar) ha completado el procesamiento de un evento. |
| MessageDecryptEventCompletedOptions | allowEvent | Cuando se usa el método completed para indicar la finalización de un controlador de eventos, |
| attachments | Cuando se usa el método completado para indicar la finalización de un controlador de eventos | |
| contextData | Cuando se usa el método completado para indicar la finalización de un controlador de eventos | |
| emailBody | Cuando se usa el método completado para indicar la finalización de un controlador de eventos | |
| MessageRead | Monitor | Obtiene un objeto para establecer temporalmente el contenido mostrado en el cuerpo o asunto de un mensaje en modo de lectura. |
| TokenStatus | Deshabilitada | Los tokens de devolución de llamada de EWS o los tokens de API REST están desactivados en la organización. |
| Habilitado | Los tokens de devolución de llamada de EWS o los tokens de API REST se admiten en la organización. | |
| Eliminación | El buzón de correo se hospeda en un entorno de Exchange Online donde los tokens EWS están desactivados y ya no se admiten. |