nw-skeleton

Class: App

appWrapper. App

App class - parent class for nw-skeleton based app instances This class has three methods that are important for application life cycle:
  • initialize
  • finalize
  • shutdown
All three methods are async, and called from nw-skeleton appWrapper automatically.

Initialize is called first and it loads application helpers, sets application basic data, and finally loads eventual subFiles from configuration, instantiate their classes and (await) call initialize methods on all classes that contain that method.

Finalize is called once both backend and frontend app have been initialized, and it has complete app structure and appState at its disposal. It will also automatically (await) call 'finalize' method on all sub classes that have it.

Shutdown is called before application window is closed or unloaded and should perform all necessary cleanup operations, remove any event listeners and free any remaining references left over from application usage. This method will also (await) call 'shutdown' method on any sub classes that have that method.

App()

app-wrapper/js/app.js, line 39
Creates App instance

Properties

Name Type Description
initialized Boolean Flag to indicate whether app instance is initialized
finalized Boolean Flag to indicate whether app instance is finalized

Extends

Methods

_doLog(debugMessage){undefined}

app-wrapper/js/lib/appBase.js, line 166

Parameters

Name Type Description
debugMessage Object Message object to be logged (returned by this.getMessageObject method)

Return

Does actual logging to console (and log file is file logging is enabled)

addBoundMethods(){undefined}

app-wrapper/js/lib/base.js, line 157

Return

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}

app-wrapper/js/lib/appBase.js, line 668

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

Return

Displays desktop notification Notification message is being interpolated by replacing placeholders such as '{1}', '{2}' etc. by corresponding values from 'data' argument

addModalMessage(message, type, data, important, dontTranslate, force, passToDebug){undefined}

app-wrapper/js/lib/appBase.js, line 587

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

Return

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}

app-wrapper/js/lib/appBase.js, line 624

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

Return

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}

app-wrapper/js/lib/appBase.js, line 317

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

Return

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

asyncMessage(data){mixed}

app-wrapper/js/lib/appBase.js, line 785

Parameters

Name Type Description
data Object Message data object

Return

Emits 'asyncMessage' global event, listened by main script

asyncMessageInfo(data, verboseOutput){Object}

app-wrapper/js/lib/appBase.js, line 852

Parameters

Name Type Description
data Object Message data.data object
verboseOutput Boolean Toggles verbose output

Return

Returns info on async messages that can be passed to mainScript

finalize(){boolean}

app-wrapper/js/app.js, line 98

Return

Finalizes app and its subfiles. This method is called once frontend application is created, so code here has all references that are available to the application

getConfig(name, defaultValue){mixed}

app-wrapper/js/lib/appBase.js, line 680

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

Return

Returns configuration var value

getDebugMessageFileLine(message){string}

app-wrapper/js/lib/appBase.js, line 281

Parameters

Name Type Description
message obj Message object to be logged (returned by this.getMessageObject method)

Return

Returns string representing log line for appending to debug log file

getHelper(name){Object}

app-wrapper/js/lib/base.js, line 217

Parameters

Name Type Description
name string Name of the helper

Return

Returns instance of helper object based on passed parameter (or false if helper can't be found)

getMessageFileLine(message){string}

app-wrapper/js/lib/appBase.js, line 229

Parameters

Name Type Description
message obj Message object to be logged (returned by this.getMessageObject method)

Return

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}

app-wrapper/js/lib/appBase.js, line 402

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

Return

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}

app-wrapper/js/lib/appBase.js, line 498

Parameters

Name Type Description
index mixed Key or array index
messageRowData Object Message row data for logging

Return

Gets single row for tabular message logging

getStateVar(varPath, defaultValue){mixed}

app-wrapper/js/lib/base.js, line 200

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

Return

Returns appState var value

getTableMessageData(message){Object}

app-wrapper/js/lib/appBase.js, line 470

Parameters

Name Type Description
message Object Tabular data

Return

Prepares table data for tabular message logging

getUserMessageFileLine(message){string}

app-wrapper/js/lib/appBase.js, line 261

Parameters

Name Type Description
message obj Message object to be logged (returned by this.getMessageObject method)

Return

Returns string representing log line for appending to user message log file

globalEmit(eventName, data){undefined}

app-wrapper/js/lib/appBase.js, line 734

Parameters

Name Type Description
eventName String Name of the event
data Object Event data object

Return

Emits event to globalEmitter (listened by both main script and app code)

initializeLogging(options){appWrapper.AppBaseClass}

app-wrapper/js/lib/appBase.js, line 67

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)

Return

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)

loadSubFiles(){undefined}

app-wrapper/js/app.js, line 145

Return

Loads application sub files Checks config.appConfig.subFiles array and loads any sub files that are present there. This config property is primarily to be used by app submodules - component modules etc. to allow them to perform necessary operations on application initialization, finalization or shutdown.

localRequire(moduleName){Object}

app-wrapper/js/app.js, line 255

Parameters

Name Type Description
moduleName string Name of module to require

Return

Local require for loading app modules from appWrapper

log(message, type, data, force){undefined}

app-wrapper/js/lib/appBase.js, line 106

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

Return

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}

app-wrapper/js/lib/appBase.js, line 745

Parameters

Name Type Description
data Object Event data object

Return

Emits 'message' global event, listened by main script

messageInfo(data, verboseOutput){Object}

app-wrapper/js/lib/appBase.js, line 821

Parameters

Name Type Description
data Object Message data.data object
verboseOutput Boolean Toggles verbose output

Return

Returns info on messages that can be passed to mainScript

messageInfoOutput(messageData, verboseOutput){undefined}

app-wrapper/js/lib/appBase.js, line 864

Parameters

Name Type Description
messageData Object Message response data
verboseOutput Boolean Toggles verbose output

Return

Logs messages info to console

setAppError(title, text, debugText, data, doNotTranslate, messageType, omitIcon){undefined}

app-wrapper/js/lib/appBase.js, line 928

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

Return

Sets (turns on) application error, triggering rendering of app-error component

shutdown(){boolean}

app-wrapper/js/app.js, line 124

Return

Shuts down application and all its dependencies, freeing memory, removing references and preparing for app exit

translate(text, currentLanguage, data){string}

app-wrapper/js/lib/appBase.js, line 719

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

Return

Returns translated value for passed arguments Translation is being interpolated by replacing placeholders such as '{1}', '{2}' etc. by corresponding values from 'data' argument