Skip to main content Skip to complementary content

getGlobal method

Information noteSTABLE.

This API is reliable and breaking changes are unlikely.

qlik.getGlobal(config)

Opens a WebSocekt connection to the Qlik associative engine for global methods.

Version history

Version history
Version state Details
Introduced 1.1

Parameters

config

Type: Object

Optional.

Additional configuration parameters:

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.

openWithoutData Boolean

Optional.

Open app without loading data.

Introduced in version 1.1.

identity String

Optional.

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

Returns

A global JavaScript object with global methods.

Global API

Example

var config = {
	host: "myhost.com",
	prefix: "/",
	port: window.location.port,
	isSecure: true
};
var global = qlik.getGlobal(config);
global.getAuthenticatedUser(function(reply){
	alert('User:'+reply.qReturn);
});

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!