Ensembles de conditions requises de l’API JavaScript pour OneNote

  • Article

Les ensembles de conditions requises sont des groupes nommés de membres d’API. Les compléments Office utilisent les ensembles de conditions requises spécifiés dans le manifeste ou utilisent une vérification de l’exécution pour déterminer si une application Office prend en charge les API requises par le complément. Pour plus d’informations, consultez Versions d’Office et ensembles de conditions requises.

Le tableau suivant répertorie les ensembles de conditions requises OneNote, les applications clientes Office prises en charge et les builds ou versions minimales pour ces applications, le cas échéant.

Ensemble de conditions requises Office sur le web
OneNoteApi 1.1 Pris en charge

API JavaScript pour OneNote 1.1

L’API JavaScript 1.1 pour OneNote est la première version de l’API. Pour plus d’informations sur l’API, consultez les rubriques de référence sur l’Récapitulatif de programmation API JavaScript pour OneNote.

Vérification de la prise en charge d’un ensemble de conditions requises à l’exécution

Lors de l’exécution, les compléments peuvent vérifier si une application Office spécifique prend en charge un ensemble de conditions requises de l’API en procédant comme suit:

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

Vérification de la prise en charge des conditions requises basée sur le manifeste

Utilisez l’élément Requirements dans le manifeste du complément pour spécifier des ensembles de conditions requises essentiels ou des membres d’API que votre complément doit utiliser. Si l’application ou la plateforme Office ne prend pas en charge les ensembles de conditions requises ou les membres d’API spécifiés dans l’élément Requirements, le complément ne s’exécute pas dans cette application ou plateforme et ne s’affiche pas dans Mes compléments.

Cet exemple de code illustre un complément qui se charge dans toutes les applications clientes Office qui prennent en charge l’ensemble de conditions requises OneNoteApi, version 1.1.

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

Séries de conditions requises des API communes pour Office

Pour plus d’informations sur les ensembles de conditions requises des API communes, voir Ensembles de conditions requises des API communes pour Office.

Voir aussi