Options
All
  • Public
  • Public/Protected
  • All
Menu

Module taskplan

Index

Functions

activateTask

  • activateTask(taskName: string): void
  • 将一个任务设置成激活状态。 注意: 只允许激活周期性的定时任务

    在开启安全配置情况下,需要 '管理定时任务' 权限

    activate a task, set the task status to Active. Notice: only activate multi-time task is allowed

    example
    import * as tp from 'taskplan'
    tp.activateTask("task_name")
    

    Parameters

    • taskName: string

    Returns void

createMultiTimeTask

  • 创建一个周期性定时任务,新建的任务模式是处于激活状态

    在开启安全配置情况下,需要 '管理定时任务' 权限

    example
    import * as tp from 'taskplan'
    let id = tp.createMultiTimeTask({
      name: "taskName",
      assetName: "scriptName",
      firstScheduleDate: "2019-09-10 00:00:00",
      scheduleInterval: 1,
      intervalUnit: tp.IntervalUnit.Minute,
      taskType: tp.TaskType.Script,
      inputs: {
          foo: {
              bar: "xxxxxx"
          }
      }
    })
    
    

    Parameters

    Returns string

    id of new created task plan

createOneTimeTask

  • 创建一个只执行一次的定时任务,新建的任务模式是处于激活状态

    在开启安全配置情况下,需要 '管理定时任务' 权限

    create new task plan which only executes once, created task plan is activated by default

    example
    import * as tp from 'taskplan'
    let id = tp.createOneTimeTask({
      name: "taskName",
      assetName: "scriptName",
      firstScheduleDate: "2019-09-10 00:00:00",
      taskType: tp.TaskType.Script,
      inputs: {
          foo: {
              bar: "xxxxxx"
          }
      }
    })
    
    

    Parameters

    Returns string

    id of new created task plan

deactivateTask

  • deactivateTask(taskName: string): void
  • 将一个任务置成非状态。 注意:只允许冻结周期性的定时任务

    在开启安全配置情况下,需要 '管理定时任务' 权限

    deactivate a task, set the task status to Suspend. Notice: only deactivate multi-time task is allowed

    example
    import * as tp from 'taskplan'
    tp.deactivateTask("task_name")
    

    Parameters

    • taskName: string

    Returns void

deleteTask

  • deleteTask(taskName: string): void
  • 删除一个定时任务, 激活状态下的任务也是允许删除的。

    在开启安全配置情况下,需要 '管理定时任务' 权限

    example
    import * as tp from 'taskplan'
    tp.deleteTask("task_name")
    

    Parameters

    • taskName: string

    Returns void

updateTaskInputs

  • updateTaskInputs(taskName: string, inputs: Dict): void
  • 更新任务的输入,如果没有输入,则传入一个空的 map

    在开启安全配置情况下,需要 '管理定时任务' 权限

    example
    import * as tp from 'taskplan'
    tp.updateTaskInputs("task_name", {
        foo: "apple",
        bar: 123,
    })
    

    Parameters

    • taskName: string
    • inputs: Dict

      the inputs for corresponding flow or script

    Returns void