Class ExternalTask

Hierarchy

ReloadTaskBase
- ExternalTask

Index

Constructors

Properties

Methods

addTriggerComposite addTriggerMany addTriggerSchema init remove removeAllTriggers start startSynchronous update waitExecution

Constructors

constructor

new ExternalTask(repoClient: QlikRepositoryClient, id: string, details?: IExternalProgramTask): ExternalTask
Parameters
- repoClient: QlikRepositoryClient
- id: string
- Optional details: IExternalProgramTask
Returns ExternalTask
Overrides ReloadTaskBase.constructor
- Defined in src/ExternalTask.ts:14

Properties

details

details: ITask | IExternalProgramTask

triggersDetails

triggersDetails: (IClassCompositeTrigger | IClassSchemaTrigger)[]

Methods

addTriggerComposite

addTriggerComposite(arg: ITaskCreateTriggerComposite): Promise<CompositeTrigger>
Add task trigger that depends on another task result (success of fail)
Parameters
- arg: ITaskCreateTriggerComposite
Returns Promise<CompositeTrigger>
Inherited from ReloadTaskBase.addTriggerComposite
- Defined in src/ReloadTaskBase.ts:122

addTriggerMany

addTriggerMany(triggers: (ITaskCreateTriggerComposite | ITaskCreateTriggerSchema)[]): Promise<(IClassCompositeTrigger | IClassSchemaTrigger)[]>
Add multiple task triggers in one go. Triggers can be of multiple types - composite and/or schema
Parameters
- triggers: (ITaskCreateTriggerComposite | ITaskCreateTriggerSchema)[]
Returns Promise<(IClassCompositeTrigger | IClassSchemaTrigger)[]>
Inherited from ReloadTaskBase.addTriggerMany
- Defined in src/ReloadTaskBase.ts:295

addTriggerSchema

addTriggerSchema(arg: ITaskCreateTriggerSchema): Promise<SchemaTrigger>
Add task trigger based on schema - daily, weekly, monthly, repeat every X etc.
Parameters
- arg: ITaskCreateTriggerSchema
Returns Promise<SchemaTrigger>
Inherited from ReloadTaskBase.addTriggerSchema
- Defined in src/ReloadTaskBase.ts:229

init

init(): Promise<void>
Returns Promise<void>
Inherited from ReloadTaskBase.init
- Defined in src/ReloadTaskBase.ts:59

remove

remove(): Promise<number>
Returns Promise<number>
Inherited from ReloadTaskBase.remove
- Defined in src/ReloadTaskBase.ts:69

removeAllTriggers

removeAllTriggers(arg?: {
onlyDisabled?: boolean;
onlyEnabled?: boolean;
}): Promise<IEntityRemove[]>
Parameters
- Optional arg: {
  onlyDisabled?: boolean;
  onlyEnabled?: boolean;
  }
  - Optional onlyDisabled?: boolean
  - Optional onlyEnabled?: boolean
Returns Promise<IEntityRemove[]>
Inherited from ReloadTaskBase.removeAllTriggers
- Defined in src/ReloadTaskBase.ts:322

start

start(): Promise<number>
Returns Promise<number>
Inherited from ReloadTaskBase.start
- Defined in src/ReloadTaskBase.ts:75

startSynchronous

startSynchronous(): Promise<IHttpReturn<unknown>>
Returns Promise<IHttpReturn<unknown>>
Inherited from ReloadTaskBase.startSynchronous
- Defined in src/ReloadTaskBase.ts:81

update

update(arg: ITaskExternalUpdate, options?: IUpdateObjectOptions): Promise<ITask>
Parameters
- arg: ITaskExternalUpdate
- Optional options: IUpdateObjectOptions
Returns Promise<ITask>
- Defined in src/ExternalTask.ts:22

waitExecution

waitExecution(arg?: {
executionId: string;
}): Promise<ITaskExecutionResult>
Parameters
- Optional arg: {
  executionId: string;
  }
  - executionId: string
Returns Promise<ITaskExecutionResult>
Inherited from ReloadTaskBase.waitExecution
- Defined in src/ReloadTaskBase.ts:88

Class ExternalTask

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

repoClient: QlikRepositoryClient

id: string

Optional details: IExternalProgramTask

Returns ExternalTask

Properties

details

triggersDetails

Methods

addTriggerComposite

Parameters

arg: ITaskCreateTriggerComposite

Returns Promise<CompositeTrigger>

addTriggerMany

Parameters

triggers: (ITaskCreateTriggerComposite | ITaskCreateTriggerSchema)[]

Returns Promise<(IClassCompositeTrigger | IClassSchemaTrigger)[]>

addTriggerSchema

Parameters

arg: ITaskCreateTriggerSchema

Returns Promise<SchemaTrigger>

init

Returns Promise<void>

remove

Returns Promise<number>

removeAllTriggers

Parameters

Optional arg: { onlyDisabled?: boolean; onlyEnabled?: boolean; }

Optional onlyDisabled?: boolean

Optional onlyEnabled?: boolean

Returns Promise<IEntityRemove[]>

start

Returns Promise<number>

startSynchronous

Returns Promise<IHttpReturn<unknown>>

update

Parameters

arg: ITaskExternalUpdate

Optional options: IUpdateObjectOptions

Returns Promise<ITask>

waitExecution

Parameters

Optional arg: { executionId: string; }

executionId: string

Returns Promise<ITaskExecutionResult>

Settings

Member Visibility

Theme

`Optional` details: IExternalProgramTask

`Optional` arg: {
onlyDisabled?: boolean;
onlyEnabled?: boolean;
}

`Optional` onlyDisabled?: boolean

`Optional` onlyEnabled?: boolean

`Optional` options: IUpdateObjectOptions

`Optional` arg: {
executionId: string;
}