JSDoc: Class: SEN

Constructor

new SEN()

Source:

widget/help/project/SEN.js, line 261

Methods

(protected, static) _assembleHead(head, tagInfo, config) → {Help4.widget.companionCore.SEN.PubProjectResponse|null}

Parameters:

Name Type Description

head

Help4.widget.companionCore.SEN.ProjectResponseHead

Properties

Name	Type	Description
`entityXml`	Document
`projectDpr`	Document
`project`	Help4.widget.help.project.SEN.Project

tagInfo Help4.widget.help.project.SEN.TagInfoList

config Help4.typedef.SystemConfiguration

Source:

widget/help/project/SEN.js, line 359

Returns:

Type: Help4.widget.companionCore.SEN.PubProjectResponse | null

(protected, static) _assemblePub(pub, tagInfo, config) → {Help4.widget.companionCore.SEN.PubProjectResponse|null}

Parameters:

Name Type Description

pub

Help4.widget.companionCore.SEN.ProjectResponsePub

Properties

Name	Type	Description
`context`	Help4.widget.companionCore.SEN.PubProjectResponse
`project`	Help4.widget.help.project.SEN.Project

tagInfo Help4.widget.help.project.SEN.TagInfoList

config Help4.typedef.SystemConfiguration

Source:

widget/help/project/SEN.js, line 336

Returns:

Type: Help4.widget.companionCore.SEN.PubProjectResponse | null

(protected, static) _getUrls(projectId, config, serviceUrl) → {Help4.widget.help.project.SEN.ProjectUrlConfig}

Parameters:

Name	Type	Description
`projectId`	string	the project id
`config`	Help4.typedef.SystemConfiguration	the system configuration
`serviceUrl`	string	the server base URL

Source:

widget/help/project/SEN.js, line 316

Returns:

Type: Help4.widget.help.project.SEN.ProjectUrlConfig

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

Parameters:

Name Type Attributes Default Description

data

Help4.widget.companionCore.SEN.PubProjectResponse

Properties

Name	Type	Description
`contextType`	Help4.widget.help.ContextTypes
`entityTxt`	Help4.widget.help.project.SEN.EntityTxt
`lessonJs`	Help4.widget.help.project.SEN.LessonJs

config Help4.typedef.SystemConfiguration

catalogueType Help4.widget.help.CatalogueTypes <optional> 'SEN'

isExtension boolean <optional> false

Source:

widget/help/project/SEN.js, line 388

Returns:

Type: Help4.widget.help.Project

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

Parameters:

Name	Type	Description
`projectId`	string	project ID
`config`	Help4.typedef.SystemConfiguration	the system configuration
`data`	Help4.widget.help.Data

Source:

widget/help/project/SEN.js, line 268

Returns:

Type: Promise.<(Help4.widget.help.Projects|null)>

Type Definitions

EntityTxt

Type:

Object

Properties:

Name Type Attributes Description

assets *

caption string

conditions string

context_id string

created_by string

creation_time string

creator string

cwa_recommended_sync_mode string

description string

h4_loio string

h4_product string

h4_product_version string

h4_system string

hidden boolean <optional>

language string

macroset string

mastery_score_percent string

max_score_percent string

modification_time string

modified_by string

sub_type string

tclass string

uid string

info

Object

Properties

Name	Type	Description
`published`	Help4.widget.help.PUBLISHED_STATUS
`playbackTag`	Help4.widget.help.PUBLISHED_STATUS

Source:

widget/help/project/SEN.js, line 133

LessonJs

Type:

Object

Properties:

Name Type Description

global_params Object

tourstops Array.<Help4.widget.help.project.SEN.LessonJsTourstop>

user_header

Object

Properties

Name	Type	Description
`audio_ext`	string
`author`	string
`comment`	string
`language`	string
`mastery_score_percent`	string
`max_score_percent`	string
`shelftype`	string
`title`	string
`version`	string

Source:

widget/help/project/SEN.js, line 240

LessonJsMacro

Type:

Help4.widget.help.project.SEN.LessonJsMacroStartUnit | Help4.widget.help.project.SEN.LessonJsMacroLinkTile | Help4.widget.help.project.SEN.LessonJsMacroHelpTile | Help4.widget.help.project.SEN.LessonJsMacroDefineTarget | Help4.widget.help.project.SEN.LessonJsMacroGuideClick

Source:

widget/help/project/SEN.js, line 218

LessonJsMacroArray

Type:

Array.<Help4.widget.help.project.SEN.LessonJsMacro>

Source:

widget/help/project/SEN.js, line 222

LessonJsMacroDefineTarget

Type:

Object

Properties:

Name	Type	Description
`duration`	number
`key`	string	screen ID
`macro_template`	'define_target'
`time`	number
`uid`	string

Source:

widget/help/project/SEN.js, line 171

LessonJsMacroGuideClick

Type:

Object

Properties:

Name Type Description

bubble_centered boolean

bubble_orientation string

bubble_size string

bubble_text string

bubble_type string

caption string

conditions string

duration number

hotspot string

hotspot_element_type string

manual_manual_offset

Object

Properties

Name	Type	Description
`top`	number
`left`	number

hotspot_offset boolean

hotspot_rect_delta

Object

Properties

Name	Type	Description
`width`	number
`height`	number

hotspot_spotlight boolean

hotspot_style string

macro_template 'guide_click'

show_arrow boolean

show_title_bar boolean

time number

tourstep_auto_progress string

tourstep_auto_skip boolean

uid string

Source:

widget/help/project/SEN.js, line 180

LessonJsMacroHelpTile

Type:

Object

Source:

widget/help/project/SEN.js, line 210

LessonJsMacroLinkTile

Type:

Object

Source:

widget/help/project/SEN.js, line 214

LessonJsMacroStartUnit

Type:

Object

Properties:

Name	Type	Description
`duration`	number
`macro_template`	'start_unit'
`time`	number
`uid`	string

Source:

widget/help/project/SEN.js, line 163

LessonJsTourstop

Type:

Object

Properties:

Name	Type	Description
`audio`	string
`audio_duration`	number
`callable`	boolean
`duration`	number
`index`	index
`jumpable`	boolean
`macros`	Help4.widget.help.project.SEN.LessonJsMacroArray
`title`	string
`uid`	string
`visible`	boolean

Source:

widget/help/project/SEN.js, line 226

Project

Type:

Object

Properties:

Name	Type	Description
`Meta`	Help4.widget.help.project.SEN.ProjectMeta
`Tags`	Help4.widget.help.project.SEN.ProjectTags
`Versions`	Help4.widget.help.project.SEN.ProjectVersions
`active`	boolean
`assets`	Array.<*>
`assignee`	string
`caption`	string
`conditions`	string
`context_id`	string
`created_by`	string
`creation_time`	string
`creator`	string
`cwa_recommended_sync_mode`	string
`description`	string
`entity_published_path`	*
`fallback_has_entity`	boolean
`h4_loio`	string
`h4_product`	string
`h4_product_version`	string
`h4_system`	string
`hidden`	number
`language`	string
`macroset`	string
`mastery_score_percent`	string
`max_score_percent`	string
`maxversion`	string
`modification_time`	string
`modified_by`	string
`ref_status`	string
`status`	string
`sub_type`	string
`uid`	string
`workflow_uid`	string

Source:

widget/help/project/SEN.js, line 96

ProjectMeta

Type:

Object

Properties:

Name	Type	Description
`Commits`	Array.<Object>
`Streams`	Array.<Object>
`wt`	number	write token status

Source:

widget/help/project/SEN.js, line 68

ProjectTag

Type:

Object

Properties:

Name	Type	Description
`tag`	string
`version`	string

Source:

widget/help/project/SEN.js, line 75

ProjectTags

Type:

Array.<Help4.widget.help.project.SEN.ProjectTag>

Source:

widget/help/project/SEN.js, line 81

ProjectUrlConfig

Type:

Object

Properties:

Name	Type	Attributes	Default	Description
`serverBaseUrl`	string			base URL of the content server
`pubUrl`	string			URL extension to public end-user content
`headUrl`	string	<optional>	null	URL extension to non-public author only content