getGlobal method

Note: STABLE.
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

Introduced 1.1

Parameters

Name Type Description
config Object

Additional configuration parameters.

Parameters:

Name Type Description
host String

Optional.

Qlik Sense host.

port String

Optional.

Port number

prefix String

Optional.

Qlik Sense virtual proxy.

/ if no virtual proxy

isSecure Boolean

Optional.

Use SSL

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 information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?