Class ContentLibrary

Hierarchy

ContentLibrary

Implements

IClassContentLibrary

Index

Constructors

Properties

Methods

export exportMany importFile importFileMany init remove removeFile removeFileMany update

Constructors

constructor

new ContentLibrary(repoClient: QlikRepositoryClient, id: string, details?: IContentLibrary, genericClient?: QlikGenericRestClient): ContentLibrary
Parameters
- repoClient: QlikRepositoryClient
- id: string
- Optional details: IContentLibrary
- Optional genericClient: QlikGenericRestClient
Returns ContentLibrary
- Defined in src/ContentLibrary.ts:48

Properties

details

details: IContentLibrary

Methods

export

export(arg: {
    sourceFileName: string;
}): Promise<{
    file: Buffer;
    name: string;
    path: string;
}>
Parameters
- arg: {
  sourceFileName: string;
  }
  - sourceFileName: string
Returns Promise<{
    file: Buffer;
    name: string;
    path: string;
}>
Implementation of IClassContentLibrary.export
- Defined in src/ContentLibrary.ts:70

exportMany

exportMany(arg?: {
    sourceFileNames: string[];
}): Promise<{
    file: Buffer;
    name: string;
    path: string;
}[]>
Parameters
- Optional arg: {
  sourceFileNames: string[];
  }
  - sourceFileNames: string[]
Returns Promise<{
    file: Buffer;
    name: string;
    path: string;
}[]>
Implementation of IClassContentLibrary.exportMany
- Defined in src/ContentLibrary.ts:111

importFile

importFile(arg: IContentLibraryImport): Promise<{
fileDetails: IStaticContentReferenceCondensed;
status: number;
}>
Parameters
- arg: IContentLibraryImport
Returns Promise<{
fileDetails: IStaticContentReferenceCondensed;
status: number;
}>
Implementation of IClassContentLibrary.importFile
- Defined in src/ContentLibrary.ts:136

importFileMany

importFileMany(arg: IContentLibraryImport[]): Promise<{
fileDetails: IStaticContentReferenceCondensed;
status: number;
}[]>
Parameters
- arg: IContentLibraryImport[]
Returns Promise<{
fileDetails: IStaticContentReferenceCondensed;
status: number;
}[]>
Implementation of IClassContentLibrary.importFileMany
- Defined in src/ContentLibrary.ts:172

init

init(): Promise<void>
Returns Promise<void>
- Defined in src/ContentLibrary.ts:62

remove

remove(): Promise<number>
Returns Promise<number>
Implementation of IClassContentLibrary.remove
- Defined in src/ContentLibrary.ts:207

removeFile

removeFile(arg: {
externalPath: string;
}): Promise<number>
Parameters
- arg: {
  externalPath: string;
  }
  - externalPath: string
Returns Promise<number>
Implementation of IClassContentLibrary.removeFile
- Defined in src/ContentLibrary.ts:180

removeFileMany

removeFileMany(arg: string[]): Promise<{
externalPath: string;
status: number;
}[]>
Parameters
- arg: string[]
Returns Promise<{
externalPath: string;
status: number;
}[]>
Implementation of IClassContentLibrary.removeFileMany
- Defined in src/ContentLibrary.ts:196

update

update(arg: IContentLibraryUpdate, options?: IUpdateObjectOptions): Promise<IContentLibrary>
Parameters
- arg: IContentLibraryUpdate
- Optional options: IUpdateObjectOptions
Returns Promise<IContentLibrary>
Implementation of IClassContentLibrary.update
- Defined in src/ContentLibrary.ts:213