OneNote JavaScript API 要求集

要求集是指各组已命名的 API 成员。 Office 加载项使用清单中指定的要求集或执行运行时检查,以确定 Office 应用程序是否支持加载项所需的 API。 有关详细信息,请参阅 Office 版本和要求集

下表列出了 OneNote 要求集、支持的 Office 客户端应用程序,以及这些应用程序(如果适用) 的最低 版本。

要求集 Office 网页版
OneNoteApi 1.1 支持

OneNote JavaScript API 1.1

OneNote JavaScript API 1.1 是该 API 的第一版。 有关此 API 的详细信息,请参阅 OneNote JavaScript API 编程概述

运行时要求支持检查

在运行时,加载项可以执行下列检查,确定特定 Office 应用程序是否支持 API 要求集:

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

基于清单的要求支持检查

使用加载项清单中的 Requirements 元素指定加载项必须使用的关键要求集或 API 成员。 如果 Office 应用程序或平台不支持 Requirements 元素中指定的要求集或 API 成员,则加载项将无法在该应用程序或平台上运行,并且不会显示在“我的加载项”中。

下面的代码示例展示了加载所有支持第 1.1 版 OneNoteApi 要求集的 Office 客户端应用程序的加载项。

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

Office 通用 API 要求集

若要了解通用 API 要求集,请参阅 Office 通用 API 要求集

另请参阅