Download PDF
Download page Page.
Page
Placeholder for accessing page related data.
Methods
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
absoluteLink | String | The absolute link to this object. | |||||||||
ancestors | List<Page> | The list of ancestors of the content. Can be used to display bread crumbs. The list starts with the very first ancestor and ends with the parent of this content. | |||||||||
author | String | The username of the user who created this content. May be null if there is no author (e.g. on a search result or error page).
| |||||||||
canComment | boolean |
| |||||||||
canEdit | boolean |
| |||||||||
canView | boolean |
| |||||||||
categoriesAsHtml() | String | A list of the categories of the page, formatted in this style: "label1, label2, label3 and label4", where each label is an HTML anchor tag with | |||||||||
children | List<Page> | All sorted children the current user is allowed to view. | |||||||||
comments | List<Comment> | A list of all comments on the content object (in chronologically ascending order, i.e. oldest first). | |||||||||
content | String | The content of this content object, rendered using the default page layout and no macro overrides but the defaults and the ones found in the overrides directory of the theme. | |||||||||
creationDate | Date | The date when this content has been originally created. | |||||||||
creationDate(pattern) | String | The date when this content has been created originally, formatted using the given pattern.
| |||||||||
creationDate(pattern, locale) | String | The date when this content has been created originally, formatted using the given pattern and locale key.
| |||||||||
creator | User | The user who created the content. May be null if there is no creator (e.g. on a search result or error page). | |||||||||
creatorName | String | The username of the user who created this content. May be null if there is no creator (e.g. on a search result or error page).
| |||||||||
description | String | The first 140 characters of the content, rendered using the default macro overrides and the ones found in the overrides directory of the theme. | |||||||||
editUrl | String | An absolute URL to the edit page. | |||||||||
excerpt | String | The full excerpt of the page, if defined, rendered using the default macro overrides and the ones found in the overrides directory of the theme. | |||||||||
excerptAsHtml | String | The excerpt as HTML code, rendered using the default macro overrides and the ones found in the overrides directory of the theme. | |||||||||
fromConfluence | AbstractPage | The Confluence page or blog post object. | |||||||||
getDescription(macroOverrides) | String | The first 140 characters of the content, rendered using the default macro overrides, the ones found in the overrides directory of the theme, and the ones specified in
| |||||||||
getDescription(maxLength) | String | The first
| |||||||||
getDescription(maxLength, macroOverrides) | String | The first
| |||||||||
getExcerpt(macroOverrides) | String | The full excerpt of the page, if defined, rendered using the default macro overrides, the ones found in the overrides directory of the theme, and the ones specified in
| |||||||||
getExcerpt(maxLength) | String | The excerpt of the content, if defined, cut off after
| |||||||||
getExcerpt(maxLength, macroOverrides) | String | The excerpt of the content, if defined, cut off after
| |||||||||
getExcerptAsHtml(macroOverrides) | String | The excerpt as HTML code, rendered using the default macro overrides, the ones found in the overrides directory of the theme, and the ones specified in
| |||||||||
hasChildren | boolean |
| |||||||||
id | String | The ID of the content, the pattern and semantics of this ID are implementation-specific. | |||||||||
isAncestor(otherPage) | boolean |
| |||||||||
labels | LabelList | The labels of the content. | |||||||||
lastModificationDate | Date | The date when this content was last modified. | |||||||||
lastModificationDate(pattern) | String | The date when this content was last modified, formatted using the given pattern.
| |||||||||
lastModificationDate(pattern, locale) | String | The date when this content was last modified, formatted using the given pattern and locale key.
| |||||||||
lastModifier | User | The user who last modified the content. May be null if there is no last modifier (e.g. on a search result or error page). | |||||||||
lastModifierName | String | The username of the last user who modified this content. May be null if there is no last modifier (e.g. on a search result or error page).
| |||||||||
link | String | The relative link to this object. | |||||||||
next | Page | The next content in the page hierarchy. | |||||||||
parent | Page | The parent page of the current page. Will be unset for the home page of a space. For blog posts this returns the month overview, for month overviews the year overview, and for year overviews an overview of all blog posts. | |||||||||
prev | Page | The previous content in the hierarchy. | |||||||||
properties | PageProperties | The page properties of the content. | |||||||||
renderContent() | String | The content of this content object, rendered using the default page layout and no macro overrides but the defaults and the ones found in the overrides directory of the theme. | |||||||||
renderContent(pageLayout) | String | The content of this content object, rendered using the specified page layout and no macro overrides but the defaults and the ones found in the overrides directory of the theme.
| |||||||||
renderContent(pageLayout, macroOverrides) | String | The content of this content object, rendered using the specified page layout, the macro overrides found in the overrides directory, and the overrides specified in
| |||||||||
resources | WebResources | Include web resources. Returns: HTML tags to include Confluence resources, such as CSS and JavaScript files. | |||||||||
spaceKey | String | The key of the space this content is located in. | |||||||||
title | String | The title of this content. | |||||||||
topLevelComments | List<Comment> | A list of all top-level comments on content object (in chronologically ascending order, i.e. oldest first). This can be used to display threaded comments. | |||||||||
type | String | The type of the content object. Possible values:
|
Deprecation Notice: Use