Page routines

Page routines

This section contains routines that enable users to handle pages.

Routines Summary

  • addLabelsAdds one or multiple labels to a given page.
  • clonePageClones the page and returns the id of the cloned page.
  • clonePageTreeClones the page tree with its permissions.
  • copyPageContentCopies page content from one page to another.
  • countPagesReturns the number of pages that matched the CQL search query.
  • createPageCreates an issue based on the provided arguments.
  • deletePageDeletes the selected page.
  • deletePageTreeDeletes the selected page and all its child pages.
  • getChildPagesGet the list of child pages (direct children) for a selected page.
  • getPageRetrieves a page ID by searching for space key and page title. The routine will return a -1 if the page is not found.
  • getPagesReturns all descendants of a page (all levels, not only direct children) or a set of pages matching space key and title.
  • getPageURLReturns the URL of the page.
  • movePageMoves the selected page to a new parent page.
  • pageExistsVerifies whether a given page is a registered Confluence page.
  • selectPagesReturns an array with the IDs of the pages that match the search query.
  • getLabelsThe routine receives the id of a page as parameter and returns a list of structures containing some properties of the labels of that page.
  • setLabelsThe 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.
  • renderPageRoutine takes a page ID and returns the page content as string with all content rendered.
  • plainTextRoutine strips all HTML/XML markup from a passed string and returns a clean, plain-text version.
  • markdownRoutine 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.