Skip to main content Skip to complementary content

sessionApp method

Information noteSTABLE.

This API is reliable and breaking changes are unlikely.

qlik.sessionApp(config)

Creates a session app JavaScript object with app methods.

Version history

Version history
Version state Details
Introduced Qlik Sense June 2017

Parameters

config

Type: Object

Parameter updated in version 2.2.

Optional.

Additional configuration parameters:

Additional configuration parameters
Name Type Descr
host String

Optional.

Qlik host.

port

String or integer

Optional.

Port number.

prefix String

Optional.

Qlik virtual proxy. "/" if no proxy.

isSecure Boolean

Optional.

Use SSL.

identity String

Optional.

Unique identity for the session. If omitted, the session will be shared.

Returns

An app JavaScript object with app methods.

App API

Example

var sessionApp = qlik.sessionApp();
var config = {
  host: "myhost.com",
  prefix: "/",
  port: window.location.port,
  isSecure: true
};
var sessionApp = qlik.sessionApp(config);