MMIR Framework

Class: Resources

mmir. Resources

new mmir.Resources()

tools/resources.js, line 3
A Utility class that provides various resources and constants.

Note that the actual values depend on the execution environment (e.g. ANDROID vs. BROWSER). As a consequence the resources object has multiple modes, that can be switched via the init -method, e.g. init(false).

Example
var appBase = mmir.res.getBasePath();

Requires

  • module:org.apache.cordova.device:

Methods

getBasePath(){String}

tools/resources.js, line 321
Returns a string with the base path.
Returns:
Type Description
String base path

getBeepUrl(){String}

tools/resources.js, line 507
Returns a string with the path to the beep audio-file.
Returns:
Type Description
String path to beep wav file

getCompiledLayoutPath()

tools/resources.js, line 341

getCompiledViewPath()

tools/resources.js, line 369

getConfigurationFileUrl(){String}

tools/resources.js, line 481
Returns a string with the path to the configuration file.
Returns:
Type Description
String path to configuration file

getControllerPath(){String}

tools/resources.js, line 391
Returns a string with the path to the controllers.
Returns:
Type Description
String controller path

getDictionaryFileUrl(langCode){String}

tools/resources.js, line 523
Returns the name of the dictionary filename as string
Name Type Description
langCode String optional OPTIONAL the language code (i.e. the ID) for the dictionary file
Returns:
Type Description
String dictionary filename, or, if langCode is provided, the path to the dictionary file

getDirectoriesFileUrl(){String}

tools/resources.js, line 494
Returns a string with the path to the directories file (directory-strucure / file-list).
Returns:
Type Description
String path to directories file

getEnv(){String}

tools/resources.js, line 653
Returns:
Type Description
String

getEnvPlatform(){String}

tools/resources.js, line 665
Returns:
Type Description
String

getExtensionsPath(){String}

tools/resources.js, line 424
Returns a string with the path to the extensions.
Returns:
Type Description
String extensions path

getGeneratedGrammarsPath(){String}

tools/resources.js, line 459
Returns a string with the path to the directory that contains the generated/executable grammars.
Returns:
Type Description
String path for generated grammars (JavaScript files)

getGeneratedStateModelsPath(){String}

tools/resources.js, line 470
Returns a string with the path to the directory that contains the generated/executable state models (compiled SCXML).
Returns:
Type Description
String path for generated state models (JavaScript files)

getGrammarFileUrl(langCode){String}

tools/resources.js, line 563
Returns the name of the grammar filename as string
Name Type Description
langCode String optional OPTIONAL the language code (i.e. the ID) for the grammar file
Returns:
Type Description
String grammar filename, or, if langCode is provided, the path to the grammar file

getGrammarPluginPath(){String}

tools/resources.js, line 448
Returns a string with the path to the Grammar-Plugins (ie. engines for grammar generation).
Returns:
Type Description
String Grammar Plugin path

getHelperPath(){String}

tools/resources.js, line 413
Returns a string with the path to the helpers.
Returns:
Type Description
String helper path

getHelperSuffix(){String}

tools/resources.js, line 590
Returns the suffix for helper filenames as string. A helpers filename looks like: "ControllerName"+"Helper"+".js"
Returns:
Type Description
String suffix for helper filenames

getLanguage(){String}

tools/resources.js, line 601
Returns default language as string.
Returns:
Type Description
String default language

getLanguagePath(){String}

tools/resources.js, line 380
Returns a string with the path to the languages.
Returns:
Type Description
String language path

getLayoutPath(){String}

tools/resources.js, line 335
Returns a string with the path to the layouts.
Returns:
Type Description
String layout path

getMediaPluginPath(){String}

tools/resources.js, line 435
Returns a string with the path to the Media-Plugins.
Returns:
Type Description
String MediaPlugin path

getModelPath(){String}

tools/resources.js, line 352
Returns a string with the path to the models.
Returns:
Type Description
String model path

getPartialsPrefix(){String}

tools/resources.js, line 579
Returns the prefix for partial filenames as string
Returns:
Type Description
String prefix for partial filenames

getSpeechConfigFileUrl(langCode){String}

tools/resources.js, line 544
Returns the name of the filename for the speech configuration as string
Name Type Description
langCode String optional OPTIONAL the language code (i.e. the ID) for the speech-configuration file
Returns:
Name Type Description
speech-configuration String filename
speech-configuration String filename, or, if langCode is provided, the path to the speech-configuration file

getViewPath(){String}

tools/resources.js, line 363
Returns a string with the path to the views.
Returns:
Type Description
String view path

getWorkerPath(){String}

tools/resources.js, line 402
Returns a string with the path to the workers.
Returns:
Type Description
String worker path

init(forBrowserParameter){Object}

tools/resources.js, line 615
Initialize the Resources singleton.
Name Type Description
forBrowserParameter Boolean true for browser-environment, if false ANDROID environment
Returns:
Type Description
Object Object containing the instance of the class mmir.Resources

isBrowserEnv(){Boolean}

tools/resources.js, line 629
Returns:
Type Description
Boolean

isCordovaEnv(){Boolean}

tools/resources.js, line 640
Returns:
Type Description
Boolean