com.k15t.scroll.scm.api.events.space

Interface PostPublishEvent

public interface PostPublishEvent

This event is published at the end of a publishing process after all pages have been published.

Method Summary

Modifier and Type	Method and Description
List<Language>	getPublishedLanguages() Get the published languages.
List<Variant>	getPublishedVariants() Get the published variants.
Optional<Version>	getPublishedVersion() Get the published version.
PublishType	getPublishType() Get the publish type.
String	getSourceSpaceKey() Get the source space key.
Optional<String>	getTargetApplicationLinkId() When publishing to another system with the Scroll Remote Publishing Endpoint, this method gets the ID of the application link to the other system.
String	getTargetSpaceKey() Get the target space key.

Method Detail

getPublishedVersion

Optional<Version> getPublishedVersion()

Get the published version.

Returns:

an Optional containing the published version. Currently it will never be empty but this may change if at some point publishing a space without versions is introduced.

getPublishedLanguages

List<Language> getPublishedLanguages()

Get the published languages.

Returns:

a list containing all published languages. Empty list when no languages are active in the source space.

getPublishedVariants

List<Variant> getPublishedVariants()

Get the published variants. When publishing "all" variants, the list will only contain one entry: The "all" variant.

Returns:

a list of all published variants.

getSourceSpaceKey

String getSourceSpaceKey()

Get the source space key.

Returns:

the space key of the space that gets published.

getTargetSpaceKey

String getTargetSpaceKey()

Get the target space key.

Returns:

the space key of the space that gets published into. When publishing within the same, this will be the same as the source space key.

getPublishType

PublishType getPublishType()

Get the publish type.

Returns:

the type of the publishing process.

getTargetApplicationLinkId

Optional<String> getTargetApplicationLinkId()

When publishing to another system with the Scroll Remote Publishing Endpoint, this method gets the ID of the application link to the other system. The application link can be retrieved through the com.atlassian.applinks.api.ApplicationLinkService component.

Returns:

an Optional containing the ID of the application link, or an empty Optional when publishing within the same system.