OneNote JavaScript API の要件セット
要件セットは、API メンバーの名前付きグループです。 Office アドインでは、マニフェストで指定されている要件セットを使用するか、ランタイム チェックを使用して、Office アプリケーションがアドインに必要な API をサポートしているかどうかを判断します。 詳細については、「 Office のバージョンと要件セット」を参照してください。
次の表に、OneNote 要件セット、サポートされている Office クライアント アプリケーション、該当する場合はそれらのアプリケーションの 最小 ビルドまたはバージョンを示します。
要件セット | Office on the web |
---|---|
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.
}
マニフェストに基づく要件のサポートのチェック
アドインで必須の、重要な要件セットまたは API メンバーを指定するには、アドインのマニフェストで Requirements
要素を使用します。 Office アプリケーションまたはプラットフォームが、Requirements
要素で指定した要件セットまたは API メンバーをサポートしない場合、アドインはそのアプリケーションまたはプラットフォームでは実行されず、[個人用アドイン] にも表示されません。
OneNoteApi 要件セット、バージョン 1.1 をサポートするすべての Office クライアント アプリケーションで読み込まれるアドインのコード例を以下に示します。
<Requirements>
<Sets DefaultMinVersion="1.1">
<Set Name="OneNoteApi" MinVersion="1.1"/>
</Sets>
</Requirements>
Office 共通 API の要件セット
共通 API の要件セットの詳細については、「Office 共通 API の要件セット」をご覧ください。
関連項目
Office Add-ins