ChannelEvent (Hippo Site Toolkit API 15.2.0 API)

All Superinterfaces:

BaseChannelEvent, RuntimeExceptionEvent
```
public interface ChannelEvent
extends BaseChannelEvent
```

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class ChannelEvent.ChannelEventType
Channel event type.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ChannelEvent.ChannelEventType`	`getChannelEventType()`	Return the channel event type.
`Mount`	`getEditingMount()`
`HstSite`	`getEditingPreviewSite()`
`HstRequestContext`	`getRequestContext()`
`List<String>`	`getUserIds()`

Methods inherited from interface org.hippoecm.hst.pagecomposer.jaxrs.api.BaseChannelEvent
getChannel, getLogger

Methods inherited from interface org.hippoecm.hst.pagecomposer.jaxrs.api.RuntimeExceptionEvent
getException, setException

- Method Detail
  - getChannelEventType
```
ChannelEvent.ChannelEventType getChannelEventType()
```
    Return the channel event type.
    
    Returns:
    
    the channel event type
  - getUserIds
```
List<String> getUserIds()
```
    Returns:
    
    unmodifiable list of users whose changes might be published / discarded / changed / affected
  - getRequestContext
```
HstRequestContext getRequestContext()
```
    Returns:
    
    the HstRequestContext that is used that triggers this this channel event
  - getEditingMount
```
Mount getEditingMount()
```
    Returns:
    
    the Mount that is being modified during this request
  - getEditingPreviewSite
```
HstSite getEditingPreviewSite()
```
    Returns:
    
    the preview HstSite that is being modified during this request. Note that in case of PREVIEW_CREATION the returned HstSite is the live site because the preview site was not yet present during the creation of the request context