Class H5PContentUpgradeProcess

Handle content upgrades. Converts content of an older version to a newer version by running the registered upgrade hooks.

See

https://h5p.org/h5p-content-upgrade

Index

Constructors

Methods

processField processParams upgrade

Constructors

constructor

new H5PContentUpgradeProcess(
    name: string,
    oldVersion: H5PVersion,
    newVersion: H5PVersion,
    params: string,
    id: string | number,
    loadLibrary: LoadLibraryCallback,
    done: UpgradeDone,
): H5PContentUpgradeProcess
Parameters
- name: string
  Library name of the content
- oldVersion: H5PVersion
  Version the content is on
- newVersion: H5PVersion
  Version to upgrade the content to
- params: string
  Params of the content as a JSON string
- id: string | number
  id of the content that is to be upgraded
- loadLibrary: LoadLibraryCallback
  Load library to upgrade
- done: UpgradeDone
  Callback with error and result parameters
Returns H5PContentUpgradeProcess
- Defined in H5PObject/classes/H5PContentUpgradeProcess.ts:28

Methods

processField

processField(
    field: unknown,
    params: unknown,
    done: (error?: H5PUpgradeError | null) => void,
): void
Check if params needs to be upgraded for the given field.
Parameters
- field: unknown
- params: unknown
- done: (error?: H5PUpgradeError | null) => void
Returns void
- Defined in H5PObject/classes/H5PContentUpgradeProcess.ts:73

processParams

processParams(
    library: unknown,
    oldVersion: H5PVersion,
    newVersion: H5PVersion,
    params: unknown,
    metadata: unknown,
    next: (
        error: H5PUpgradeError | null,
        params?: unknown,
        metadata?: unknown,
    ) => void,
): void
Run upgrade hooks on params.
Parameters
- library: unknown
- oldVersion: H5PVersion
- newVersion: H5PVersion
- params: unknown
- metadata: unknown
- next: (error: H5PUpgradeError | null, params?: unknown, metadata?: unknown) => void
Returns void
- Defined in H5PObject/classes/H5PContentUpgradeProcess.ts:57

upgrade

upgrade(
    name: string,
    oldVersion: H5PVersion,
    newVersion: H5PVersion,
    params: unknown,
    metadata: unknown,
    done: (
        error: H5PUpgradeError | null,
        params?: unknown,
        metadata?: unknown,
    ) => void,
): void
Run content upgrade.
Parameters
- name: string
- oldVersion: H5PVersion
- newVersion: H5PVersion
- params: unknown
- metadata: unknown
- done: (error: H5PUpgradeError | null, params?: unknown, metadata?: unknown) => void
Returns void
- Defined in H5PObject/classes/H5PContentUpgradeProcess.ts:41