Class ContentFileScanner

Scans the content parameters (=content.json) of a piece of content and returns a list of references to file that are embedded inside the content.

Hierarchy

  • ContentScanner
    • ContentFileScanner

Constructors

constructor

Methods

scanContent scanForFiles

Constructors

constructor

Methods

scanContent

  • scanContent(
        params: any,
        mainLibraryName: ILibraryName,
        callback: ScanCallback,
    ): Promise<void>

    Scans the specified parameters and executes the callback for every element in the tree. This includes nested content!

    Parameters

    • params: any

      the params to scan

    • mainLibraryName: ILibraryName

      the library name

    • callback: ScanCallback

      a function that is executed for every element in the semantic structure. Return true in it to abort the scan for the element itself and all of its children (the rest of the scan will continue).

    Returns Promise<void>

scanForFiles

  • scanForFiles(
        mainParams: any,
        mainLibraryName: ILibraryName,
    ): Promise<IFileReference[]>

    Loads the specified content from the ContentManager and scans its parameters (= content.json) for references to local files (= audio, video, images, generic files).

    Parameters

    Returns Promise<IFileReference[]>

    a list of local files

Settings

Member Visibility

On This Page

Constructors
Methods