Interface PageEventsApi

PageEventsApiBase extension that provides more functionality.

interface PageEventsApi {
    addPageEvent(eventName: string): void;
    getPageEvent(eventName: SaveObject): undefined | IPageEvent<IPageEventData>;
    getPageEvent<T>(eventName: string): undefined | IPageEvent<T>;
}

Hierarchy (view full)

PageEventsApiBase
- PageEventsApi

Index

Methods

addPageEvent getPageEvent

Methods

addPageEvent

addPageEvent(eventName): void
Parameters
- eventName: string
  The name of the event, this should be unique.
Returns void
Method
Description
Add a hookable page event. An error is thrown if the event is already registered.

getPageEvent

getPageEvent(eventName): undefined | IPageEvent<IPageEventData>
Parameters
- eventName: SaveObject
  The name of the event.
Returns undefined | IPageEvent<IPageEventData>
The reference to the hookable page event.

Method
Description
Get a reference to a hookable page event if it is defined.

Inherited from PageEventsApiBase.getPageEvent
getPageEvent<T>(eventName): undefined | IPageEvent<T>
Type Parameters
- T extends IPageEventData
Parameters
- eventName: string
Returns undefined | IPageEvent<T>
Inherited from PageEventsApiBase.getPageEvent