Interface RecentlyUpdatedChangeSet
-
- All Superinterfaces:
Iterable<RecentlyUpdatedItem>
- All Known Implementing Classes:
WebRecentlyUpdatedChangeSet
public interface RecentlyUpdatedChangeSet extends Iterable<RecentlyUpdatedItem>
A set of relatedRecentlyUpdatedItems with a common author, as displayed on the Confluence dashboard.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetAuthor()The author of the changeset.StringgetAuthorUrl()The URL of the link to the author, which may be relative.StringgetImageLinkUrl()The URL of the link surrounding the image used for the author.StringgetImageUrl()The URL of the source of the image used for the author.RecentlyUpdatedItemgetItem(int index)Returns the recent update with the specified index, or null if no such item exists.intsize()Returns the number of items in this changeset.-
Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
-
-
-
-
Method Detail
-
getAuthor
String getAuthor()
The author of the changeset. Normally a user's full name, or "Anonymous".
-
getAuthorUrl
String getAuthorUrl()
The URL of the link to the author, which may be relative. If there is no URL on the author's name in this change-set, returns null.
-
getImageUrl
String getImageUrl()
The URL of the source of the image used for the author. Normally a user's profile picture, or the "add your profile picture" prompt image. If there is no author image for the change-set, returns null.
-
getImageLinkUrl
String getImageLinkUrl()
The URL of the link surrounding the image used for the author. Normally links to the user's profile or personal space. If there is no author image for the change-set, or the image does not have a link, returns null.
-
size
int size()
Returns the number of items in this changeset. There will always be at least 1.
-
getItem
RecentlyUpdatedItem getItem(int index)
Returns the recent update with the specified index, or null if no such item exists. The index is zero-based, with zero being the most recent item.- Parameters:
index- zero-based index of the item to return- Returns:
- the item with the given index, or null if it does not exist.
-
-