qlik-saas-api/dist/modules/App.d.ts

Interact with Qlik Sense SaaS REST API

/// <reference types="node" />
/// <reference types="node" />
import { QlikSaaSClient } from "qlik-rest-api";
import { IAppCopy, IAppPublish, IAppRePublish, IAppUpdate, IScriptVersion } from "./Apps.interfaces";
import { Media } from "./AppMedia";
import { AppEvaluations } from "./AppEvaluations";
import { AppActions } from "./AppActions";
import { AppScript } from "./AppScript";
import { IItem } from "./Item";
import { AppReportFilters } from "./AppReportFilters";
export declare class App {
    #private;
    private swapResourceIdAndId;
    evaluations: AppEvaluations;
    reportFilters: AppReportFilters;
    /**
     * 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
     */
    _actions: AppActions;
    details: IItem;
    constructor(saasClient: QlikSaaSClient, id: string, details?: IItem);
    init(arg?: {
        force: true;
    }): Promise<void>;
    copy(arg: IAppCopy): Promise<App>;
    dataLineage(): Promise<any>;
    metaData(): Promise<any>;
    export(arg?: {
        noData: boolean;
    }): Promise<{
        file: Buffer;
        id: string;
        name: string;
    }>;
    /**
     * IMPORTANT! This method to is to publish apps to **MANAGED** spaces only.
     * For shared spaces please use `addToSpace` method
     */
    publish(arg: IAppPublish): Promise<App>;
    /**
     * IMPORTANT! This method to is to re-publish apps to **MANAGED** spaces only.
     * For shared spaces please use `addToSpace` method
     */
    rePublish(arg: IAppRePublish): Promise<App>;
    addToSpace(arg: {
        spaceId: string;
    }): Promise<number>;
    removeFromSpace(): Promise<number>;
    remove(): Promise<number>;
    update(arg: IAppUpdate): Promise<number>;
    thumbnail(): Promise<any>;
    mediaFiles(): Promise<any>;
    addMedia(arg: {
        content: Buffer;
        fileName: string;
    }): Promise<Media>;
    /**
    //  * 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)
    //  */
    scriptVersions(): Promise<any>;
    /**
     * Get all details (including the script) for a specific script version
     *
     * Rate limit: Tier 1 (600 requests per minute)
     */
    scriptVersion(arg: {
        versionId: string;
    }): Promise<AppScript>;
    /**
     * Set the app script and create new script version
     *
     * Rate limit: Tier 2 (60 requests per minute)
     */
    setScript(arg: IScriptVersion): Promise<number>;
    /**
    //  * List of reload logs (actual log is not included)
    //  */
    reloadLogs(): Promise<any>;
    /**
     * Returns the reload log content for the specified reloadId
     */
    reloadLogContent(arg: {
        reloadId: string;
    }): Promise<any>;
}