Class Apps

Hierarchy

Apps

Implements

IClassApps

Index

Constructors

constructor

Methods

exportMany get getAll getFilter removeFilter select upload uploadAndReplace uploadMany

Constructors

constructor

new Apps(mainRepoClient, mainGenericClient, mainGenericClientWithPort?): Apps
Parameters
- mainRepoClient: QlikRepositoryClient
- mainGenericClient: QlikGenericRestClient
- Optional mainGenericClientWithPort: QlikGenericRestClient
Returns Apps
- Defined in src/Apps.ts:84

Methods

exportMany

exportMany(arg): Promise<{
    exportToken: string;
    file: IncomingMessage;
    id: string;
    name: string;
}[]>
Export multiple qvf to Buffer
Parameters
- arg: {
  filter: string;
  skipData?: boolean;
  }
  - filter: string
  - Optional skipData?: boolean
Returns Promise<{
    exportToken: string;
    file: IncomingMessage;
    id: string;
    name: string;
}[]>
Implementation of IClassApps.exportMany
- Defined in src/Apps.ts:151

get

get(arg): Promise<App>
Get single app instance
Parameters
- arg: {
  id: string;
  }
  - id: string
Returns Promise<App>
Implementation of IClassApps.get
- Defined in src/Apps.ts:94

getAll

getAll(): Promise<App[]>
Get all available apps instance for a user

Returns Promise<App[]>
Implementation of IClassApps.getAll
- Defined in src/Apps.ts:108

getFilter

getFilter(arg): Promise<App[]>
Get array of apps instance based on the supplied filter
Parameters
- arg: {
  filter: string;
  orderBy?: string;
  }
  - filter: string
  - Optional orderBy?: string
Returns Promise<App[]>
Implementation of IClassApps.getFilter
- Defined in src/Apps.ts:126

removeFilter

removeFilter(arg): Promise<IEntityRemove[]>
Remove apps based on the supplied filter
Parameters
- arg: {
  filter: string;
  }
  - filter: string
Returns Promise<IEntityRemove[]>
Implementation of IClassApps.removeFilter
- Defined in src/Apps.ts:258

select

select(arg?): Promise<ISelection>
Create selection based on the supplied filter
Parameters
- Optional arg: {
  filter: string;
  }
  - filter: string
Returns Promise<ISelection>
Implementation of IClassApps.select
- Defined in src/Apps.ts:270

upload

upload(arg): Promise<App>
Upload an qvf
Parameters
- arg: IAppUpload
Returns Promise<App>
Implementation of IClassApps.upload
- Defined in src/Apps.ts:162

uploadAndReplace

uploadAndReplace(arg): Promise<App>
EXPERIMENTAL

Upload an qvf and replace an existing app with it
Parameters
- arg: IAppUploadAndReplace
Returns Promise<App>
Implementation of IClassApps.uploadAndReplace
- Defined in src/Apps.ts:219

uploadMany

uploadMany(arg): Promise<App[]>
Upload multiple apps in a single method
Parameters
- arg: {
      apps: [{
          excludeDataConnections?: boolean;
          file: Buffer;
          keepData?: boolean;
          name: string;
      }];
      sequence?: Boolean;
  }
  - apps: [{
        excludeDataConnections?: boolean;
        file: Buffer;
        keepData?: boolean;
        name: string;
    }]
  - Optional sequence?: Boolean
Returns Promise<App[]>
Implementation of IClassApps.uploadMany
- Defined in src/Apps.ts:201

Class Apps

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

mainRepoClient: QlikRepositoryClient

mainGenericClient: QlikGenericRestClient

Optional mainGenericClientWithPort: QlikGenericRestClient

Returns Apps

Methods

exportMany

Parameters

arg: { filter: string; skipData?: boolean; }

filter: string

Optional skipData?: boolean

Returns Promise<{ exportToken: string; file: IncomingMessage; id: string; name: string; }[]>

get

Parameters

arg: { id: string; }

id: string

Returns Promise<App>

getAll

Returns Promise<App[]>

getFilter

Parameters

arg: { filter: string; orderBy?: string; }

filter: string

Optional orderBy?: string

Returns Promise<App[]>

removeFilter

Parameters

arg: { filter: string; }

filter: string

Returns Promise<IEntityRemove[]>

select

Parameters

Optional arg: { filter: string; }

filter: string

Returns Promise<ISelection>

upload

Parameters

arg: IAppUpload

Returns Promise<App>

uploadAndReplace

Parameters

arg: IAppUploadAndReplace

Returns Promise<App>

uploadMany

Parameters

arg: { apps: [{ excludeDataConnections?: boolean; file: Buffer; keepData?: boolean; name: string; }]; sequence?: Boolean; }

apps: [{ excludeDataConnections?: boolean; file: Buffer; keepData?: boolean; name: string; }]

Optional sequence?: Boolean

Returns Promise<App[]>

Settings

Member Visibility

Theme

On This Page

`Optional` mainGenericClientWithPort: QlikGenericRestClient

arg: {
filter: string;
skipData?: boolean;
}

`Optional` skipData?: boolean

Returns Promise<{
exportToken: string;
file: IncomingMessage;
id: string;
name: string;
}[]>

arg: {
id: string;
}

arg: {
filter: string;
orderBy?: string;
}

`Optional` orderBy?: string

arg: {
filter: string;
}

`Optional` arg: {
filter: string;
}

arg: {
apps: [{
excludeDataConnections?: boolean;
file: Buffer;
keepData?: boolean;
name: string;
}];
sequence?: Boolean;
}

apps: [{
excludeDataConnections?: boolean;
file: Buffer;
keepData?: boolean;
name: string;
}]

`Optional` sequence?: Boolean