getAppList method

STABLE.
This API is reliable and breaking changes are unlikely.

qlik.getAppList(callback, config)

Gets a list of Qlik Sense apps that you potentially can connect to and registers a callback to receive the data.

The getAppList method opens a WebSocket, gets the app list, and then closes the WebSocket.

Version history

Introduced 1.0
Updated 1.1

Parameters

Name Type Description
callback Function Callback method.
config Object

Optional.

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.

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.

Example

var config = {
		host: "myhost.com",
		prefix: "/",
		port: window.location.port,
		isSecure: true
	};
	qlik.getAppList(function(list){
		var str = "";
		list.forEach(function(value) {
			str +=  value.qDocName + '('+ value.qDocId +') ';
		});
		alert(str);
	}, config);
See Loading external and internal modules for more example of use.

See also: 

Did this information help you?

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

Thanks for helping us improve!