Interface IInstalledLibrary

Objects of this interface represent installed libraries that have an id.

interface IInstalledLibrary {
    addTo?: {
        content?: { types?: { text?: { regex?: string } }[] };
        editor?: { machineNames: string[] };
        player?: { machineNames: string[] };
    };
    author?: string;
    coreApi?: { majorVersion: number; minorVersion: number };
    description?: string;
    dropLibraryCss?: { machineName: string }[];
    dynamicDependencies?: ILibraryName[];
    editorDependencies?: ILibraryName[];
    embedTypes?: ("div" | "iframe")[];
    fullscreen?: 0 | 1;
    h?: number;
    license?: string;
    machineName: string;
    majorVersion: number;
    metadataSettings?: { disable: 0 | 1; disableExtraTitleField: 0 | 1 };
    minorVersion: number;
    patchVersion: number;
    preloadedCss?: IPath[];
    preloadedDependencies?: ILibraryName[];
    preloadedJs?: IPath[];
    requiredExtensions?: { sharedState: number };
    restricted: boolean;
    runnable: boolean | 0 | 1;
    state?: {
        opLogicChecks: boolean;
        opSchema: boolean;
        snapshotLogicChecks: boolean;
        snapshotSchema: boolean;
    };
    title: string;
    w?: number;
    compare(otherLibrary: IInstalledLibrary): number;
    compareVersions(
        otherLibrary: ILibraryName & { patchVersion?: number },
    ): number;
}

Hierarchy (View Summary)

Implemented by

Properties

addTo? author? coreApi? description? dropLibraryCss? dynamicDependencies? editorDependencies? embedTypes? fullscreen? h? license? machineName majorVersion metadataSettings? minorVersion patchVersion preloadedCss? preloadedDependencies? preloadedJs? requiredExtensions? restricted runnable state? title w?

Methods

compare compareVersions

Properties

OptionaladdTo

addTo?: {
    content?: { types?: { text?: { regex?: string } }[] };
    editor?: { machineNames: string[] };
    player?: { machineNames: string[] };
}

Addons can be added to other content types by

Type declaration

  • Optionalcontent?: { types?: { text?: { regex?: string } }[] }
  • Optionaleditor?: { machineNames: string[] }

    Contains cases in which the library should be added to the editor.

    This is an extension to the H5P library metadata structure made by h5p-nodejs-library. That way addons can specify to which editors they should be added in general. The PHP implementation hard-codes this list into the server, which we want to avoid here.

    • machineNames: string[]

      A list of machine names in which the addon should be added.

  • Optionalplayer?: { machineNames: string[] }

    Contains cases in which the library should be added to the player.

    This is an extension to the H5P library metadata structure made by h5p-nodejs-library. That way addons can specify to which editors they should be added in general. The PHP implementation hard-codes this list into the server, which we want to avoid here.

    • machineNames: string[]

      A list of machine names in which the addon should be added.

Optionalauthor

author?: string

OptionalcoreApi

coreApi?: { majorVersion: number; minorVersion: number }

The core API required to run the library.

Optionaldescription

description?: string

OptionaldropLibraryCss

dropLibraryCss?: { machineName: string }[]

OptionaldynamicDependencies

dynamicDependencies?: ILibraryName[]

OptionaleditorDependencies

editorDependencies?: ILibraryName[]

OptionalembedTypes

embedTypes?: ("div" | "iframe")[]

Optionalfullscreen

fullscreen?: 0 | 1

Optionalh

h?: number

Optionallicense

license?: string

machineName

machineName: string

The name used to identify the library (e.g. H5P.Example)

majorVersion

majorVersion: number

The major version of the library (e.g. 1)

OptionalmetadataSettings

metadataSettings?: { disable: 0 | 1; disableExtraTitleField: 0 | 1 }

minorVersion

minorVersion: number

The minor version of the library (e.g. 0)

patchVersion

patchVersion: number

OptionalpreloadedCss

preloadedCss?: IPath[]

OptionalpreloadedDependencies

preloadedDependencies?: ILibraryName[]

OptionalpreloadedJs

preloadedJs?: IPath[]

OptionalrequiredExtensions

requiredExtensions?: { sharedState: number }

restricted

restricted: boolean

If set to true, the library can only be used be users who have this special privilege.

runnable

runnable: boolean | 0 | 1

Optionalstate

state?: {
    opLogicChecks: boolean;
    opSchema: boolean;
    snapshotLogicChecks: boolean;
    snapshotSchema: boolean;
}

title

title: string

Optionalw

w?: number

Methods

compare

compareVersions

  • compareVersions(otherLibrary: ILibraryName & { patchVersion?: number }): number

    Compares libraries by giving precedence to major version, then minor version, then if present patch version.

    Parameters

    Returns number

    a negative value: if this library is older than the other library a positive value: if this library is newer than the other library zero: if both libraries are the same (or if it can't be determined, because the patch version is missing in the other library)

Settings

Member Visibility

On This Page

Properties
Methods