Session

Constructor

new Session(params)

Description:

Constructor

Source:

simplicite.js, line 415

Parameters:

Name Type Description

params

object

Parameters

Properties

Name	Type	Attributes	Default	Description
`url`	string			Base URL of the Simplicite application
`scheme`	string			URL scheme (e.g. `'https'`) of the Simplicite application (not needed if `url` is set)
`host`	string			Hostname or IP address (e.g. `'myhost.mydomain.com'`) of the Simplicite application (not needed if `url` is set)
`port`	number			Port (e.g. `443`) of the Simplicite application (not needed if `url` is set)
`root`	string			Root context URL (e.g. `'/myapp'`) the Simplicite application (not needed if `url` is set)
`endpoint`	boolean	<optional>	`'api'`	Endpoint (`'api'\|'ui'\|'uipublic'`)
`username`	string	<optional>		Username (not needed for the public UI endpoint)
`password`	string	<optional>		Password (not needed for the public UI endpoint)
`authtoken`	string	<optional>		Authentication token (if set, username and password are not needed; not needed for the public UI endpoint)
`authheader`	string	<optional>		Authorization HTTP header name (defaults to the standard `Authorization`, the alternative is the value of the `SIMPLICITE_AUTH_HEADER` constant, not needed for public endpoint)
`ajaxkey`	string	<optional>		Ajax key (only usefull for usage from the generic UI)
`debug`	boolean	<optional>	`false`	Debug mode?
`debugHandler`	function	<optional>		Debug handler function
`infoHandler`	function	<optional>		Info handler function
`warningHandler`	function	<optional>		Warning handler function
`errorHandler`	function	<optional>		Error handler function
`logHandler`	function	<optional>		Log handler function

Members

constants

Description:

Constants

Source:

simplicite.js, line 425

Constants

Methods

changePassword(pwd, optsopt) → {promise.<object>}

Description:

Change password

Source:

simplicite.js, line 845

Parameters:

Name Type Attributes Description

pwd string Password

opts

object

Options

Properties

Name	Type	Attributes	Description
`error`	function	<optional>	Error handler function
`businessCase`	string	<optional>	Business case label

Returns:

A promise to the change password result

Type: promise.<object>

clear()

Description:

Clears all data (credentials, objects, ...)

Source:

simplicite.js, line 488

compressData(data) → {Promise.<Blob>}

Description:

Compress data as blob

Source:

simplicite.js, line 560

Parameters:

Name	Type	Description
`data`	string \| any	Data to compress

Returns:

Promise to the compressed data blob

Type: Promise.<Blob>

getAppInfo(optsopt) → {promise.<object>}

Description:

Get application info

Source:

simplicite.js, line 875

Parameters:

Name Type Attributes Description

opts

object

Options

Properties

Name	Type	Attributes	Description
`error`	function	<optional>	Error handler function
`businessCase`	string	<optional>	Business case label

Returns:

A promise to the application info (also avialable as the appinfo member)

Type: promise.<object>

getBasicAuthHeader() → {string}

Description:

Basic HTTP authorization header value

Source:

simplicite.js, line 505

Returns:

HTTP authorization header value

Type: string

getBearerTokenHeader() → {string}

Description:

Get bearer token header value

Source:

simplicite.js, line 515

Returns:

Bearer token header value

Type: string

getBusinessObject(name, instanceopt) → {BusinessObject}

Description:

Get business object

Source:

simplicite.js, line 1051

Parameters:

Name	Type	Attributes	Description
`name`	string		Business object name
`instance`	string	<optional>	Business object instance name, defaults to `js_<object name>`

Returns:

Business object

Type: BusinessObject

getBusinessObjectCacheKey(name, instanceopt) → {object}

Description:

Get business object cache key

Source:

simplicite.js, line 481

Parameters:

Name	Type	Attributes	Description
`name`	string		Business object name
`instance`	string	<optional>	Business object instance name, defaults to `js_<object name>`

Returns:

Business object cache key

Type: object

getDevInfo(moduleopt, optsopt) → {promise.<object>}

Description:

Get development info

Source:

simplicite.js, line 938

Parameters:

Name Type Attributes Description

module string <optional> Module name

opts

object

Options

Properties

Name	Type	Attributes	Description
`error`	function	<optional>	Error handler function
`businessCase`	string	<optional>	Business case label

Returns:

A promise to the develoment info (also avialable as the devinfo member)

Type: promise.<object>

getError(err, statusopt, originopt) → {object}

Description:

Get error object

Source:

simplicite.js, line 529

Parameters:

Name Type Attributes Description

err

string | object

Error

Properties

Name	Type	Description
`message`	string	Error message

status number <optional> Optional error status (defaults to 200)

origin string <optional> Optional error origin

Returns:

Error object

Type: object

getExternalObject(name)

Description:

Get an external object

Source:

simplicite.js, line 1065

Parameters:

Name	Type	Description
`name`	string	External object name

getGrant(optsopt) → {promise.<Grant>}

Description:

Get grant (current user data)

Source:

simplicite.js, line 800

Parameters:

Name Type Attributes Description

opts

object

Options

Properties

Name	Type	Attributes	Default	Description
`inlinePicture`	boolean	<optional>	`false`	Inline user picture?
`includeTexts`	boolean	<optional>	`false`	Include texts?
`includeSysparams`	boolean	<optional>	`false`	Include system parameters?
`error`	function	<optional>		Error handler function
`businessCase`	string	<optional>		Business case label

Returns:

A promise to the grant (also available as the grant member)

Type: promise.<Grant>

getHealth(optsopt) → {promise.<object>}

Description:

Get health check (no need to be authenticated)

Source:

simplicite.js, line 651

Parameters:

Name Type Attributes Description

opts

object

Options

Properties

Name	Type	Attributes	Default	Description
`full`	boolean	<optional>	`false`	Full health check?
`error`	function	<optional>		Error handler function

Returns:

Promise to the health data

Type: promise.<object>

getNews(optsopt) → {promise.<array>}

Description:

Get news

Source:

simplicite.js, line 974

Parameters:

Name Type Attributes Description

opts

object

Options

Properties

Name	Type	Attributes	Default	Description
`inlineImages`	boolean	<optional>	`false`	Inline news images?
`error`	function	<optional>		Error handler function
`businessCase`	string	<optional>		Business case label

Returns:

A promise to the list of news (also avialable as the news member)

Type: promise.<array>

getPath(action, optsopt)

Description:

Get path

Source:

simplicite.js, line 1212

Parameters:

Name Type Attributes Description

action string Action

opts

object

Options

Properties

Name	Type	Attributes	Description
`businessCase`	string	<optional>	Business case label

getResourceURL(code, typeopt, objectopt, objIdopt)

Description:

Get a resource URL

Source:

simplicite.js, line 1076

Parameters:

Name	Type	Attributes	Default	Description
`code`	string			Resource code
`type`	string	<optional>	`IMG`	Resource type (IMG=image (default), ICO=Icon, CSS=stylesheet, JS=Javascript, HTML=HTML)
`object`	string	<optional>		Object name (not required for global resources)
`objId`	string	<optional>		Object ID (not required for global resources)

getSysInfo(optsopt) → {promise.<object>}

Description:

Get system info

Source:

simplicite.js, line 906

Parameters:

Name Type Attributes Description

opts

object

Options

Properties

Name	Type	Attributes	Description
`error`	function	<optional>	Error handler function
`businessCase`	string	<optional>	Business case label

Returns:

A promise to the system info (also avialable as the sysinfo member)

Type: promise.<object>

health(optsopt) → {promise.<object>}

Description:

Alias to getHealth

Source:

simplicite.js, line 684

Parameters:

Name Type Attributes Description

opts

object

Options

Properties

Name	Type	Attributes	Default	Description
`full`	boolean	<optional>	`false`	Full health check?
`error`	function	<optional>		Error handler function

Returns:

Promise to the health data

Type: promise.<object>

indexSearch(query, objectopt, optsopt) → {promise.<array>}

Description:

Index search

Source:

simplicite.js, line 1015

Parameters:

Name Type Attributes Description

query string Index search query

object string <optional> Object

opts

object

Options

Properties

Name	Type	Attributes	Default	Description
`metadata`	boolean	<optional>	`false`	Add meta data for each result
`context`	number	<optional>		Context
`error`	function	<optional>		Error handler function
`businessCase`	string	<optional>		Business case label

Returns:

A promise to a list of index search records

Type: promise.<array>

isAuthTokenExpired() → {boolean}

Description:

Is the auth token expired?

Source:

simplicite.js, line 463

Returns:

true if the auth token is expired

Type: boolean

Description:

Source:

simplicite.js, line 695

Parameters:

Name Type Attributes Description

opts

object

Options

Properties

Name	Type	Attributes	Description
`username`	string	<optional>	Username (exclusive with authentication token)
`password`	string	<optional>	Password (required if username is set)
`authtoken`	string	<optional>	Authentication token ((exclusive with username)
`error`	function	<optional>	Error handler function

Returns:

Promise to the login result

Type: promise.<object>

logout(callback, optsopt) → {promise.<object>}

Description:

Logout

Source:

simplicite.js, line 760

Parameters:

Name Type Attributes Description

callback function Callback (called upon success)

opts

object

Options

Properties

Name	Type	Attributes	Description
`error`	function	<optional>	Error handler function

Returns:

Promise to the logout result

Type: promise.<object>

parseResponse(res, statusopt) → {object}

Description:

Parse response

Source:

simplicite.js, line 633

Parameters:

Name	Type	Attributes	Default	Description
`res`	object			Response to parse
`status`	number	<optional>	`200`	HTTP status

Returns:

Error object

Type: object

sendRequest(path, dataopt, callbackopt, errorHandleropt)

Description:

Send request

Source:

simplicite.js, line 584

Parameters:

Name	Type	Attributes	Description
`path`	string		Path
`data`	object	<optional>	Data
`callback`	function	<optional>	Callback
`errorHandler`	function	<optional>	Error handler

setAjaxKey(key)

Description:

Set Ajax key

Source:

simplicite.js, line 471

Parameters:

Name	Type	Description
`key`	string	Ajax key

setAuthToken(token)

Description:

Set auth token

Source:

simplicite.js, line 447

Parameters:

Name	Type	Description
`token`	string	Auth token

setAuthTokenExpiryDate(expiry)

Description:

Set auth token expiry date

Source:

simplicite.js, line 455

Parameters:

Name	Type	Description
`expiry`	Date	Auth token expiry

setPassword(pwd)

Description:

Set password

Source:

simplicite.js, line 439

Parameters:

Name	Type	Description
`pwd`	string	Password

setUsername(usr)

Description:

Set username

Source:

simplicite.js, line 431

Parameters:

Name	Type	Description
`usr`	string	Username

uncompressData(blob) → {Promise.<string>}

Description:

Uncompress blob

Source:

simplicite.js, line 572

Parameters:

Name	Type	Description
`blob`	Blob	Compressed data blob

Returns:

Promise to the uncompressed string

Type: Promise.<string>

Constructor

new Session(params)

Parameters:

Properties

Members

constants

Methods

changePassword(pwd, optsopt) → {promise.<object>}

Parameters:

Properties

Returns:

clear()

compressData(data) → {Promise.<Blob>}

Parameters:

Returns:

getAppInfo(optsopt) → {promise.<object>}

Parameters:

Properties

Returns:

getBasicAuthHeader() → {string}

Returns:

getBearerTokenHeader() → {string}

Returns:

getBusinessObject(name, instanceopt) → {BusinessObject}

Parameters:

Returns:

getBusinessObjectCacheKey(name, instanceopt) → {object}

Parameters:

Returns:

getDevInfo(moduleopt, optsopt) → {promise.<object>}

Parameters:

Properties

Returns:

getError(err, statusopt, originopt) → {object}

Parameters:

Properties

Returns:

getExternalObject(name)

Parameters:

getGrant(optsopt) → {promise.<Grant>}

Parameters:

Properties

Returns:

getHealth(optsopt) → {promise.<object>}

Parameters:

Properties

Returns:

getNews(optsopt) → {promise.<array>}

Parameters:

Properties

Returns:

getPath(action, optsopt)

Parameters:

Properties

getResourceURL(code, typeopt, objectopt, objIdopt)

Parameters:

getSysInfo(optsopt) → {promise.<object>}

Parameters:

Properties

Returns:

health(optsopt) → {promise.<object>}

Parameters:

Properties

Returns:

indexSearch(query, objectopt, optsopt) → {promise.<array>}

Parameters:

Properties

Returns:

isAuthTokenExpired() → {boolean}

Returns:

login(optsopt) → {promise.<object>}

Parameters:

Properties

Returns:

logout(callback, optsopt) → {promise.<object>}

Parameters:

Properties

Returns:

parseResponse(res, statusopt) → {object}