Conjuntos de requisitos de la API de JavaScript de Outlook
Los complementos de Outlook declaran qué versiones de API necesitan en su manifiesto. El marcado varía en función de si usa el formato de manifiesto de solo complemento o el manifiesto unificado para Microsoft 365.
La versión de la API se especifica mediante la propiedad "extensions.requirements.capabilities". Establezca la propiedad "capabilities.name" en "Mailbox" y la propiedad "capabilities.minVersion" en el conjunto de requisitos mínimos de API que admita los escenarios del complemento.
Por ejemplo, el siguiente fragmento de manifiesto indica un conjunto de requisitos mínimos de la versión 1.1.
"extensions": [
{
"requirements": {
"capabilities": [
{
"name": "Mailbox", "minVersion": "1.1"
}
]
},
...
}
Todas las API de Outlook pertenecen al conjunto de Mailboxrequisitos. El conjunto de requisitos Mailbox tiene versiones y cada nuevo conjunto de API que publicamos pertenece a una versión posterior del conjunto. No todos los clientes de Outlook admiten el conjunto más reciente de API, pero si un cliente de Outlook declara compatibilidad con un conjunto de requisitos, por lo general admite todas las API de ese conjunto de requisitos (consulte la documentación de una API o característica específica para ver si hay excepciones).
Establecer una versión mínima del conjunto de requisitos en los controles de manifiesto en los que el cliente de Outlook aparecerá el complemento. Si un cliente no admite el conjunto de requisitos mínimos, no carga el complemento. Por ejemplo, si se especifica la versión 1.3 del conjunto de requisitos, esto significa que el complemento no se mostrará en ningún cliente de Outlook que no admita al menos la versión 1.3.
Nota:
Aunque Outlook en Android y en iOS admiten hasta el conjunto de requisitos 1.5, el complemento móvil ahora puede implementar algunas API de conjuntos de requisitos posteriores. Para obtener más información sobre qué API se admiten en Outlook mobile, vea API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
Uso de API de conjuntos de requisitos posteriores
Establecer un conjunto de requisitos no limita las API disponibles que el complemento puede usar. Por ejemplo, si el complemento especifica el conjunto de requisitos "Buzón 1.1", pero se ejecuta en un cliente de Outlook que admite "Buzón 1.3", el complemento puede usar las API del conjunto de requisitos "Buzón 1.3".
Para usar una API más reciente, los desarrolladores pueden comprobar si una aplicación en concreto es compatible con el conjunto de requisitos mediante las siguientes acciones:
if (Office.context.requirements.isSetSupported('Mailbox', '1.3')) {
// Perform actions.
}
else {
// Provide alternate flow/logic.
}
Como alternativa, los desarrolladores pueden comprobar si existe una nueva API con la técnica estándar de JavaScript.
if (item.somePropertyOrMethod !== undefined) {
// Use item.somePropertyOrMethod.
item.somePropertyOrMethod;
}
Dichos controles no son necesarios para ninguna API que esté presente en la versión del conjunto de requisitos especificada en el manifiesto.
Elección de un conjunto de requisitos mínimos
Los desarrolladores deben usar el conjunto de requisitos más antiguo que contenga el conjunto fundamental de las API para su escenario, sin el que no funcionará el complemento.
Conjuntos de requisitos admitidos por los servidores de Exchange y los clientes de Outlook
En esta sección, se indica el rango de los conjuntos de requisitos admitidos por los clientes de Exchange Server y Outlook. Para obtener más información sobre los requisitos de servidor y cliente para ejecutar los complementos de Outlook, consulte Requisitos de complementos de Outlook.
Importante
Si el servidor de Exchange de destino y el cliente de Outlook admiten diferentes conjuntos de requisitos, su conjunto de requisitos será el rango inferior de ambos. Por ejemplo, si un complemento se ejecuta en Outlook 2019 en Windows (conjunto de requisitos más alto: 1.6) en Exchange 2016 (conjunto de requisitos más alto: 1.5), el complemento puede limitarse al conjunto de requisitos 1.5.
Soporte técnico de Exchange Server
Los siguientes servidores admiten complementos de Outlook.
| Producto | Versión de Exchange principal | Conjuntos admitidos de requisitos de la API |
|---|---|---|
| Exchange Online | Compilación más reciente |
1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14 IdentityAPI 1.31 |
| Exchange local2 | 2019 | 1.1, 1.2, 1.3, 1.4, 1.5 |
| 2016 | 1.1, 1.2, 1.3, 1.4, 1.5 |
Nota:
1 Para requerir que identity API establezca 1.3 en el código del complemento de Outlook, compruebe si se admite mediante una llamada a isSetSupported('IdentityAPI', '1.3'). No se admite su declaración en el manifiesto del complemento de Outlook. También puede determinar si la API es compatible al comprobar que no está undefined. Para obtener más información, consulte Usar API de conjuntos de requisitos posteriores.
2 Incluso si un complemento implementa características de conjuntos de requisitos no admitidos en un entorno local de Exchange, se puede agregar a un cliente de Outlook siempre que el conjunto de requisitos especificado en su manifiesto se alinee con los admitidos por Exchange local. Sin embargo, una característica implementada solo funcionará si el cliente de Outlook en el que está instalado el complemento admite el conjunto de requisitos mínimos necesario para una característica. Para determinar los conjuntos de requisitos admitidos por distintos clientes de Outlook, consulte Compatibilidad con clientes de Outlook. Se recomienda complementar esto con la documentación sobre la característica específica para las excepciones.
Compatibilidad con el cliente de Outlook
Los complementos son compatibles con Outlook en las siguientes plataformas.
Nota:
1 Los complementos no se admiten en Outlook en Android, en iOS y en la web móvil moderna con cuentas de Exchange locales. Algunos dispositivos iOS siguen siendo compatibles con complementos al usar cuentas de Exchange locales con Outlook en la Web clásicas. Para obtener información acerca de los dispositivos compatibles, consulta Requisitos para ejecutar complementos de Office.
2 Los complementos no funcionan en Outlook en la Web modernos en smartphones iPhone y Android. Para obtener información acerca de los dispositivos compatibles, consulta Requisitos para ejecutar complementos de Office.
3 Para requerir que identity API establezca 1.3 en el código del complemento de Outlook, compruebe si se admite mediante una llamada a isSetSupported('IdentityAPI', '1.3'). No se admite su declaración en el manifiesto del complemento de Outlook. También puede determinar si la API es compatible al comprobar que no está undefined. Para obtener más información, consulte Usar API de conjuntos de requisitos posteriores.
4 Para obtener información sobre las versiones mínimas admitidas para conjuntos de requisitos recientes en Outlook clásico en Windows con una suscripción de Microsoft 365 o una licencia perpetuo comercial, consulte Compatibilidad de versiones para conjuntos de requisitos en Outlook clásico en Windows.
5 Se agregó compatibilidad con la versión 1.4 en Outlook 2016 perpetuas con licencia por volumen como parte de la actualización del 3 de julio de 2018 para Office 2016 (KB4022223).
6 La compatibilidad con la nueva interfaz de usuario de Mac está disponible en outlook versión 16.38.506. Para más información, consulte la sección Compatibilidad con complementos en Outlook para la nueva interfaz de usuario de Mac.
7 Aunque outlook clásico en Mac no admite el conjunto de requisitos de buzón 1.9, sí admite el conjunto de requisitos DialogApi 1.2. Para obtener información sobre la versión mínima admitida y la compilación, consulte Conjuntos de requisitos de la API de cuadro de diálogo.
8 Actualmente, hay consideraciones adicionales al diseñar e implementar complementos para clientes móviles. Para obtener más información, vea consideraciones de código al agregar compatibilidad con comandos de complemento en Outlook en dispositivos móviles. Aunque Outlook en Android y en iOS admiten hasta el conjunto de requisitos 1.5, el complemento móvil ahora puede implementar algunas API de conjuntos de requisitos posteriores. Para obtener más información sobre qué API se admiten en Outlook mobile, vea API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
Sugerencia
Para distinguir entre la versión clásica y moderna de Outlook en un explorador web, compruebe la barra de herramientas del buzón.
versión moderna
clásica
Compatibilidad con versiones para conjuntos de requisitos en Outlook clásico en Windows
En la tabla siguiente se muestra la compatibilidad con versiones para conjuntos de requisitos de buzón más recientes en Outlook clásico en Windows con una suscripción de Microsoft 365 o una licencia perpetua comercial.
| Conjunto de requisitos | Versión |
|---|---|
| 1.8 | Versión 1910 (compilación 12130.20272) |
| 1.9 | Versión 2008 (compilación 13127.20296) |
| 1.10 | Versión 2104 (Compilación 13929.20296) |
| 1.11 | Versión 2110 (Compilación 14527.20226) |
| 1.12 | Versión 2206 (compilación 15330.20196) |
| 1.13 | Versión 2304 (compilación 16327.20248) |
| 1.14 | Versión 2404 (compilación 17530.15000) |
Para obtener más información sobre la versión de cliente, vea la página historial de actualizaciones de Microsoft 365 u Office 2024 y cómo buscar la versión del cliente de Office y el canal de actualización.
Referencia a la biblioteca de producción de la API de JavaScript de Office
Para usar las API en cualquiera de los conjuntos de requisitos numerados, debe hacer referencia a la biblioteca de producción en la red de entrega de contenido (CDN) de Office.js. Para obtener información sobre cómo usar las API de versión preliminar, consulte Probar API de versión preliminar.
Api de versión preliminar de prueba
Las nuevas API de JavaScript de Outlook primero se presentan en "versión preliminar" y, luego, pasan a formar parte de un conjunto de requisitos numerados específico después de que se realicen suficientes pruebas y se adquieran suficientes comentarios de los usuarios. Para proporcionar comentarios sobre una API en versión preliminar, use el mecanismo de comentarios al final de la página web donde se proporciona documentación para la API.
Nota:
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.
Para más información sobre las API en versión preliminar, vea Conjunto de requisitos para la versión preliminar de la API de Outlook.