Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChannelScope

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

Hierarchy

Index

Properties

Properties

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

page

page: PageScope

API for the current page in the current channel.

refresh

refresh: function

Refreshes the metadata of the currently shown channel (e.g. whether it has changes, the sitemap, etc.). The Channel Manager UI will be updated to reflect the channel’s refreshed metadata.

Type declaration

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