Class ConfigHelper

Java helper to expose OSGi configuration values to Javascript code

Index

Constructors

Methods

getConfigFactoryIdentifiers getConfigFactoryValue getConfigFactoryValues getConfigPids getConfigValue getConfigValues

Constructors

constructor

new ConfigHelper(): ConfigHelper
Returns ConfigHelper

Methods

getConfigFactoryIdentifiers

getConfigFactoryIdentifiers(factoryPid): string[]
Get the list of OSGi configuration factory PIDs for a given factory ID
Parameters
- factoryPid: string
Returns string[]
an array of String containing the OSGi configuration factory PIDs
- Defined in types/generated/build/types/org.jahia.modules.npm.modules.engine.js.server.d.ts:23

getConfigFactoryValue

getConfigFactoryValue(factoryPid, factoryIdentifier, key): string
Get a single configuration value for a given OSGi configuration factory PID, factory identifier and a property key
Parameters
- factoryPid: string
  the factory PID
- factoryIdentifier: string
  the factory identifier within the given factory PID
- key: string
  the property key
Returns string
a String containing the configuration value
- Defined in types/generated/build/types/org.jahia.modules.npm.modules.engine.js.server.d.ts:52

getConfigFactoryValues

getConfigFactoryValues(factoryPid, factoryIdentifier): any
Get the configuration values for a given OSGi configuration factory PID and factory identifier
Parameters
- factoryPid: string
  the factory PID
- factoryIdentifier: string
  the factory identifier within the given factory PID
Returns any
a Map<String, Object> containing the configuration values
- Defined in types/generated/build/types/org.jahia.modules.npm.modules.engine.js.server.d.ts:36

getConfigPids

getConfigPids(): string[]
Get the list of OSGi configuration PIDs

Returns string[]
an array of String containing the OSGi configuration PIDs
- Defined in types/generated/build/types/org.jahia.modules.npm.modules.engine.js.server.d.ts:18

getConfigValue

getConfigValue(configPid, key): string
Get a single configuration value for a given OSGi configuration PID and a property key
Parameters
- configPid: string
  the unique identifier of the OSGi configuration
- key: string
  the property key
Returns string
a String containing the configuration value
- Defined in types/generated/build/types/org.jahia.modules.npm.modules.engine.js.server.d.ts:43

getConfigValues

getConfigValues(configPid): any
Get the configuration values for a given OSGi configuration PID
Parameters
- configPid: string
  the unique identifier of the OSGi configuration
Returns any
a Map<String, Object> containing the configuration values
- Defined in types/generated/build/types/org.jahia.modules.npm.modules.engine.js.server.d.ts:29