Class Extension

constructor

• new Extension(saasClient, id, details?): Extension

• Parameters

  • saasClient: QlikSaaSClient

  • id: string

  • Optional details: IExtension

  Returns Extension

details

download

• download(): Promise<{
      file: string;
      id: string;
      name: string;
  }>

• Returns Promise<{
      file: string;
      id: string;
      name: string;
  }>

file

• file(arg): Promise<string>

• Parameters

  • arg: {
        fileName: string;
    }

    • fileName: string

  Returns Promise<string>

init

• init(arg?): Promise<void>

• Parameters

  • Optional arg: {
        force: boolean;
    }

    • force: boolean

  Returns Promise<void>

remove

• remove(): Promise<number>

• Returns Promise<number>

update

• update(arg): Promise<number>

• WARNING!

  At this point (2023-08-29) not all "data" properties can be updated. Qlik will reply with status 200 ("OK. Extension has been updated.") but the extension is not updated. For example: if we pass new value for "name" property the update request will be ok but the extension name is not updated in Qlik.

  Although the documentation states that all properties can be passed that is not reflecting the reality. From my experience the only things that can be updates at the moment are the "file" and "data.tags"

  This method will anyway accept all "data" properties and when one day Qlik enable all properties on their end then this method will not require any updating

  Parameters

  • arg: {
        data: Partial<IExtensionImportData>;
        file: string | Buffer;
    } | {
        data: Partial<IExtensionImportData>;
        file?: undefined;
    } | {
        data?: undefined;
        file: string | Buffer;
    }

  Returns Promise<number>