new mmir.Resources()
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}
-
Returns a string with the base path.
Returns:
Type Description String base path -
getBeepUrl(){String}
-
Returns a string with the path to the beep audio-file.
Returns:
Type Description String path to beep wav file -
getCompiledLayoutPath()
-
-
getCompiledViewPath()
-
-
getConfigurationFileUrl(){String}
-
Returns a string with the path to the configuration file.
Returns:
Type Description String path to configuration file -
getControllerPath(){String}
-
Returns a string with the path to the controllers.
Returns:
Type Description String controller path -
getDictionaryFileUrl(langCode){String}
-
Returns the name of the dictionary filename as string
Name Type Description langCodeString 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}
-
Returns a string with the path to the directories file (directory-strucure / file-list).
Returns:
Type Description String path to directories file -
getEnv(){String}
-
Returns:
Type Description String -
getEnvPlatform(){String}
-
Returns:
Type Description String -
getExtensionsPath(){String}
-
Returns a string with the path to the extensions.
Returns:
Type Description String extensions path -
getGeneratedGrammarsPath(){String}
-
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}
-
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}
-
Returns the name of the grammar filename as string
Name Type Description langCodeString 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}
-
Returns a string with the path to the Grammar-Plugins (ie. engines for grammar generation).
Returns:
Type Description String Grammar Plugin path -
getHelperPath(){String}
-
Returns a string with the path to the helpers.
Returns:
Type Description String helper path -
getHelperSuffix(){String}
-
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}
-
Returns default language as string.
Returns:
Type Description String default language -
getLanguagePath(){String}
-
Returns a string with the path to the languages.
Returns:
Type Description String language path -
getLayoutPath(){String}
-
Returns a string with the path to the layouts.
Returns:
Type Description String layout path -
getMediaPluginPath(){String}
-
Returns a string with the path to the Media-Plugins.
Returns:
Type Description String MediaPlugin path -
getModelPath(){String}
-
Returns a string with the path to the models.
Returns:
Type Description String model path -
getPartialsPrefix(){String}
-
Returns the prefix for partial filenames as string
Returns:
Type Description String prefix for partial filenames -
getSpeechConfigFileUrl(langCode){String}
-
Returns the name of the filename for the speech configuration as string
Name Type Description langCodeString optional OPTIONAL the language code (i.e. the ID) for the speech-configuration file Returns:
Name Type Description speech-configurationString filename speech-configurationString filename, or, if langCode is provided, the path to the speech-configuration file -
getViewPath(){String}
-
Returns a string with the path to the views.
Returns:
Type Description String view path -
getWorkerPath(){String}
-
Returns a string with the path to the workers.
Returns:
Type Description String worker path -
init(forBrowserParameter){Object}
-
Initialize the Resources singleton.
Name Type Description forBrowserParameterBoolean true for browser-environment, if false ANDROID environment Returns:
Type Description Object Object containing the instance of the class mmir.Resources -
isBrowserEnv(){Boolean}
-
Returns:
Type Description Boolean -
isCordovaEnv(){Boolean}
-
Returns:
Type Description Boolean