Methods
_doLog(debugMessage){undefined}
Parameters
| Name |
Type |
Description |
| debugMessage |
Object
|
Message object to be logged (returned by this.getMessageObject method) |
Does actual logging to console (and log file is file logging is enabled)
_getStack(){array}
Helper method for getting call stack array for debug or user message objects
addBoundMethods(){undefined}
Method that sets up this.boundMethods property by binding this objects
functions to itself to be used as event listener handlers
addDesktopNotification(message, data, dontTranslate, options, callbacks){undefined}
Parameters
| Name |
Type |
Description |
| message |
string
|
Notification message |
| data |
array
|
An array of data strings that are to be applied to notification |
| dontTranslate |
Boolean
|
Flag to prevent automatic notification translation |
| options |
Object
|
Desktop notification options (passed to HTML5 Notification object constructor) |
| callbacks |
Object
|
Object with onshow, onClicked, onClosed and onerror notification handlers |
Displays desktop notification
Notification message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
addEventListeners(){undefined}
Adds event listeners for this object
addModalMessage(message, type, data, important, dontTranslate, force, passToDebug){undefined}
Parameters
| Name |
Type |
Description |
| message |
string
|
Message to be logged |
| type |
string
|
Type of log message (debug, info, warning, error) |
| data |
array
|
An array of data strings that are to be applied to logging message |
| important |
Boolean
|
Flag to indicate message importance |
| dontTranslate |
Boolean
|
Flag to prevent automatic message translation |
| force |
Boolean
|
Flag to force message output even if configuration wouldn't allow it |
| passToDebug |
Boolean
|
Flag to force passing same message to debug log |
Adds modal message to currently open modal dialog
Message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
addNotification(message, type, data, dontTranslate, options){undefined}
Parameters
| Name |
Type |
Description |
| message |
string
|
Notification message |
| type |
string
|
Notification message type |
| data |
array
|
An array of data strings that are to be applied to notification |
| dontTranslate |
Boolean
|
Flag to prevent automatic notification translation |
| options |
Object
|
Additional notification options |
Displays app notification
Notification message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
addUserMessage(message, type, data, important, dontTranslate, force, passToDebug){undefined}
Parameters
| Name |
Type |
Description |
| message |
string
|
Message to be logged |
| type |
string
|
Type of log message (debug, info, warning, error) |
| data |
array
|
An array of data strings that are to be applied to logging message |
| important |
Boolean
|
Flag to indicate message importance |
| dontTranslate |
Boolean
|
Flag to prevent automatic message translation |
| force |
Boolean
|
Flag to force message output even if configuration wouldn't allow it |
| passToDebug |
Boolean
|
Flag to force passing same message to debug log |
Logs user message if conditions are met
Message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
applyComponentModuleData(componentModuleData, dirs, mapping, type){Object}
Parameters
| Name |
Type |
Description |
| componentModuleData |
Object
|
Components module data |
| dirs |
Array.<string>
|
Directories to load components from |
| mapping |
Object
|
Component mapping |
| type |
string
|
Component type ('component', 'globalComponent', 'modalComponent') |
Applies component module data to passed parameters
asyncMessage(data){mixed}
Parameters
| Name |
Type |
Description |
| data |
Object
|
Message data object |
Emits 'asyncMessage' global event, listened by main script
asyncMessageInfo(data, verboseOutput){Object}
Parameters
| Name |
Type |
Description |
| data |
Object
|
Message data.data object |
| verboseOutput |
Boolean
|
Toggles verbose output |
Returns info on async messages that can be passed to mainScript
clearIntervals(){undefined}
Clears all intervals bound to this AppWrapper instance
clearTimeouts(){undefined}
Clears all timeouts bound to this AppWrapper instance
destroy(){undefined}
Destructor method - cleans up references for this instance
freeing memory upon object destruction
finalize(){Boolean}
Finalizes current class instance, setting up any additional properties
etc. Entire app structure, including frontend app is available here
getAppState(){Object}
Helper method to get appState object
getAppWrapper(){AppWrapper}
Helper method to get appWrapper instance
getComponentMapping(mapping, componentName){Object|boolean}
Parameters
| Name |
Type |
Description |
| mapping |
Object
|
Component mapping from configuration |
| componentName |
string
|
Component name |
Find component mapping by its name
getComponentModuleData(){Object}
Gets data for components configured as node modules
getConfig(name, defaultValue){mixed}
Parameters
| Name |
Type |
Description |
| name |
string
|
String representing path to requested var (i.e. 'appConfig.appInfo.name') |
| defaultValue |
mixed
|
Default value to be returned if configuration var is not found |
Returns configuration var value
getDebugMessageFileLine(message){string}
Parameters
| Name |
Type |
Description |
| message |
obj
|
Message object to be logged (returned by this.getMessageObject method) |
Returns string representing log line for appending
to debug log file
getDebugMessageFilePath(){string}
Returns path to debug message log file
getHelper(name){Object}
Parameters
| Name |
Type |
Description |
| name |
string
|
Name of the helper |
Returns instance of helper object based on passed parameter (or false if helper can't be found)
getMessageFileLine(message){string}
Parameters
| Name |
Type |
Description |
| message |
obj
|
Message object to be logged (returned by this.getMessageObject method) |
Gets JSON represenation of message object for saving into log file,
removing unneccessary properties and adding necessary ones
getMessageObject(messageLevel, message, type, data, important, dontTranslate, force){Object}
Parameters
| Name |
Type |
Description |
| messageLevel |
int
|
Number representing current message level (0=debug, 1=info, 2=warning, 3=error) |
| message |
string
|
Message to be logged |
| type |
string
|
Type of log message (debug, info, warning, error) |
| data |
array
|
An array of data strings that are to be applied to logging message |
| important |
Boolean
|
Flag to indicate message importance |
| dontTranslate |
Boolean
|
Flag to prevent automatic message translation |
| force |
Boolean
|
Flag to force message output even if configuration wouldn't allow it |
Returns prepared message object based on passed arguments.
Message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
getMessageObjectRow(index, messageRowData){Object}
Parameters
| Name |
Type |
Description |
| index |
mixed
|
Key or array index |
| messageRowData |
Object
|
Message row data for logging |
Gets single row for tabular message logging
getStateVar(varPath, defaultValue){mixed}
Parameters
| Name |
Type |
Description |
| varPath |
string
|
String representing path to requested var (i.e. 'appData.appMainData.cancelable') |
| defaultValue |
mixed
|
Default value to be returned if appState var is not found |
Returns appState var value
getTableMessageData(message){Object}
Parameters
| Name |
Type |
Description |
| message |
Object
|
Tabular data |
Prepares table data for tabular message logging
getUserMessageFileLine(message){string}
Parameters
| Name |
Type |
Description |
| message |
obj
|
Message object to be logged (returned by this.getMessageObject method) |
Returns string representing log line for appending
to user message log file
getUserMessageFilePath(){string}
Returns path to user message log file
globalEmit(eventName, data){undefined}
Parameters
| Name |
Type |
Description |
| eventName |
String
|
Name of the event |
| data |
Object
|
Event data object |
Emits event to globalEmitter (listened by both main script and app code)
initDirectives(vueDirectiveData){array}
Parameters
| Name |
Type |
Description |
| vueDirectiveData |
Object
|
Vue directives data object |
Initializes vue directives
initFilters(){array}
Initializes Vue filters
initialize(){ComponentHelper}
Initializes ComponentHelper, loading and initializing components, mixins, filters and directives
initializeComponent(componentBaseDir, componentName, componentMapping, parentName, additionalSubComponents, overrideDirs){Object}
Parameters
| Name |
Type |
Description |
| componentBaseDir |
string
|
Base directory path |
| componentName |
string
|
Name of the component |
| componentMapping |
Object
|
Component mapping from configuration |
| parentName |
string
|
Name of the parent component |
| additionalSubComponents |
array
|
An array of eventual additional child components |
| overrideDirs |
Array.<string>
|
Override dirs to look for when loading components |
Iniitalizes single component
initializeComponents(){undefined}
Initializes components
Parameters
| Name |
Type |
Description |
| options |
Object
|
Options for logging initialization (currently only 'silent' property is used, determining whether warnings should be printed if no config found) |
Determines whether logging for this class is regulated through
configuration, setting the logging by it (or warning if there
are no configuration settings for this class)
initMixins(vueMixinData){array}
Parameters
| Name |
Type |
Description |
| vueMixinData |
Object
|
Vue mixin data object |
Initializes Vue mixins
isDebugEnabled(){Boolean}
Checks whether debug mode is on
loadComponentTemplate(component, loadDirs){Object}
Parameters
| Name |
Type |
Description |
| component |
Object
|
Component object |
| loadDirs |
Array.<string>
|
An array of dirs to load template from |
Loads component template
loadDirComponents(componentDirs){Object}
Parameters
| Name |
Type |
Description |
| componentDirs |
Array.<string>
|
Component directory path array |
Loads components from passed directories
loadDirectives(){array}
Loads and initializes directives for Vue app
loadMixins(){array}
Loads and initializes vue mixins
log(message, type, data, force){undefined}
Parameters
| Name |
Type |
Description |
| message |
string
|
Message to be logged |
| type |
string
|
Type of log message (debug, info, warning, error, group, groupCollaped, groupend) |
| data |
array
|
An array of data strings that are to be applied to logging message |
| force |
Boolean
|
Flag to force logging output even if config does not allow it |
Logs debug message if conditions are met
Message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
message(data){undefined}
Parameters
| Name |
Type |
Description |
| data |
Object
|
Event data object |
Emits 'message' global event, listened by main script
messageInfo(data, verboseOutput){Object}
Parameters
| Name |
Type |
Description |
| data |
Object
|
Message data.data object |
| verboseOutput |
Boolean
|
Toggles verbose output |
Returns info on messages that can be passed to mainScript
messageInfoOutput(messageData, verboseOutput){undefined}
Parameters
| Name |
Type |
Description |
| messageData |
Object
|
Message response data |
| verboseOutput |
Boolean
|
Toggles verbose output |
Logs messages info to console
prepareComponent(component, componentBaseDir, componentName, componentMapping, parentName, additionalSubComponents, overrideDirs, loadDirs){Object}
Parameters
| Name |
Type |
Description |
| component |
Object
|
Unprepared component object |
| componentBaseDir |
string
|
Base directory path |
| componentName |
string
|
Name of the component |
| componentMapping |
Object
|
Component mapping from configuration |
| parentName |
string
|
Name of the parent component |
| additionalSubComponents |
array
|
An array of eventual additional child components |
| overrideDirs |
Array.<string>
|
Override dirs to look for when loading components |
| loadDirs |
Array.<string>
|
LoadDirs for loading components |
Prepares single component
Loads component template, initializes its children using componentMapping argument, injects additional sub components if available, sets data if available,
prepares component css files if any, merges componentState with appState (if available), adds eventual filters, mixins and directives
This methods returns completely prepared component, ready to be used in the app
prepareComponentArray(params){Object}
Parameters
| Name |
Type |
Description |
| params |
array
|
Array with component parameters |
Prepares single component
See
- ComponentHelper#prepareComponent
processComponents(componentBaseDir, componentMapping, overrideDirs, type){array}
Parameters
| Name |
Type |
Description |
| componentBaseDir |
string
|
Base directory path |
| componentMapping |
Object
|
Component mapping from configuration |
| overrideDirs |
Array.<string>
|
Override dirs to look for when loading components |
| type |
string
|
Component type ('component', 'globalComponent', 'modalComponent') |
Processes components, loading their templates, css, and states
removeBoundMethods(){undefined}
Method that cleans up this.boundMethods property
set in this.addBoundMethods method
removeEventListeners(){undefined}
Removes event listeners for this object
resetAppError(){undefined}
Resets (turns off) application error, removing app-error component
setAppError(title, text, debugText, data, doNotTranslate, messageType, omitIcon){undefined}
Parameters
| Name |
Type |
Description |
| title |
String
|
App error title |
| text |
String
|
App error text |
| debugText |
String
|
App error debug text (shown only if debug is enabled) |
| data |
Array.<String>
|
An array with replacement data for error title, text and debugText |
| doNotTranslate |
Boolean
|
Flag to prevent automatic traslation of title and text |
| messageType |
String
|
null
|
Type of messages to show in app-error ('user', 'debug' or null) |
| omitIcon |
Boolean
|
Flag to control app-error icon rendering |
Sets (turns on) application error, triggering rendering of app-error component
translate(text, currentLanguage, data){string}
Parameters
| Name |
Type |
Description |
| text |
string
|
Text to be translated |
| currentLanguage |
string
|
Curent language code |
| data |
array
|
An array of data strings that are to be applied to translated message |
Returns translated value for passed arguments
Translation is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument