interfaces~WebUserInterfaceManager()

new WebUserInterfaceManager()

Methods

afterPropertiesSet()

Initialization after the components in the application context have been constructed.

createInterface(name, description, path, folder, repository)

Creates a web user interface.
Parameters:
Name Type Description
name string The name of the web user interface.
description string The description of the web user interface.
path string The path to use on the web server of this Inexor Flex Instance (http://host:port/api/v1/interfaces/:path).
folder string The folder to be delivered (:flex_base_folder/interfaces/:path/:folder).
repository string The URL of the remote git repository.

disableInterface(name)

Disables a web user interface.
Parameters:
Name Type Description
name string The name of the web user interface.

enableInterface(name)

Enables a web user interface.
Parameters:
Name Type Description
name string The name of the web user interface.

getAbsoluteFsPath(name)

Returns the absolute filesystem path.
Parameters:
Name Type Description
name string The name of the web user interface.

getFullUrl(name)

Returns the full URL
Parameters:
Name Type Description
name string The name of the web user interface.

getInterfaceNames() → {array}

Returns the list of interface names.
Returns:
array - The names of the user interfaces

getPath(name)

Returns the local Removes a web user interface.
Parameters:
Name Type Description
name string The name of the web user interface.

getRelativeFsPath(name)

Returns the filesystem path relative to Inexor Flex.
Parameters:
Name Type Description
name string The name of the web user interface.

getRelativeUrl(name)

Returns the URL
Parameters:
Name Type Description
name string The name of the web user interface.

interfaceExists(name)

Returns true, if a web user interface exists with the given name.
Parameters:
Name Type Description
name string The name of the web user interface.

loadInterfaces(filenameopt) → {Promise.<(bool|string)>}

Loads a web user interface from TOML config.
Parameters:
Name Type Attributes Default Description
filename string <optional>
interfaces.toml The filename.
Returns:
Promise.<(bool|string)> - - either true or the error reason

removeInterface(name)

Removes a web user interface.
Parameters:
Name Type Description
name string The name of the web user interface.

scanForInterfaces()

Scans for web user interfaces found locally.

setDependencies()

Sets the dependencies from the application context.

updateInterface(name)

Updates the local git repository to the latest revision of the remote git repository.
Parameters:
Name Type Description
name string The name of the web user interface.

updateInterfaceNode(name)

Updates the tree node values for the given user interface.
Parameters:
Name Type Description
name string The name of the web user interface.