Interface PageModelApi

This section of the API relates to information about pages.

interface PageModelApi {
events: PageEventsApi;
onParentPageEnter(pageListener: ((page: ParentPageModelApi) => void)): (() => void);
}

Index

Properties

Methods

onParentPageEnter

Properties

`Readonly`events

events: PageEventsApi

Methods

onParentPageEnter

onParentPageEnter(pageListener): (() => void)
Invokes the listener whenever a parent page (object, workflow gather information, relationship attributes, and so on) is accessed.
Parameters
- pageListener: ((page: ParentPageModelApi) => void)
  The listener.
  - - (page): void
    - Parameters
      page: ParentPageModelApi
      Returns void
Returns (() => void)
A function that removes the listener.
- - (): void
  - Returns void