public class

FeedOptions

extends Object
java.lang.Object
   ↳ com.atlassian.confluence.it.feed.FeedOptions

Class Overview

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

See Also

Summary

Public Methods
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)
void 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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static FeedOptions getAuthenticated ()

public ContentType[] getBlogSubTypes ()

public static FeedOptions getDefault ()

public String[] getExcludedSpaceKeys ()

public String[] getLabels ()

public int getMaxResults ()

public ContentType[] getPageSubTypes ()

public FeedType getRssType ()

public Sort getSort ()

public SpaceScope getSpaceScope ()

public int getTimeSpan ()

public String getTitle ()

public ContentType[] getTypes ()

public boolean isAuthenticatedFeed ()

public boolean isShowContent ()

public void setAuthenticatedFeed (boolean authenticatedFeed)

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

public void setBlogSubTypes (ContentType... blogSubTypes)

public void setExcludedSpaces (String... keys)

public void setLabels (String... labels)

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

public void setMaxResults (int maxResults)

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

public void setPageSubTypes (ContentType... pageSubTypes)

public void setRssType (FeedType rssType)

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

public void setShowContent (boolean showContent)

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

public void setSort (Sort sort)

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

public void setSpaceScope (SpaceScope spaceScope)

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

public void setTimeSpan (int timeSpan)

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

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).

public void setTypes (ContentType... types)

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