Skip to content

Enumeration: EcomHooks

This enumeration contains the possible hooks to use. See the example for more information.

Enumeration Members

CONTENT_CHANGED

• CONTENT_CHANGED = "contentChanged"

A hook that is fired when the content of a section has been changed via the Content Creator. Not fired when a new section is created via 'Add content' button. Use SECTION_CREATED instead. This is a proxy for TPP.onContentChange.

ENSURED_PAGE_EXISTS

• ENSURED_PAGE_EXISTS = "ensuredPageExists"

A hook that is fired when a necessary page was created or found to create a new section.

OPEN_STOREFRONT_URL

• OPEN_STOREFRONT_URL = "openStoreFrontUrl"

A hook that is fired when a new storefront page should be navigated to. For example on a report click in the Content Creator or a click on the Content Creator navigation.

PAGE_CREATED

• PAGE_CREATED = "pageCreated"

A hook that is fired when a new page is created via the 'Create page' button in the Content Creator.

PAGE_CREATING

• PAGE_CREATING = "pageCreating"

A hook that is fired when a page could not be found when trying to create a section and a new one is directly created.

PAGE_CREATION_FAILED

• PAGE_CREATION_FAILED = "pageCreationFailed"

A hook that is fired after Page Creation has failed.

PREVIEW_INITIALIZED

• PREVIEW_INITIALIZED = "previewInitialized"

This hook can be called as soon as the TPP object is fully loaded. It provides an interface to access internal APIs.

REQUEST_PREVIEW_ELEMENT

• REQUEST_PREVIEW_ELEMENT = "requestPreviewElement"

A hook that is fired when the language is changed or an item is clicked in the Content Creator navigation. This is a proxy for TPP.onRequestPreviewElement.

RERENDER_VIEW

• RERENDER_VIEW = "rerenderView"

A hook that is fired when some elements are changed inside the preview, which causes SNAP to fire an event to reload the page. In an SPA, this can be handled with updating the current page object.

SECTION_CREATED

• SECTION_CREATED = "sectionCreated"

A hook that is fired when a new section is created via the 'Add Content' button in the Content Creator.

SECTION_CREATION_CANCELLED

• SECTION_CREATION_CANCELLED = "sectionCreationCancelled"

A hook that is fired after Section Creation has been cancelled.