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

Methods

Properties

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>

Methods

on

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

    Parameters

    • eventName: keyof ChannelScopeEvents

      the name of the emitted event.

    • handler: EventHandler<ChannelScopeEvents>

      the function to call with the emitted value.

    Returns UnsubscribeFn

    A function to unsubscribe the handler again.