Package org.craftercms.studio.api.v2.event.content

Class ContentEvent

java.lang.Object

org.craftercms.studio.api.v2.event.StudioEvent

org.craftercms.studio.api.v2.event.SiteAwareEvent

org.craftercms.studio.api.v2.event.content.ContentEvent

All Implemented Interfaces:

BroadcastEvent

Direct Known Subclasses:

ConfigurationEvent, DeleteContentEvent, MoveContentEvent

public class ContentEvent
extends SiteAwareEvent
implements BroadcastEvent

Event triggered when there is a change in one or more content items

Since:

4.0.0

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected String	targetPath
protected boolean	waitForCompletion

Fields inherited from class org.craftercms.studio.api.v2.event.SiteAwareEvent

siteId

Fields inherited from class org.craftercms.studio.api.v2.event.StudioEvent

timestamp, user

Constructor Summary

Constructors

Constructor	Description
ContentEvent(org.springframework.security.core.Authentication authentication, String siteId, String targetPath)
ContentEvent(org.springframework.security.core.Authentication authentication, String siteId, String targetPath, boolean waitForCompletion)

Method Summary

Modifier and Type	Method	Description
String	getEventType()
String	getTargetPath()
boolean	isWaitForCompletion()
String	toString()

Methods inherited from class org.craftercms.studio.api.v2.event.SiteAwareEvent

getSiteId

Methods inherited from class org.craftercms.studio.api.v2.event.StudioEvent

getTimestamp, getUser

Methods inherited from class java.lang.Object

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

Field Detail

targetPath

protected final String targetPath

waitForCompletion

protected final boolean waitForCompletion

Constructor Detail

ContentEvent

public ContentEvent(org.springframework.security.core.Authentication authentication,
                    String siteId,
                    String targetPath,
                    boolean waitForCompletion)

ContentEvent

public ContentEvent(org.springframework.security.core.Authentication authentication,
                    String siteId,
                    String targetPath)

Method Detail

getTargetPath

public String getTargetPath()

isWaitForCompletion

public boolean isWaitForCompletion()

getEventType

public String getEventType()

Specified by:

getEventType in interface BroadcastEvent

toString

public String toString()

Overrides:

toString in class Object