Class: Tracking

Help4.tracking.Tracking(params)

new Tracking(params)

Parameters:
Name Type Description
params Help4.tracking.Tracking.Params
Properties:
Name Type Attributes Description
controller Help4.controller.Controller
sessionId string
_searchInterval number <nullable>
_connectors Array.<Object>
Source:

Extends

Methods

(protected) ____defineDataFunctions()

Overrides:
Source:

(protected) ____defineProperties(params, derivedopt, nullable)

Parameters:
Name Type Attributes Default Description
params Object
derived Object <optional>
<nullable>
 null
Properties
Name Type Description
GET Object
SET Object
Overrides:
Source:

(protected) ____defineProperty(args)

Parameters:
Name Type Description
args Object
Properties
Name Type Attributes Default Description
type string <optional>
 'param' for Help4.jscore.DataBase
key string
info Help4.jscore.ControlBase.Param
funGet Help4.jscore.ControlBase.FunGet
funSet Help4.jscore.ControlBase.FunSet
Overrides:
Source:

(protected) ____defineStaticProperties()

auto define all to be cleaned properties
Overrides:
Source:
Throws:
Error

(protected) ____extendParams(dest, src) → {Object}

Parameters:
Name Type Description
dest Object
src Object
Overrides:
Source:
Returns:
Type
Object

(protected) ____getClassConfig() → {Help4.jscore.Base.Params}

Overrides:
Source:
Returns:
Type
Help4.jscore.Base.Params

(protected) ____getData() → {Object}

Overrides:
Source:
Returns:
Type
Object

(protected) ____mergeDerivedParams(level0, level1)

Parameters:
Name Type Description
level0 Help4.jscore.Base.Params
level1 Help4.jscore.Base.Params
Overrides:
Source:
Throws:
Error

(protected) ____resolveDerivedParams(classConfig)

Parameters:
Name Type Description
classConfig Help4.jscore.Base.Params
Overrides:
Source:

(protected) ____setInitValue(args)

Parameters:
Name Type Description
args Object
Properties
Name Type Description
key string
info Help4.jscore.ControlBase.Param
params Object
funSet Help4.jscore.ControlBase.FunSet
Overrides:
Source:

(protected) _destroyControl(…keys)

destroys class properties
Parameters:
Name Type Attributes Description
keys string <repeatable>
Overrides:
Source:

(protected) _fireEvent(event) → {Help4.jscore.Base}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Overrides:
Source:
Returns:
Type
Help4.jscore.Base

(async, protected) _fireEvent2(event) → {Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Overrides:
Source:
Returns:
Type
Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>

(protected) _fireEventSync(event) → {Array.<Help4.EmbeddedEvent.EventResponse>}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Overrides:
Source:
Returns:
Type
Array.<Help4.EmbeddedEvent.EventResponse>

addConnector(connectors)

Parameters:
Name Type Description
connectors Array.<Help4.tracking.Tracking.Connector>
Source:

addListenerSync(eventType, listener) → {Help4.jscore.Base}

add an event listener
Parameters:
Name Type Description
eventType string | Array.<string> event type to be observed
listener Help4.EmbeddedEvent.Listener the callback function
Overrides:
Source:
Returns:
Type
Help4.jscore.Base

deserialize(datanullable)

Parameters:
Name Type Attributes Description
data Object <nullable>
Source:

destroy()

destroys this instance
Overrides:
Source:

getSessionId() → {string}

Source:
Returns:
Type
string

isDestroyed() → {boolean}

whether instance is destroyed
Overrides:
Source:
Returns:
Type
boolean

serialize() → {Object}

Source:
Returns:
Type
Object

(async) trackHelpButton() → (nullable) {Promise.<void>}

tracks Help ? button interactions
Source:
Returns:
returns Promise for CMP4 only
Type
Promise.<void>

(async) trackLearningApp(params) → (nullable) {Promise.<void>}

tracks LearningApp interactions
Parameters:
Name Type Description
params Help4.tracking.Tracking.TrackParamLearningApp | Help4.tracking.Tracking.TrackParamSearch
Source:
Returns:
returns Promise for CMP4 only
Type
Promise.<void>

(async) trackProject(params) → (nullable) {Promise.<void>}

tracks help or tour projects
Parameters:
Name Type Description
params Help4.tracking.Tracking.TrackParams
Source:
Returns:
returns Promise for CMP4 only
Type
Promise.<void>

Type Definitions

Connector

Type:
  • Object
Properties:
Name Type Attributes Description
type string
url string <optional>
token string <optional>
callback function <optional>
Source:

Data

Type:
  • Object
Properties:
Name Type Description
verb Object
object Help4.tracking.Tracking.Object
context Object
Source:

ModelInfo

Type:
  • Object
Properties:
Name Type Attributes Description
projectTitle string <nullable>
backendType string
projectId string <nullable>
_prefix Object
Source:

Object

Type:
  • Object
Properties:
Name Type Attributes Description
screenId string
product string
version string
system string
role string <nullable>
editor boolean
language string
playbackTag string
sessionId string
solution string
customer_tenant string <nullable>
id string <nullable>
name string <nullable>
_modelInfo Help4.tracking.Tracking.ModelInfo
theme string <optional>
mobile boolean <optional>
rtl boolean <optional>
Source:

Params

Type:
  • Object
Properties:
Name Type Attributes Description
controller Help4.controller.Controller
sessionId string <optional>
Source:

TrackParamLearningApp

Type:
Properties:
Name Type Attributes Description
objectType string <optional>
id string
name string
Source:

TrackParamSearch

Type:
Properties:
Name Type Description
term string
getResults function
Source:

TrackParamTourClose

Type:
Properties:
Name Type Description
editMode boolean
step string
finished boolean
stepIndex number
totalSteps number
Source:

TrackParamTourOpen

Type:
Properties:
Name Type Description
editMode boolean
Source:

TrackParamTourStep

Type:
Properties:
Name Type Description
step string
title string
Source:

TrackParams

Type:
Source:

TrackParamsBasic

Type:
  • Object
Properties:
Name Type Attributes Description
verb string
type string <optional>
Source:

TrackParamsHelpOpenClose

Type:
Properties:
Name Type Description
editMode boolean
Source:
Type:
Properties:
Name Type Description
url string
title string
url string
Source:

TrackParamsTile

Type:
Properties:
Name Type Description
tile string
title string
Source: