@ExperimentalApi public class History extends Object implements NavigationAware
Content
.
History refers to the published version of Content.
Be careful when using expand=history
when looking at content with status=draft
:
the information will refer to the published Content, if any.
See the javadoc on individual methods for more details, e.g. getCreatedDate()
, getLastUpdatedRef()
,
getNextVersionRef()
.
Modifier and Type | Class and Description |
---|---|
static class |
History.Expansions
Provides property names that can be used to expand
History objects. |
static class |
History.HistoryBuilder
Creates
History instances. |
Modifier and Type | Method and Description |
---|---|
static History.HistoryBuilder |
builder() |
static Reference<History> |
buildReference(Reference<Content> contentParent) |
Reference<Content> |
getContentParentRef() |
Reference<Contributors> |
getContributors() |
Person |
getCreatedBy()
Get the original creator of the first published non-draft version of the content.
|
org.joda.time.DateTime |
getCreatedDate()
Get the original publish time of the first published non-draft version of the content.
|
Reference<Version> |
getLastUpdatedRef()
Get information about the latest published non-draft version of the content.
|
Reference<Version> |
getNextVersionRef()
Get the next version, if this is not the newest version.
|
static Reference<Content> |
getParentReference(Reference<History> historyReference) |
Reference<Version> |
getPreviousVersionRef()
Get the previous version, if this is not the oldest version.
|
boolean |
isLatest()
Is this the latest published (non-draft) version of the content?
|
Navigation.Builder |
resolveNavigation(NavigationService navigationService) |
public static History.HistoryBuilder builder()
public static Reference<Content> getParentReference(Reference<History> historyReference)
public Reference<Version> getLastUpdatedRef()
Special notes for drafts:
expand=version
.
public Reference<Version> getNextVersionRef()
Note draft content only has a single version, so will return an empty reference.
public Reference<Version> getPreviousVersionRef()
Note draft content only has a single version, so will return an empty reference.
public boolean isLatest()
This method will always return false
for draft content.
nextVersion
);
false if not highest, or if draftpublic Person getCreatedBy()
Special notes for drafts:
expand=version
and see Version.getBy()
.
public org.joda.time.DateTime getCreatedDate()
Special notes for drafts:
expand=version
and see Version.getWhen()
.
public Reference<Contributors> getContributors()
public Navigation.Builder resolveNavigation(NavigationService navigationService)
resolveNavigation
in interface NavigationAware
Copyright © 2003–2018 Atlassian. All rights reserved.