API Reference

Complete reference documentation for the Qlik TypeScript SDK.

Constructor

`new Qlik(config)`

Creates a new Qlik SDK instance with the specified configuration.

Parameters

config

QlikConfig

Required

Configuration object

Returns

Qlik

New Qlik instance

Example

typescript

const qlik = new Qlik({
  host: 'your-tenant.us.qlikcloud.com',
  webIntegrationId: 'your-web-integration-id'
});

Type Definition

typescript

interface QlikConfig {
  host: string;
  webIntegrationId?: string;
  port?: number;
  prefix?: string;
  secure?: boolean;
  identity?: string;
}

Authentication

`authenticateToQlik()`

Initiates authentication flow with Qlik environment.

Returns

Promise<void>

Throws

QlikAuthError

When authentication fails

Example

typescript

try {
  await qlik.authenticateToQlik();
  console.log('Authenticated successfully');
} catch (error) {
  console.error('Authentication failed:', error.message);
}

Apps & Spaces

`getAppList()`

Retrieves list of accessible applications.

Returns

Promise<QlikApp[]>

Array of app objects

Example

typescript

const apps = await qlik.getAppList();
apps.forEach(app => {
  console.log(`App: ${app.name} (ID: ${app.id})`);
});

Return Type

typescript

interface QlikApp {
  id: string;
  name: string;
  description?: string;
  published: boolean;
  publishTime?: string;
  owner: {
    id: string;
    name: string;
  };
}

Data Operations

`createSessionObject(definition)`

Creates a session object for data analysis and visualization.

Parameters

definition

ObjectDefinition

Required

Object definition with dimensions and measures

Example

typescript

const sessionObject = await app.createSessionObject({
  qInfo: { qType: 'my-chart' },
  qHyperCubeDef: {
    qDimensions: [
      { qDef: { qFieldDefs: ['Product'] } }
    ],
    qMeasures: [
      { qDef: { qDef: 'Sum(Sales)' } }
    ]
  }
});