Interface PageScope

API to access information about and communicate with the current page in the current channel shown in the Channel Manager.

Hierarchy

Emitter<PageScopeEvents>
- PageScope

Index

Properties

Properties

get

get: function

returns: a Promise that resolves with PageProperties of the current page.

Type declaration

- (): Promise<PageProperties>
- Returns Promise<PageProperties>

on

on: function

Subscribes a handler for events emitted by the CMS. The type of the emitted value depends on the emitted event.

param: the name of the emitted event.
param: the function to call with the emitted value.
returns: a function to unsubscribe the handler again.

Type declaration

- (eventName: keyof PageScopeEvents, handler: EventHandler<PageScopeEvents>): UnsubscribeFn
- Parameters
  - eventName: keyof PageScopeEvents
  - handler: EventHandler<PageScopeEvents>
  Returns UnsubscribeFn

refresh

refresh: function

Refreshes the page currently shown in the Channel Manager.

Type declaration

- (): Promise<void>
- Returns Promise<void>