Class DataAlerts

Index

Constructors

Methods

create get getAll getFilter getSettings getTaskIdExecutionIdEvaluation getTaskIdExecutions getTaskIdExecutionsStats getTaskIdStats removeFilter triggerAction updateSettings validateActions

Constructors

constructor

new DataAlerts(saasClient): DataAlerts
Parameters
- saasClient: QlikSaaSClient
Returns DataAlerts
- Defined in modules/DataAlerts.ts:63

Methods

create

create(arg): Promise<DataAlert>
Parameters
- arg: IDataAlertCreate
Returns Promise<DataAlert>
- Defined in modules/DataAlerts.ts:116

get

get(arg): Promise<DataAlert>
Parameters
- arg: {
  id: string;
  }
  - id: string
Returns Promise<DataAlert>
- Defined in modules/DataAlerts.ts:67

getAll

getAll(): Promise<DataAlert[]>
Returns Promise<DataAlert[]>
- Defined in modules/DataAlerts.ts:78

getFilter

getFilter(arg): Promise<DataAlert[]>
Parameters
- arg: {
  filter: string;
  }
  - filter: string
Returns Promise<DataAlert[]>
- Defined in modules/DataAlerts.ts:87

getSettings

getSettings(): Promise<IDataAlertSettings>
Returns Promise<IDataAlertSettings>
- Defined in modules/DataAlerts.ts:135

getTaskIdExecutionIdEvaluation

getTaskIdExecutionIdEvaluation(arg): Promise<IDataAlertEvaluationGetResponse>
Parameters
- arg: {
  executionId: string;
  taskId: string;
  }
  - executionId: string
  - taskId: string
Returns Promise<IDataAlertEvaluationGetResponse>
- Defined in modules/DataAlerts.ts:222

getTaskIdExecutions

getTaskIdExecutions(arg): Promise<IDataAlertExecutionStatsAggregatedResponse>
Parameters
- arg: {
  filter?: IGetTaskExecutionsFilter;
  taskId: string;
  }
  - Optional filter?: IGetTaskExecutionsFilter
  - taskId: string
Returns Promise<IDataAlertExecutionStatsAggregatedResponse>
- Defined in modules/DataAlerts.ts:167

getTaskIdExecutionsStats

getTaskIdExecutionsStats(arg): Promise<IDataAlertTaskExecutionStatsResponse>
Parameters
- arg: {
  period: string;
  taskId: string;
  }
  - period: string
  - taskId: string
Returns Promise<IDataAlertTaskExecutionStatsResponse>
- Defined in modules/DataAlerts.ts:204

getTaskIdStats

getTaskIdStats(arg): Promise<IDataAlertExecutionStatsAggregatedResponse>
Parameters
- arg: {
  taskId: string;
  }
  - taskId: string
Returns Promise<IDataAlertExecutionStatsAggregatedResponse>
- Defined in modules/DataAlerts.ts:154

removeFilter

removeFilter(arg): Promise<{
id: string;
status: number;
}[]>
Parameters
- arg: {
  filter: string;
  }
  - filter: string
Returns Promise<{
id: string;
status: number;
}[]>
- Defined in modules/DataAlerts.ts:101

triggerAction

triggerAction(arg): Promise<IDataAlertTriggerActionResponse>
Parameters
- arg: {
  alertingTaskId: string;
  }
  - alertingTaskId: string
Returns Promise<IDataAlertTriggerActionResponse>
- Defined in modules/DataAlerts.ts:122

updateSettings

updateSettings(arg): Promise<number>
Parameters
- arg: {
  enableDataAlerting: boolean;
  }
  - enableDataAlerting: boolean
Returns Promise<number>
- Defined in modules/DataAlerts.ts:141

validateActions

validateActions(arg): Promise<IDataAlertValidateActionsResponse>
Parameters
- arg: IDataAlertCreate
Returns Promise<IDataAlertValidateActionsResponse>
- Defined in modules/DataAlerts.ts:243