From 94eb559e88732b405e4738824de7f1af62ccf241 Mon Sep 17 00:00:00 2001 From: Holly Schinsky Date: Sun, 28 Dec 2025 16:50:40 -0500 Subject: [PATCH] Stabilizes the getSelectedPageIds API. --- src/pages/guides/getting_started/changelog.md | 6 ++++++ src/pages/guides/learn/how_to/manage_pages.md | 2 +- src/pages/guides/learn/how_to/page_metadata.md | 12 ++++-------- src/pages/references/addonsdk/app-document.md | 4 ---- src/pages/references/changelog.md | 6 ++++++ 5 files changed, 17 insertions(+), 13 deletions(-) diff --git a/src/pages/guides/getting_started/changelog.md b/src/pages/guides/getting_started/changelog.md index 9b1c3e088..6567cedca 100644 --- a/src/pages/guides/getting_started/changelog.md +++ b/src/pages/guides/getting_started/changelog.md @@ -25,6 +25,12 @@ contributors: # Changelog +## 2025-12-28 + +### Changed + +- [`getSelectedPageIds()`](../../references/addonsdk/app-document.md#getselectedpageids) method **promoted from experimental to stable** - Retrieve the currently selected page IDs in the document. The [`experimentalApis`](../../references/manifest/index.md#requirements) flag is no longer required to use this API. + ## 2025-11-29 ### Code Playground Updates diff --git a/src/pages/guides/learn/how_to/manage_pages.md b/src/pages/guides/learn/how_to/manage_pages.md index 2dbe1fe03..d8dba25ba 100644 --- a/src/pages/guides/learn/how_to/manage_pages.md +++ b/src/pages/guides/learn/how_to/manage_pages.md @@ -634,7 +634,7 @@ console.log("New page ID:", newPage.id); - **[Page Metadata](page_metadata.md)** - Get detailed information about pages, including dimensions, content types, and selected page IDs - **[Document Metadata](document_metadata.md)** - Access document-level information and listen for document events -- **[getSelectedPageIds() API](../../../references/addonsdk/app-document.md#getselectedpageids)** - Retrieve IDs of currently selected pages (experimental) +- **[getSelectedPageIds() API](../../../references/addonsdk/app-document.md#getselectedpageids)** - Retrieve IDs of currently selected pages ### Working with Page Content diff --git a/src/pages/guides/learn/how_to/page_metadata.md b/src/pages/guides/learn/how_to/page_metadata.md index 72c66cf97..b48db5850 100644 --- a/src/pages/guides/learn/how_to/page_metadata.md +++ b/src/pages/guides/learn/how_to/page_metadata.md @@ -44,7 +44,7 @@ faq: answer: "Determining page size, checking for premium content before export, and identifying temporal content duration." - question: "How do I get the currently selected page IDs?" - answer: "Call `await addOnUISdk.app.document.getSelectedPageIds()` to retrieve an array of selected page IDs. Note: This is an experimental API." + answer: "Call `await addOnUISdk.app.document.getSelectedPageIds()` to retrieve an array of selected page IDs." --- # Page Metadata @@ -127,13 +127,9 @@ addOnUISdk.ready.then(() => { }); ``` -## Get Selected Page IDs (Experimental) +## Get Selected Page IDs -You can also retrieve the currently selected page IDs using the experimental `getSelectedPageIds()` method. This is particularly useful when you want to get metadata for only the pages that the user has selected in the document. - - - -**IMPORTANT:** The `getSelectedPageIds()` method is currently **_experimental only_** and should not be used in any add-ons you will be distributing until it has been declared stable. To use this method, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../references/manifest/index.md#requirements) section of the `manifest.json`. +You can retrieve the currently selected page IDs using the `getSelectedPageIds()` method. This is particularly useful when you want to get metadata for only the pages that the user has selected in the document. ### Example: Get Metadata for Selected Pages Only @@ -213,4 +209,4 @@ Page metadata can be used to determine the size of the page, the title, and whet #### Q: How do I get the currently selected page IDs? -**A:** Call `await addOnUISdk.app.document.getSelectedPageIds()` to retrieve an array of selected page IDs. Note: This is an experimental API that requires setting `experimentalApis: true` in your manifest.json requirements. +**A:** Call `await addOnUISdk.app.document.getSelectedPageIds()` to retrieve an array of selected page IDs. diff --git a/src/pages/references/addonsdk/app-document.md b/src/pages/references/addonsdk/app-document.md index e71ff6014..633d4b392 100644 --- a/src/pages/references/addonsdk/app-document.md +++ b/src/pages/references/addonsdk/app-document.md @@ -257,10 +257,6 @@ This object is passed as a parameter to the [`getPagesMetadata`](#getpagesmetada Retrieves the currently selected page ids in the document. - - -**IMPORTANT:** This method is currently **_experimental only_** and should not be used in any add-ons you will be distributing until it has been declared stable. To use this method, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../references/manifest/index.md#requirements) section of the `manifest.json`. - #### Signature `getSelectedPageIds(): Promise` diff --git a/src/pages/references/changelog.md b/src/pages/references/changelog.md index 2ce3757df..6324b0748 100644 --- a/src/pages/references/changelog.md +++ b/src/pages/references/changelog.md @@ -25,6 +25,12 @@ contributors: # Changelog +## 2025-12-28 + +### Changed + +- [`getSelectedPageIds()`](./addonsdk/app-document.md#getselectedpageids) method **promoted from experimental to stable** - Retrieve the currently selected page IDs in the document. The [`experimentalApis`](./manifest/index.md#requirements) flag is no longer required to use this API. + ## 2025-11-29 ### Code Playground Updates