Conjuntos de requisitos de la API de JavaScript de OneNote

  • Artículo

Los conjuntos de requisitos son grupos de miembros de la API con nombre. Los complementos de Office usan los conjuntos de requisitos especificados en el manifiesto o usan una comprobación en tiempo de ejecución para determinar si una aplicación de Office admite las API necesarias para el complemento. Para obtener más información, vea Versiones y conjuntos de requisitos de Office.

En la tabla siguiente se enumeran los conjuntos de requisitos de OneNote, las aplicaciones cliente de Office admitidas y las compilaciones o versiones mínimas para esas aplicaciones cuando corresponda.

Conjunto de requisitos Office en la web
OneNoteApi 1.1 Compatible

API de JavaScript de OneNote 1.1

API de JavaScript de OneNote 1.1 es la primera versión de la API. Para obtener más información sobre la API, vea la Información general sobre la programación de la API de JavaScript de OneNote.

Comprobación de compatibilidad de los requisitos en runtime

Durante el tiempo de ejecución, los complementos pueden comprobar si una aplicación de Office determinada admite un conjunto de requisitos de la API mediante el siguiente procedimiento:

if (Office.context.requirements.isSetSupported('OneNoteApi', '1.1')) {
  // Perform actions.
}
else {
  // Provide alternate flow/logic.
}

Comprobación de compatibilidad de los requisitos basada en un manifiesto

Use el elemento Requirements en el manifiesto del complemento para especificar conjuntos de requisitos críticos o miembros de la API que debe usar el complemento. Si la plataforma o la aplicación de Office no es compatible con los conjuntos de requisitos o los miembros de la API especificados en el elemento Requirements, el complemento no se ejecutará en la plataforma o la aplicación ni se mostrará en Mis complementos.

En el siguiente ejemplo de código se muestra un complemento que se carga en todas las aplicaciones cliente de Office que admiten el conjunto de requisitos OneNoteApi, versión 1.1.

<Requirements>
   <Sets DefaultMinVersion="1.1">
      <Set Name="OneNoteApi" MinVersion="1.1"/>
   </Sets>
</Requirements>

Conjuntos de requisitos de la API común de Office

Para obtener información sobre los conjuntos de requisitos comunes de la API, vea Conjuntos de requisitos comunes de la API de Office.

Consulte también