Skip to content

Stabilizes the getSelectedPageIds API. #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hollyschinsky merged 1 commit into from
Dec 28, 2025
Merged

Stabilizes the getSelectedPageIds API. #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/pages/guides/getting_started/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/pages/guides/learn/how_to/manage_pages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 4 additions & 8 deletions src/pages/guides/learn/how_to/page_metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

<InlineAlert slots="text" variant="warning"/>

**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

Expand Down Expand Up @@ -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.
4 changes: 0 additions & 4 deletions src/pages/references/addonsdk/app-document.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,10 +257,6 @@ This object is passed as a parameter to the [`getPagesMetadata`](#getpagesmetada

Retrieves the currently selected page ids in the document.

<InlineAlert slots="text" variant="warning"/>

**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<string[]>`
Expand Down
6 changes: 6 additions & 0 deletions src/pages/references/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down