Interface: FmcPageExtension<P>
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
| Name | Type |
|---|---|
P | extends AbstractFmcPage<any> |
Implemented by
Properties
page
• Readonly page: P
The page instance this extension is attached to
Defined in
src/sdk/fmc/FmcScreenPluginContext.ts:12
Methods
onPageDestroyed
▸ onPageDestroyed(): void
Callback fired after the page is destroyed
Returns
void
Defined in
src/sdk/fmc/FmcScreenPluginContext.ts:24
onPageHandleScrolling
▸ onPageHandleScrolling(scrollingEvent): boolean
Callback fired before the page processes a scrolling event
Parameters
| Name | Type | Description |
|---|---|---|
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)
Defined in
src/sdk/fmc/FmcScreenPluginContext.ts:49
onPageHandleSelectKey
▸ onPageHandleSelectKey(selectKeyEvent): boolean
Callback fired before the page processes a select key event
Parameters
| Name | Type | Description |
|---|---|---|
selectKeyEvent | LineSelectKeyEvent | the select key event |
Returns
boolean
true if the page should not continue processing the event (it will be considered to have handled it)
Defined in
src/sdk/fmc/FmcScreenPluginContext.ts:40
onPageInit
▸ onPageInit(): void
Callback fired after the page initializes
Returns
void
Defined in
src/sdk/fmc/FmcScreenPluginContext.ts:15
onPagePause
▸ onPagePause(): void
Callback fired after the page pauses
Returns
void
Defined in
src/sdk/fmc/FmcScreenPluginContext.ts:21
onPageRendered
▸ onPageRendered(renderedTemplates): void
Callback fired after the page renders, but before the FMC renderer renders the content
Parameters
| Name | Type | Description |
|---|---|---|
renderedTemplates | FmcRenderTemplate[] | the templates that were returned by the page's render (can be edited) |
Returns
void
Defined in
src/sdk/fmc/FmcScreenPluginContext.ts:31
onPageResume
▸ onPageResume(): void
Callback fired after the page resumes
Returns
void
Defined in
src/sdk/fmc/FmcScreenPluginContext.ts:18