Class Request

constructor

• new Request(mainRestClient, id, details?): Request

• Parameters

  • mainRestClient: QlikGenericRestClient

  • id: string

  • Optional details: RequestStateFull

  Returns Request

details

deleteGeneratedApp

• deleteGeneratedApp(): Promise<number>

• Delete the app generated by the request

  Deletes the generated app.

  Returns Promise<number>

init

• init(): Promise<void>

• Returns Promise<void>

reloadApp

• reloadApp(arg): Promise<number>

• Reloads the app generated by the request

  Reloads the generated app.

  Parameters

  • arg: ReloadAppPayload

  Returns Promise<number>

renameApp

• renameApp(arg): Promise<number>

• Rename the app generated by the request

  Rename the generated app.

  Parameters

  • arg: {
        appName: string;
    }

    • appName: string

      The new name of the generated app.

  Returns Promise<number>

update

• update(arg): Promise<RequestStateFull>

• Perform some action on a request.

  This method is used to perform actions on requests such as pausing, resuming and canceling them. A 'single' or 'singlesub' request can be paused if it has not yet reached the data 'loading' phase. Cancel and pause actions can be performed on a 'multiple' app generation request that has at least one singlesub request that has not reached the 'loading' phase in which case the 'cancel' or 'pause' action applies to just that subset of sub-requests. The ODAG service will return an error if a request completes before a pause or cancel command is sent or acted upon.

  Parameters

  • arg: RequestModifyPayload

  Returns Promise<RequestStateFull>