com.atlassian.confluence.rss

Class FeedProperties

java.lang.Object

com.atlassian.confluence.rss.FeedProperties

public class FeedProperties
extends Object

Allows users to specify properties of the feed. Used primarily by FeedBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FEED_TITLE

Constructor Summary

Constructors

Constructor and Description
FeedProperties(String title, String description, boolean showContent, boolean publicFeed)
FeedProperties(String title, String description, boolean showContent, boolean showDiff, boolean publicFeed) Deprecated. Since 4.0. The showDiff parameter is ignored. Use FeedProperties(String, String, boolean, boolean) instead.

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getTitle()
boolean	isPublicFeed() A public feed is one that doesn't require authentication and doesn't include any privileged links (like "comment").
boolean	isShowContent()
boolean	isShowDiff() Deprecated. Since 4.0. Diffs are no longer supported in RSS feeds.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_FEED_TITLE

public static final String DEFAULT_FEED_TITLE

See Also:

Constant Field Values

Constructor Detail

FeedProperties

@Deprecated
public FeedProperties(String title,
                                  String description,
                                  boolean showContent,
                                  boolean showDiff,
                                  boolean publicFeed)

Deprecated. Since 4.0. The showDiff parameter is ignored. Use FeedProperties(String, String, boolean, boolean) instead.

Parameters:

title - the title. Uses DEFAULT_FEED_TITLE if none is specified.

description - required.

showContent - if the full content should be shown in the feed.

showDiff - if diffs of content changes should be shown in the feed. Since 4.0 this parameter is ignored.

publicFeed - if the feed is public.

FeedProperties

public FeedProperties(String title,
                      String description,
                      boolean showContent,
                      boolean publicFeed)

Parameters:

title - the title. Uses DEFAULT_FEED_TITLE if none is specified.

description - required.

showContent - if the full content should be shown in the feed.

showDiff - if diffs of content changes should be shown in the feed. Since 4.0 this parameter is ignored.

publicFeed - if the feed is public.

Method Detail

getTitle

public String getTitle()

getDescription

public String getDescription()

isShowContent

public boolean isShowContent()

isShowDiff

@Deprecated
public boolean isShowDiff()

Deprecated. Since 4.0. Diffs are no longer supported in RSS feeds.

Returns:

since 4.0 this will always return false.

isPublicFeed

public boolean isPublicFeed()

A public feed is one that doesn't require authentication and doesn't include any privileged links (like "comment").