H5P NodeJS Library
    Preparing search index...

    Hierarchy

    Index

    Constructors

    Accessors

    • get h5pInstance(): IH5PInstance

      The internal H5P instance object of the H5P content.

      Only available after the initialized event was fired. Important: This object is only partially typed and there are more properties and methods on it!

      Returns IH5PInstance

    • get h5pObject(): IH5P

      The global H5P object / namespace (normally accessible through "H5P..." or "window.H5P") of the content type. Depending on the embed type this can be an object from the internal iframe, so you can use it to break the barrier of the iframe and execute JavaScript inside the iframe.

      Only available after the initialized event was fired. Important: This object is only partially typed and there are more properties and methods on it!

      Returns IH5P

    Methods

    • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

      Returns void

    • Called immediately after updating occurs. Not called for the initial render.

      The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

      Returns void

    • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

      Returns void

    • Returns the copyright notice in HTML that you can insert somewhere to display it. Undefined if there is no copyright information.

      Returns string

    • Runs before React applies the result of Component.render render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before Component.render render causes changes to it.

      Note: the presence of this method prevents any of the deprecated lifecycle events from running.

      Returns void

    • Returns boolean

      true if there is copyright information to be displayed.

    • Asks the H5P content to resize itself inside the dimensions of the container.

      Has no effect until the H5P object has fully initialized.

      Returns void

    • Displays the copyright notice in the regular H5P way.

      Returns void