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 (View Summary)

ContentScanner
- ContentFileScanner

Index

Constructors

Methods

scanContent scanForFiles

Constructors

constructor

new ContentFileScanner(libraryManager: LibraryManager): ContentFileScanner
Parameters
- libraryManager: LibraryManager
Returns ContentFileScanner
Overrides ContentScanner.constructor
- Defined in ContentFileScanner.ts:55

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>
Inherited from ContentScanner.scanContent
- Defined in ContentScanner.ts:48

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
- mainParams: any
  the parameters of the content to scan
- mainLibraryName: ILibraryName
  the library name of the content in the parameters
Returns Promise<IFileReference[]>
a list of local files
- Defined in ContentFileScanner.ts:73