Class: UACP

Help4.widget.help.project.UACP()

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

Constructor

new UACP()

Source:

Methods

(protected, static) _parse(data, config, catalogueType) → {Help4.widget.help.Project}

Parameters:
Name Type Description
data Help4.widget.help.project.UACP.Project
config Help4.typedef.SystemConfiguration
catalogueType Help4.widget.help.CatalogueTypes
Source:
Returns:
Type
Help4.widget.help.Project

(async, static) load(projectId, config, data, catalogueTypeopt) → {Promise.<(Help4.widget.help.Projects|null)>}

Parameters:
Name Type Attributes Default Description
projectId string project ID
config Help4.typedef.SystemConfiguration the system configuration
data Help4.widget.help.Data
catalogueType Help4.widget.help.CatalogueTypes <optional>
 'UACP'
Source:
Returns:
Type
Promise.<(Help4.widget.help.Projects|null)>

Type Definitions

Project

Type:
  • Object
Properties:
Name Type Attributes Description
alias string
appUrl string
contextType Help4.widget.help.ContextTypes
editable string
environment string
id string
lastModifiedDate string
locale string
loio string
otherMetadata string | Object
product string
shortDescription string
state string
system string
tiles Array.<Help4.widget.help.project.UACP.ProjectTile>
title string
version string
conditions Object <optional>
Source:

ProjectTile

Type:
  • Object
Properties:
Name Type Description
content string
hotspotAssignments Array.<Help4.widget.help.project.UACP.ProjectTileHotspotAssignment>
id string
lastModifiedDate string
pageUrl string
summaryText string
tileOrder number
title string
tourAppUrl string
tourProduct string
tourVersion string
isMachineTranslated boolean
Source:

ProjectTileHotspotAssignment

Type:
  • Object
Properties:
Name Type Description
displayProperties string
hotspotAnchor string
Source: