Skip to main content
Pentaho Documentation

IContext

pentaho.context.IContext

The IContext interface allows access to environmental information of the Pentaho Platform. For example, it allows access to user, theme, locale, application and server.

Not all information is always available, or sometimes it is not fixed, and so some of these can be null. Check the documentation of each property and sub-property.

Source: doc-js/pentaho/context/IContext.jsdoc, line 17

Members

Name Description
application : nonEmptyString

Gets the identifier of the client application.

locale : nonEmptyString

Gets the identifier of the locale.

reservedChars : nonEmptyString

Gets the reserved characters for file names, all concatenated in a single string.

server : pentaho.context.IServer

Gets information about the server web application.

theme : nonEmptyString

Gets the identifier of the theme.

user : pentaho.context.IUser

Gets information about the user.

Methods

Name Description
createChild(childSpec) : pentaho.context.IContext

Creates a child context of this one given its specification. Any unspecified information is inherited from this context.

toJSON() : pentaho.context.spec.IContext

Serializes this context to JSON.

toSpec() : pentaho.context.spec.IContext

Creates a specification with the information of this context.

Members Details

application: nonEmptyString

Gets the identifier of the client application.

Source: doc-js/pentaho/context/IContext.jsdoc, line 34

locale: nonEmptyString

Gets the identifier of the locale.

Source: doc-js/pentaho/context/IContext.jsdoc, line 70

reservedChars: nonEmptyString

Gets the reserved characters for file names, all concatenated in a single string.

Source: doc-js/pentaho/context/IContext.jsdoc, line 79

server: pentaho.context.IServer

Gets information about the server web application.

Source: doc-js/pentaho/context/IContext.jsdoc, line 52

theme: nonEmptyString

Gets the identifier of the theme.

Source: doc-js/pentaho/context/IContext.jsdoc, line 61

user: pentaho.context.IUser

Gets information about the user.

Source: doc-js/pentaho/context/IContext.jsdoc, line 43

Methods Details

createChild(childSpec) : pentaho.context.IContext

Creates a child context of this one given its specification. Any unspecified information is inherited from this context.

Source: doc-js/pentaho/context/IContext.jsdoc, line 88

Parameters:
Name Default Value Summary
childSpec : pentaho.context.spec.IContext
 
Optional

The child context specification.

Returns:
Name Description
pentaho.context.IContext

The child context.

toJSON() : pentaho.context.spec.IContext

Serializes this context to JSON.

This method is an alias of [toSpec]{pentaho.context.IContext#toSpec}.

Source: doc-js/pentaho/context/IContext.jsdoc, line 109

Returns:
Name Description
pentaho.context.spec.IContext

The context specification.

See also:  pentaho.context.IContext#toSpec

toSpec() : pentaho.context.spec.IContext

Creates a specification with the information of this context.

Source: doc-js/pentaho/context/IContext.jsdoc, line 99

Returns:
Name Description
pentaho.context.spec.IContext

The context specification.

See also:  pentaho.context.IContext#toJSON