Class App

Index

Constructors

constructor

new App(saasClient, id, details?): App
Parameters
- saasClient: QlikSaaSClient
- id: string
- Optional details: IItem
Returns App
- Defined in modules/App.ts:37

Properties

_actions

_actions: AppActions

Set of actions that are associated with the apps but are not part of the /apps API endpoints Such actions are:

reload - reloads an app. Originally part of /reloads endpoints
createReloadTask - create scheduled reload task. Originally part of /reload-tasks endpoints

details

details: IItem

evaluations

evaluations: AppEvaluations

reportFilters

reportFilters: AppReportFilters

Methods

addMedia

addMedia(arg): Promise<Media>
Parameters
- arg: {
  content: Buffer;
  fileName: string;
  }
  - content: Buffer
  - fileName: string
Returns Promise<Media>
- Defined in modules/App.ts:273

addToSpace

addToSpace(arg): Promise<number>
Parameters
- arg: {
  spaceId: string;
  }
  - spaceId: string
Returns Promise<number>
- Defined in modules/App.ts:199

copy

copy(arg): Promise<App>
Parameters
- arg: IAppCopy
Returns Promise<App>
- Defined in modules/App.ts:85

dataLineage

dataLineage(): Promise<IAppDataLineage[]>
Returns Promise<IAppDataLineage[]>
- Defined in modules/App.ts:93

export

export(arg?): Promise<{
    file: Buffer;
    id: string;
    name: string;
}>
Parameters
- Optional arg: {
  noData: boolean;
  }
  - noData: boolean
Returns Promise<{
    file: Buffer;
    id: string;
    name: string;
}>
- Defined in modules/App.ts:105

init

init(arg?): Promise<void>
Parameters
- Optional arg: {
  force: true;
  }
  - force: true
Returns Promise<void>
- Defined in modules/App.ts:61

mediaFiles

mediaFiles(): Promise<Media[]>
Returns Promise<Media[]>
- Defined in modules/App.ts:265

metaData

metaData(): Promise<IAppMetaData>
Returns Promise<IAppMetaData>
- Defined in modules/App.ts:99

publish

publish(arg): Promise<App>
IMPORTANT! This method to is to publish apps to MANAGED spaces only. For shared spaces please use addToSpace method
Parameters
- arg: IAppPublish
Returns Promise<App>
- Defined in modules/App.ts:132

rePublish

rePublish(arg): Promise<App>
IMPORTANT! This method to is to re-publish apps to MANAGED spaces only. For shared spaces please use addToSpace method
Parameters
- arg: IAppRePublish
Returns Promise<App>
- Defined in modules/App.ts:170

reloadLogContent

reloadLogContent(arg): Promise<string>
Returns the reload log content for the specified reloadId
Parameters
- arg: {
  reloadId: string;
  }
  - reloadId: string
Returns Promise<string>
- Defined in modules/App.ts:354

reloadLogs

reloadLogs(): Promise<IScriptLogMeta[]>
// * List of reload logs (actual log is not included) //

Returns Promise<IScriptLogMeta[]>
- Defined in modules/App.ts:345

remove

remove(): Promise<number>
Returns Promise<number>
- Defined in modules/App.ts:231

removeFromSpace

removeFromSpace(): Promise<number>
Returns Promise<number>
- Defined in modules/App.ts:217

scriptVersion

scriptVersion(arg): Promise<AppScript>
Get all details (including the script) for a specific script version

Rate limit: Tier 1 (600 requests per minute)
Parameters
- arg: {
  versionId: string;
  }
  - versionId: string
Returns Promise<AppScript>
- Defined in modules/App.ts:316

scriptVersions

scriptVersions(): Promise<AppScript[]>
// * List of all script versions // * // * To reduce the number of API calls the actual script content is initially left empty // * Call getScriptContent() for each version. // * // * Rate limit: Tier 1 (600 requests per minute) //

Returns Promise<AppScript[]>
- Defined in modules/App.ts:296

setScript

setScript(arg): Promise<number>
Set the app script and create new script version

Rate limit: Tier 2 (60 requests per minute)
Parameters
- arg: IScriptVersion
Returns Promise<number>
- Defined in modules/App.ts:336

thumbnail

thumbnail(): Promise<Buffer>
Returns Promise<Buffer>
- Defined in modules/App.ts:253

update

update(arg): Promise<number>
Parameters
- arg: IAppUpdate
Returns Promise<number>
- Defined in modules/App.ts:237