Page routines
This section contains routines that enable users to handle pages.
Routines Summary
- addLabels — Adds one or multiple labels to a given page.
- clonePage — Clones the page and returns the id of the cloned page.
- clonePageTree — Clones the page tree with its permissions.
- copyPageContent — Copies page content from one page to another.
- countPages — Returns the number of pages that matched the CQL search query.
- createPage — Creates an issue based on the provided arguments.
- deletePage — Deletes the selected page.
- deletePageTree — Deletes the selected page and all its child pages.
- getChildPages — Get the list of child pages (direct children) for a selected page.
- getPage — Retrieves a page ID by searching for space key and page title. The routine will return a -1 if the page is not found.
- getPages — Returns all descendants of a page (all levels, not only direct children) or a set of pages matching space key and title.
- getPageURL — Returns the URL of the page.
- movePage — Moves the selected page to a new parent page.
- pageExists — Verifies whether a given page is a registered Confluence page.
- selectPages — Returns an array with the IDs of the pages that match the search query.
- getLabels — The routine receives the id of a page as parameter and returns a list of structures containing some properties of the labels of that page.
- setLabels — The routine receives the id of a page and an array of Strings, representing the names of the labels to be added to that page. All previous labels for page are removed.
- renderPage — Routine takes a page ID and returns the page content as string with all content rendered.
- plainText — Routine strips all HTML/XML markup from a passed string and returns a clean, plain-text version.
- markdown — Routine that translate HTML/XML markup from a passed string and returns markdown version.
- renderWiki
Peacock
Need support? Create a request with our support team.
Copyright © 2005 - 2025 Appfire | All rights reserved.
