...
Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
Supplies information about news items (or blog posts) in Confluence.
Info |
---|
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 news: prefix.
For example
you can use news:id, instead of content:id, even though id is not listed explicitly below
Details
Name: | News Supplier | ||||||
---|---|---|---|---|---|---|---|
Prefix: | news/blogpost(optional) | ||||||
Supported Content: | News Items | ||||||
Provided By: |
|
Supported Keys
List of keys that this supplier returns a value for.
Key | Content Types | Return Type | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
comments | News Items | A list of top-level comments attached to the supplied news item.
| |||||||
all comments | News Items | A list of all comments attached to the supplied news item.
| |||||||
is favourite | News Items | Is true if the news item is a favorite of the current user. | |||||||
space | News Items | The space the news item is in. | |||||||
posting date | News Items | The date the blog was posted on. Equivalent to 'creation date'.
| |||||||
date path | News Items | The 'date' section of the post's URL path. e.g. '2010/06/30'.
| |||||||
tiny url | News Items | The context-relative path for the short URL for this page.
|
Inherited Keys
The following keys are inherited from other suppliers, but work using the same prefix (news:/blogpost:) 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.
| |||||||||
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. Inheritance is not valid with Attachment Supplier. | |||||||||
labels | Pages, news items, space descriptions | A list of the labels attached to this content. Inheritance is not valid with Attachment Supplier. | |||||||||
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. Inheritance is not valid with Attachment Supplier. | |||||||||
outgoing links | Pages, news items | A list of links to content which the supplied content links to. Inheritance is not valid with Attachment Supplier. | |||||||||
summary | Content | Either the excerpt (as above), if it exists, or a short summary of the page content if it does not.
Inheritance is not valid with Attachment Supplier. | |||||||||
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.
Inheritance is not valid with Attachment Supplier. | |||||||||
version history | Content | The list of historical versions for the current content object.
| |||||||||
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.
|