Class: SEN

Help4.widget.companionCore.SEN()

helper functionality for SEN backends

Constructor

new SEN()

Source:

Members

(static) NO_CACHE_HEADER

Header information for XHR to prohibit caching.
Source:

Methods

(static) createPubUrl(params) → {string}

creates a public url from a non-public one
Parameters:
Name Type Description
params Help4.widget.companionCore.SEN.CreatePubUrlParam
Source:
Returns:
Type
string

(static) doGetRequest(url) → {Promise.<*>}

Parameters:
Name Type Description
url string
Source:
Returns:
Type
Promise.<*>

(static) doMultifileRequest(config, params) → {Promise.<*>}

Parameters:
Name Type Description
config Help4.typedef.SystemConfiguration the system configuration
params Help4.widget.companionCore.SEN.MultifileParams the request information
Source:
Returns:
Type
Promise.<*>

(async, static) doMultifileWorkaround(params) → {Promise.<*>}

Parameters:
Name Type Description
params Help4.widget.companionCore.SEN.MultifileParams the request information
Source:
Returns:
Type
Promise.<*>

(async, static) doProjectRequest(config, serviceUrl, request) → {Promise.<(Help4.widget.companionCore.SEN.ProjectResponse|Help4.widget.companionCore.SEN.PubProjectResponse|null)>}

loads an SEN project
Parameters:
Name Type Description
config Help4.typedef.SystemConfiguration
serviceUrl string
request Help4.widget.help.catalogues.SEN.ProjectUrlConfig
Source:
Returns:
Type
Promise.<(Help4.widget.companionCore.SEN.ProjectResponse|Help4.widget.companionCore.SEN.PubProjectResponse|null)>

(static) getLanguages(config, allowDuplicatesopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
config Help4.typedef.SystemConfiguration the system configuration
allowDuplicates boolean <optional>
 false whether to allow duplicate language codes
Source:
Returns:
Type
Array.<string>

(static) getServerBaseUrl(serverUrl) → {string}

extracts the server base url from a full server url
Parameters:
Name Type Description
serverUrl string
Source:
Returns:
Type
string

(static) getXCSRF(serverBaseUrl) → {string}

Parameters:
Name Type Description
serverBaseUrl string the server base URL
Source:
Returns:
Type
string

Type Definitions

CatalogueResponse

Type:
  • Object
Properties:
Name Type Attributes Description
status * <optional>
 response status on error
response Array.<Help4.widget.help.catalogues.SEN.CatalogueProject> <optional>
 server response
Source:

ContextResponse

Type:
  • Object
Properties:
Name Type Attributes Description
status * <optional>
 response status on error
response Array.<Object> <optional>
Source:

CreatePubUrlParam

Type:
  • Object
Properties:
Name Type Attributes Description
serverBaseUrl string <optional>
 base URL of the content server
waId string <optional>
 ID of workspace on the sever
serverUrl string <optional>
 URL to the content on the server
tag string to be used tag
Source:

MultifileParams

Type:
  • Object
Properties:
Name Type Description
serverBaseUrl string base URL of the content server
request Array.<Help4.widget.companionCore.SEN.MultifileRequest> the request information
Source:

MultifileRequest

Type:
  • Object
Properties:
Name Type Attributes Default Description
url string URL on the server; relative to serverBaseUrl
method string <optional>
 GET GET, POST, PUT, DELETE
dataType string <optional>
 e.g. text, xml, json, multipart
Source:

ProjectDataResponse

Type:
  • Object
Properties:
Name Type Attributes Description
status * <optional>
 response status on error
response Help4.widget.help.project.SEN.Project <optional>
Source:

ProjectResponse

Type:
  • Object
Properties:
Name Type Attributes Description
pub Help4.widget.companionCore.SEN.ProjectResponsePub <nullable>
head Help4.widget.companionCore.SEN.ProjectResponseHead <nullable>
tagInfo Help4.widget.help.project.SEN.TagInfoList <nullable>
Source:

ProjectResponseHead

Type:
  • Object
Properties:
Name Type Description
entityXml Document
projectDpr Document
project Help4.widget.help.project.SEN.Project
Source:

ProjectResponsePub

Type:
  • Object
Properties:
Name Type Description
context Help4.widget.companionCore.SEN.PubProjectResponse
project Help4.widget.help.project.SEN.Project
Source:

ProjectResponses

Type:
Source:

PubProjectResponse

Type:
  • Object
Properties:
Name Type Description
contextType Help4.widget.help.ContextTypes
entityTxt Help4.widget.help.project.SEN.EntityTxt
lessonJs Help4.widget.help.project.SEN.LessonJs
Source:

TagResponse

Type:
  • Object
Properties:
Name Type Attributes Description
status * <optional>
 response status on error
response Object <optional>
Properties
Name Type Description
resource Help4.widget.help.project.SEN.TagInfoList
Source:

XmlResponse

Type:
  • Document | Object
Properties:
Name Type Attributes Description
status * <optional>
 response status on error
Source: