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

Interact with Qlik Sense SaaS REST API

/// <reference types="node" />
/// <reference types="node" />
import { QlikSaaSClient } from "qlik-rest-api";
import { Extension } from "./Extension";
export interface IExtensionImportData {
    /**
     * The display name of this extension.
     */
    name: string;
    /**
     * The type of this extension (visualization, etc.).
     */
    type: string;
    /**
     * Icon to show in the client.
     */
    icon?: string;
    /**
     * List of tags.
     */
    tags?: string[];
    /**
     * Author of the extension.
     */
    author?: string;
    /**
     * Object containing meta data regarding the bundle the extension belongs to.
     * If it does not belong to a bundle, this object is not defined.
     */
    bundle?: {
        /**
         * Unique identifier of the bundle.
         */
        id: string;
        /**
         * Name of the bundle.
         */
        name: string;
        /**
         * Description of the bundle.
         */
        description?: string;
    };
    userId?: string;
    /**
     * If the extension is part of an extension bundle.
     */
    bundled?: boolean;
    /**
     * Under which license this extension is published.
     */
    license?: string;
    /**
     * An image that enables users to preview the extension.
     */
    preview?: string;
    /**
     * Version of the extension.
     */
    version?: string;
    /**
     * Checksum of the extension contents.
     */
    checksum?: string;
    /**
     * Home page of the extension.
     */
    homepage?: string;
    /**
     * Keywords for the extension.
     */
    keywords?: string;
    /**
     * Relative path to the extension's entry file, defaults to filename from the qext file.
     */
    loadpath?: string;
    /**
     * Supplier of the extension.
     */
    supplier?: string;
    tenantId?: string;
    /**
     * If the extension is a supernova extension or not.
     */
    supernova?: boolean;
    /**
     * A date noting when the extension was deprecated.
     */
    deprecated?: string;
    /**
     * Link to the extension source code.
     */
    repository?: string;
    /**
     * Description of the extension.
     */
    description?: string;
    /**
     * The version from the qext file that was uploaded with this extension.
     */
    qextVersion?: string;
    /**
     * Map of dependencies describing version of the component it requires.
     */
    dependencies?: {};
    /**
     * The name of the qext file that was uploaded with this extension.
     */
    qextFilename?: string;
}
export declare class Extensions {
    #private;
    constructor(saasClient: QlikSaaSClient);
    get(arg: {
        id: string;
    }): Promise<Extension>;
    getAll(): Promise<any>;
    getFilter(arg: {
        filter: string;
    }): Promise<Extension[]>;
    removeFilter(arg: {
        filter: string;
    }): Promise<{
        id: string;
        status: number;
    }[]>;
    import(arg: {
        file: string | Buffer;
        data: IExtensionImportData;
    }): Promise<Extension>;
}