Class: SEN

Help4.widget.help.catalogues.SEN()

this backend connector is able to handle SEN catalogue content for a RO model configuration - in case of SEN config: will download published and head data - in case of EXT config: will only download published data

Constructor

new SEN()

Source:

Methods

(protected, static) _getUrls(config, serviceUrl) → {Help4.widget.help.catalogues.SEN.CatalogueUrlConfig}

Parameters:
Name Type Description
config Help4.typedef.SystemConfiguration the system configuration
serviceUrl string the server base URL
Source:
Returns:
Type
Help4.widget.help.catalogues.SEN.CatalogueUrlConfig

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

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

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

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

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

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

Type Definitions

CatalogueProject

Type:
  • Object
Properties:
Name Type Attributes Description
alias string <optional>
 alternative project name; internally added
appUrl string screen ID
clone_src string <optional>
 clone source of project
cloneSrc string <optional>
 reduced clone source of project; internally added
conditions string | Array.<*> possible conditions; stringified JSON or array
contextType Help4.widget.help.ContextTypes context type
hidden boolean whether project is hidden for end-users
id string project ID
locale string project language
loio string project LOIO (LOgical Info Object)
maxversion number | string <optional>
 highest version of project
modification_time string time of last modification
product string context information
published Help4.widget.help.PUBLISHED_STATUS <optional>
 project published information
system string context information
title string title of the project
version string context information
wt number <optional>
 write token information
wt_location string <optional>
 write token information
wt_owner string <optional>
 write token 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 Attributes Description
pub Array.<Help4.widget.help.catalogues.SEN.CatalogueProject> | null public catalogue projects for end-users
head Array.<Help4.widget.help.catalogues.SEN.CatalogueProject> | null <optional>
 non-public catalogue projects for authors
Source:

CatalogueUrlConfig

Type:
  • Object
Properties:
Name Type Description
serverBaseUrl string base URL of the content server
pubUrl string URL extension to public end-user content
headUrl string URL extension to non-public author only content
Source: