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

Methods

Methods

get

get(): Promise<PageProperties>

- Defined in api.ts:222
Returns Promise<PageProperties>

A Promise that resolves with PageProperties of the current page.

on

on(eventName: keyof PageScopeEvents, handler: EventHandler<PageScopeEvents>): UnsubscribeFn

Inherited from Emitter.on
- Defined in api.ts:243
Subscribes a handler for events emitted by the CMS. The type of the emitted value depends on the emitted event.

Parameters
- eventName: keyof PageScopeEvents
  
  the name of the emitted event.
- handler: EventHandler<PageScopeEvents>
  
  the function to call with the emitted value.
Returns UnsubscribeFn

A function to unsubscribe the handler again.

refresh

refresh(): Promise<void>

- Defined in api.ts:227
Refreshes the page currently shown in the Channel Manager.

Returns Promise<void>