com.atlassian.confluence.it.feed

Class FeedOptions

java.lang.Object

com.atlassian.confluence.it.feed.FeedOptions

public class FeedOptions
extends Object

Mutable object for setting options for use with the feed builder.

See Also:

FeedBuilder

Method Summary

Modifier and Type	Method and Description
static FeedOptions	getAuthenticated()
ContentType[]	getBlogSubTypes()
static FeedOptions	getDefault()
String[]	getExcludedSpaceKeys()
String[]	getLabels()
int	getMaxResults()
ContentType[]	getPageSubTypes()
FeedType	getRssType()
Sort	getSort()
SpaceScope	getSpaceScope()
int	getTimeSpan()
String	getTitle()
ContentType[]	getTypes()
boolean	isAuthenticatedFeed()
boolean	isShowContent()
void	setAuthenticatedFeed(boolean authenticatedFeed) Sets whether to use basic HTTP authentication for the feed.
void	setBlogSubTypes(ContentType... blogSubTypes)
void	setExcludedSpaces(String... keys)
void	setLabels(String... labels) Sets the labels to retrieve a feed for.
void	setMaxResults(int maxResults) Sets the maximum number of entries in the feed.
void	setPageSubTypes(ContentType... pageSubTypes)
FeedOptions	setRssType(FeedType rssType) Sets the type of feed to retrieve.
void	setShowContent(boolean showContent) Sets whether to show full content in the feed or not.
void	setSort(Sort sort) Sets the sort order of the feed.
void	setSpaceScope(SpaceScope spaceScope) Set a list of spaces to return results from.
void	setTimeSpan(int timeSpan) Sets the timespan of the feed in days.
void	setTitle(String title) Sets the title of the feed.
void	setTypes(ContentType... types) Set the types of content to include in the feed.

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public static FeedOptions getDefault()

getAuthenticated

public static FeedOptions getAuthenticated()

getTypes

public ContentType[] getTypes()

getSort

public Sort getSort()

getSpaceScope

public SpaceScope getSpaceScope()

getLabels

public String[] getLabels()

getRssType

public FeedType getRssType()

getMaxResults

public int getMaxResults()

getTimeSpan

public int getTimeSpan()

getTitle

public String getTitle()

isAuthenticatedFeed

public boolean isAuthenticatedFeed()

isShowContent

public boolean isShowContent()

setTypes

public void setTypes(ContentType... types)

Set the types of content to include in the feed. Default is just ContentType.PAGE.

setSort

public void setSort(Sort sort)

Sets the sort order of the feed. Default is Sort.MODIFIED.

setSpaceScope

public void setSpaceScope(SpaceScope spaceScope)

Set a list of spaces to return results from. Default is all spaces.

setLabels

public void setLabels(String... labels)

Sets the labels to retrieve a feed for. Default is no labels, which means all entries are shown.

setRssType

public FeedOptions setRssType(FeedType rssType)

Sets the type of feed to retrieve. Default is FeedType.RSS2.

setMaxResults

public void setMaxResults(int maxResults)

Sets the maximum number of entries in the feed. Default is 10.

setTimeSpan

public void setTimeSpan(int timeSpan)

Sets the timespan of the feed in days. Default is 5 days.

setTitle

public void setTitle(String title)

Sets the title of the feed. If blank or null title, uses the title generated by Confluence. Default value is blank (i.e. use the Confluence-generated title).

setAuthenticatedFeed

public void setAuthenticatedFeed(boolean authenticatedFeed)

Sets whether to use basic HTTP authentication for the feed. Default is false.

setShowContent

public void setShowContent(boolean showContent)

Sets whether to show full content in the feed or not. Default is true.

setPageSubTypes

public void setPageSubTypes(ContentType... pageSubTypes)

getPageSubTypes

public ContentType[] getPageSubTypes()

setBlogSubTypes

public void setBlogSubTypes(ContentType... blogSubTypes)

getBlogSubTypes

public ContentType[] getBlogSubTypes()

setExcludedSpaces

public void setExcludedSpaces(String... keys)

getExcludedSpaceKeys

public String[] getExcludedSpaceKeys()