Mashup API reference

The Mashup API is used when you want to display Qlik Sense objects on your website. It allows you to get objects, add buttons, create bookmarks and interact with fields. For this a number of interfaces with related methods are available.

The qlik interface is the external interface to Qlik Sense. The qlik.app interface is the external interface to the Qlik Sense app and it contains methods for app level commands. The qlik.app.bookmark interface is the external interface to bookmarks in a Qlik Sense app. The qlik.app.field interface is the external interface to the fields in a Qlik Sense app and contain methods for field level commands. The qlik.app.variable interface is the external interface to Qlik Sense variables.

Version handling

 

Qlik Sense 2.0

New methods

• setLanguage method
• global.getProductVersion method

Deprecated methods

• global.getQvVersion method. Replaced with global.getProductVersion method.

Qlik Sense 1.1

New methods

• callRepository method
• getExtensionList method
• getGlobal method
• app.addAlternateState method
• app.close method
• app.destroySessionObject method
• app.doReload method
• app.doSave method
• app.getAppLayout method
• app.getFullPropertyTree method
• app.getSnapshot method
• app.removeAlternateState method
• app.searchAssociations method
• app.searchSuggest method
• app.selectAssociations method
• global.cancelReload method
• global.getAppList method
• global.getAuthenticatedUser method
• global.getProgress method
• global.getQTProduct method
• global.getQvVersion method
• global.isPersonalMode method

Updated methods

• currApp method
• openApp method
• app.getList method
• app.getObject method
• app.field.selectValues method

Qlik Sense 1.0

New methods

• currApp method
• getAppList method
• openApp method
• resize method
• setOnError method
• app.back method
• app.clearAll method
• app.createCube method
• app.createGenericObject method
• app.createList method
• app.field method
• app.forward method
• app.getAppObjectList method
• app.getList method
• app.getObject method
• app.getObjectProperties method
• app.lockAll method
• app.unlockAll method
• app.bookmark.apply method
• app.bookmark.create method
• app.bookmark.remove method
• app.field.clear method
• app.field.clearOther method
• app.field.lock method
• app.field.select method
• app.field.selectAll method
• app.field.selectAlternative method
• app.field.selectExcluded method
• app.field.selectMatch method
• app.field.selectPossible method
• app.field.selectValues method
• app.field.toggleSelect method
• app.field.unlock method
• app.variable.create method
• app.variable.getContent method
• app.variable.setContent method