Skip to main content

Interface: FmcPageExtension<P>

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:10

Allows extending an existing FMC page with custom behaviour, including replacing, in part or completely, rendered templates.

It is recommended to use AbstractFmcPageExtension when creating page extensions.

Type Parameters

Type Parameter
P extends AbstractFmcPage<any>

Properties

page

readonly page: P

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:12

The page instance this extension is attached to

Methods

onPageDestroyed()?

optional onPageDestroyed(): void

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:24

Callback fired after the page is destroyed

Returns

void


onPageHandleScrolling()?

optional onPageHandleScrolling(scrollingEvent): boolean

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:49

Callback fired before the page processes a scrolling event

Parameters

ParameterTypeDescription
scrollingEvent"pageLeft" | "pageRight" | "pageUp" | "pageDown"the scrolling event

Returns

boolean

true if the page should not continue processing the event (it will be considered to have handled it)


onPageHandleSelectKey()?

optional onPageHandleSelectKey(selectKeyEvent): boolean

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:40

Callback fired before the page processes a select key event

Parameters

ParameterTypeDescription
selectKeyEventLineSelectKeyEventthe select key event

Returns

boolean

true if the page should not continue processing the event (it will be considered to have handled it)


onPageInit()?

optional onPageInit(): void

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:15

Callback fired after the page initializes

Returns

void


onPagePause()?

optional onPagePause(): void

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:21

Callback fired after the page pauses

Returns

void


onPageRendered()?

optional onPageRendered(renderedTemplates): void

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:31

Callback fired after the page renders, but before the FMC renderer renders the content

Parameters

ParameterTypeDescription
renderedTemplatesFmcRenderTemplate[]the templates that were returned by the page's render (can be edited)

Returns

void


onPageResume()?

optional onPageResume(): void

Defined in: src/sdk/fmc/FmcScreenPluginContext.ts:18

Callback fired after the page resumes

Returns

void