Word JavaScript API online-only requirement set
The WordApiOnline
requirement set is a special requirement set that includes features that are only available for Word on the web. APIs in this requirement set are considered to be production APIs for the Word on the web application. They follow Microsoft 365 developer support policies. WordApiOnline
APIs are considered to be "preview" APIs for other platforms (Windows, Mac, iPad) and may not be supported by any of those platforms.
When APIs in the WordApiOnline
requirement set are supported across all platforms, they will added to the next released requirement set (WordApi 1.[NEXT]
). Once that new requirement is public, those APIs will be removed from WordApiOnline
. Think of this as a similar promotion process to an API moving from preview to release.
Important
WordApiOnline
is a superset of the latest numbered requirement set.
Important
WordApiOnline 1.1
is the only version of the online-only APIs. This is because Word on the web will always have a single version available to users that is the latest version.
The following table provides a concise summary of the APIs, while the subsequent API list table gives a detailed list of the current WordApiOnline
APIs.
Feature area | Description | Relevant objects |
---|---|---|
None. |
Recommended usage
Because WordApiOnline
APIs are only supported by Word on the web, your add-in should check if the requirement set is supported before calling these APIs. This avoids calling an online-only API on a different platform.
if (Office.context.requirements.isSetSupported("WordApiOnline", "1.1")) {
// Any API exclusive to the WordApiOnline requirement set.
}
Once the API is in a cross-platform requirement set, you should remove or edit the isSetSupported
check. This will enable your add-in's feature on other platforms. Be sure to test the feature on those platforms when making this change.
Important
Your manifest cannot specify WordApiOnline 1.1
as an activation requirement. It is not a valid value to use in the Set element.
API list
The following table lists the Word JavaScript APIs currently included in the WordApiOnline
requirement set. For a complete list of all Word JavaScript APIs (including WordApiOnline
APIs and previously released APIs), see all Word JavaScript APIs.
Class | Fields | Description |
---|
See also
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應