Class: UACP

Help4.widget.help.catalogues.UACP()

this backend connector is able to handle UACP catalogue content for a RO model configuration

Constructor

new UACP()

Source:

Methods

(protected, static) _getUrl(config, appUrlopt) → {string}

Parameters:
Name Type Attributes Description
config Help4.typedef.SystemConfiguration the system configuration
appUrl Array.<string> <optional>
 enforce a certain appUrl
Source:
Returns:
Type
string

(protected, static) _parse(serverResponsenullable, catalogueTypeopt) → {Array.<Help4.widget.help.catalogues.UACP.CatalogueProject>|null}

Parameters:
Name Type Attributes Default Description
serverResponse Help4.widget.companionCore.UACP.CatalogueResponse <nullable>
 the server response
catalogueType Help4.widget.help.CatalogueTypes <optional>
 'UACP'
Source:
Returns:
Type
Array.<Help4.widget.help.catalogues.UACP.CatalogueProject> | null

(static) getDataType() → {Help4.widget.help.DataTypes}

Source:
Returns:
Type
Help4.widget.help.DataTypes

(async, static) load(config) → {Promise.<(Help4.widget.help.catalogues.UACP.CatalogueProjects|null)>}

Parameters:
Name Type Description
config Help4.typedef.SystemConfiguration the system configuration
Source:
Returns:
Type
Promise.<(Help4.widget.help.catalogues.UACP.CatalogueProjects|null)>

Type Definitions

CatalogueProject

Type:
  • Object
Properties:
Name Type Attributes Description
alias string alternative project name
appUrl string screen ID
cloneSrc string <optional>
 clone source for compatibility with SEN backends; internally added
conditions Array <optional>
 possible conditions
contextType Help4.widget.help.ContextTypes HELP or TOUR
editable string
environment string
id string project ID
lastModifiedDate string last modification time
locale string project language
loio string project LOIO (LOgical Info Object)
otherMetadata string | Object <optional>
 CMP specific information stored within UACP; JSON format
product string context information
shortDescription string context information
state string DRAFT, ...
system string context information
title string title of the project
version string context information
_catalogueType Help4.widget.help.CatalogueTypes <optional>
 SEN, SEN2, UACP, ...; internally added
_dataType Help4.widget.help.DataTypes <optional>
 SEN, UACP, ...; internally added
Source:

CatalogueProjects

Type:
  • Object
Properties:
Name Type Description
pub Array.<Help4.widget.help.catalogues.UACP.CatalogueProject> | null public catalogue projects for end-users
Source: