Comment Supplier
Overview
Supplies information about comments attached to Pages or News Items in Confluence.
Key names are case-sensitive. You must supply a key of id rather than ID.
You can also use any key from the Content Supplier using the comment: prefix.
For example, you can use comment:id, instead of content:id, even though id is not listed explicitly below.
Details
Name: | Comment Supplier |
|---|---|
Prefix: | comment(optional) |
Supported Content: | Comments |
Provided By: | Reporting for Confluence from 3.0.0+ |
Supported Keys
The following are the list of keys which this supplier will return a value for.
Key | Content Types | Return Type | Description |
|---|---|---|---|
replies | Comments | List of Comments | The list of all comments replying directly to the current comment. |
reply count | Comments | The number of replies to the current comment. | |
repliers | Comments | The list of all users who replied to the current comment, directly or indirectly. | |
depth | Comments | The depth of the current comment from the top level. | |
parent | Comments | Comment | The comment this comment is replying to. |
page | Comments | The page this comment is attached to. | |
space | Comments | The space this comment is in. | |
inline-selection | Comments | String | Retrieves the highlighted text of the inline comment. |
inline-status | Comments | String | Retrieves the inline comment's status
|
comment-type | Comments | String | Retrieves the type of comment:
|
Inherited Keys
The following keys are inherited from other suppliers, but work using the same prefix - comment: - as this supplier.
From Content Supplier
Key | Content Types | Return Type | Description |
|---|---|---|---|
id | All | The unique identifier for the content. | |
title | All | The title of the content. | |
type | All | The name of the content type. e.g.: "Page" or "News". | |
url | All | The server-relative URL to view the content. | |
creator | All | The user who created the content. | |
creation date | All | The date the content was created. | |
modifier | All | The user who most recently modified the content. | |
modification date | All | The date the content was most recently modified. | |
icon | All | The server-relative URL of the icon for this content type. | |
space | All | The space the content exists in. If the content is itself a space, the space is returned. | |
excerpt | Pages, news items, space descriptions | The excerpt for the content. Inheritance is not valid with Attachment Supplier. | |
body | Pages, news items, space descriptions, comments | The main body text of the content. | |
labels | Pages, news items, space descriptions | A list of the labels attached to this content. | |
attachments | Pages, news items | List of Attachments | A list of the attachments on the supplied content. |
incoming links | Pages, news items | A list of links to content which links to the supplied content. | |
outgoing links | Pages, news items | A list of links to content which the supplied content links to. | |
summary | Content | Either the excerpt (as above), if it exists, or a short summary of the page content if it does not. FROM 1.3+ | |
equals [X] | Content | Tests if the current context is equal to that specified by X, where X is a standard link to Confluence content. Examples
| |
version | Content | The version number for the content. | |
version comment | Content | The comment about the version, as set by the editor. Fom 2.1.0+ | |
version history | Content | The list of historical versions for the current content object. Fom 2.1.0+ | |
is latest version | Content | Checks if the content is the latest version. | |
latest version | Content | Returns the latest version of the content. | |
images | Pages, News Items | List of Attachments | The list of attachments which are image files. Fom 3.2.0+ |