ScheduleApi | @inetsoft/api-client

ScheduleApi provides operations used to query, manage, and run schedule tasks.

Hierarchy

ScheduleApi

Index

Methods

Methods

addScheduleTask

addScheduleTask(name: string, enabled: boolean, conditions: ScheduleCondition[], actions: ScheduleAction[]): Promise<void>

- Defined in client/schedule/schedule-api.ts:328
Adds a schedule task.

Parameters
- name: string
  
  the name of the schedule task.
- enabled: boolean
  
  true to enable the task; false to disable the task.
- conditions: ScheduleCondition[]
  
  the list of conditions for the task.
- actions: ScheduleAction[]
  
  the list of actions performed by the task.
Returns Promise<void>

addTaskAction

addTaskAction(name: string, action: ScheduleAction): Promise<void>

- Defined in client/schedule/schedule-api.ts:414
Adds a action to a schedule task.

Parameters
- name: string
  
  the name of the task.
- action: ScheduleAction
  
  the action to add.
Returns Promise<void>

addTaskCondition

addTaskCondition(name: string, condition: ScheduleCondition): Promise<void>

- Defined in client/schedule/schedule-api.ts:370
Adds a condition to a schedule task.

Parameters
- name: string
  
  the name of the task.
- condition: ScheduleCondition
  
  the condition to add.
Returns Promise<void>

getScheduleTask

getScheduleTask(name: string): Promise<ScheduleTask>

- Defined in client/schedule/schedule-api.ts:338
Gets a schedule task.

Parameters
- name: string
  
  the name of the schedule task.
Returns Promise<ScheduleTask>

the schedule task.

getScheduleTasks

getScheduleTasks(): Promise<ScheduleTask[]>

- Defined in client/schedule/schedule-api.ts:318
Gets the list of scheduled tasks.

Returns Promise<ScheduleTask[]>

the list of tasks.

getTaskAction

getTaskAction(name: string, index: number): Promise<ScheduleAction>

- Defined in client/schedule/schedule-api.ts:424
Gets a action of a schedule task.

Parameters
- name: string
  
  the name of the schedule task.
- index: number
  
  the zero-based index of the action.
Returns Promise<ScheduleAction>

the requested action.

getTaskActions

getTaskActions(name: string): Promise<ScheduleAction[]>

- Defined in client/schedule/schedule-api.ts:406
Gets the list of actions defined for a task.

Parameters
- name: string
  
  the name of the task.
Returns Promise<ScheduleAction[]>

the list of actions.

getTaskCondition

getTaskCondition(name: string, index: number): Promise<ScheduleCondition>

- Defined in client/schedule/schedule-api.ts:380
Gets a condition of a schedule task.

Parameters
- name: string
  
  the name of the schedule task.
- index: number
  
  the zero-based index of the condition.
Returns Promise<ScheduleCondition>

the requested condition.

getTaskConditions

getTaskConditions(name: string): Promise<ScheduleCondition[]>

- Defined in client/schedule/schedule-api.ts:362
Gets the list of conditions defined for a task.

Parameters
- name: string
  
  the name of the task.
Returns Promise<ScheduleCondition[]>

the list of conditions.

getTaskStatus

getTaskStatus(name: string): Promise<ScheduleTaskStatus>

- Defined in client/schedule/schedule-api.ts:450
Gets the current status of a task.

Parameters
- name: string
  
  the name of the schedule task.
Returns Promise<ScheduleTaskStatus>

the status of the task.

removeScheduleTask

removeScheduleTask(name: string): Promise<void>

- Defined in client/schedule/schedule-api.ts:353
Removes a schedule task.

Parameters
- name: string
  
  the name of the schedule task.
Returns Promise<void>

removeTaskAction

removeTaskAction(name: string, index: number): Promise<void>

- Defined in client/schedule/schedule-api.ts:441
Removes a action of a schedule task.

Parameters
- name: string
  
  the name of the schedule task.
- index: number
  
  the zero-based index of the action.
Returns Promise<void>

removeTaskCondition

removeTaskCondition(name: string, index: number): Promise<void>

- Defined in client/schedule/schedule-api.ts:397
Removes a condition of a schedule task.

Parameters
- name: string
  
  The name of the schedule task.
- index: number
  
  The zero-based index of the condition.
Returns Promise<void>

runTask

runTask(name: string): Promise<void>

- Defined in client/schedule/schedule-api.ts:458
Runs a schedule task immediately. The status of the task should be polled to determine when and how it finishes.

Parameters
- name: string
  
  the name of the task.
Returns Promise<void>

updateScheduleTask

updateScheduleTask(name: string, task: ScheduleTask): Promise<void>

- Defined in client/schedule/schedule-api.ts:346
Updates a schedule task.

Parameters
- name: string
  
  the name of the schedule task.
- task: ScheduleTask
  
  the updated schedule task object.
Returns Promise<void>

updateTaskAction

updateTaskAction(name: string, index: number, action: ScheduleAction): Promise<void>

- Defined in client/schedule/schedule-api.ts:433
Updates a action of a schedule task.

Parameters
- name: string
  
  the name of the schedule task.
- index: number
  
  the zero-based index of the action.
- action: ScheduleAction
  
  the updated action.
Returns Promise<void>

updateTaskCondition

updateTaskCondition(name: string, index: number, condition: ScheduleCondition): Promise<void>

- Defined in client/schedule/schedule-api.ts:389
Updates a condition of a schedule task.

Parameters
- name: string
  
  the name of the schedule task.
- index: number
  
  the zero-based index of the condition.
- condition: ScheduleCondition
  
  the updated condition.
Returns Promise<void>

Generated using TypeDoc