Class TaskContext<T>

constructor

• new TaskContext<T extends TaskType>(
      taskId: string,
      taskType: T,
      data: TaskData<T>,
  ): TaskContext<T>

  Type Parameters

  • T extends TaskType

  Parameters

  • taskId: string
  • taskType: T
  • data: TaskData<T>

  Returns TaskContext<T>

data

noteDeletionHandlerTriggered

increaseProgressCount

• increaseProgressCount(): void

  Returns void

reportError

• reportError(message: string): void

  Parameters

  • message: string

  Returns void

setTotalCount

• setTotalCount(totalCount: number): void

  Sets the total expected units of work, so progress messages can carry a denominator and the client can show a progress bar instead of a bare count. Optional — tasks that don't know their total up front simply never call this.

  Parameters

  • totalCount: number

  Returns void

taskSucceeded

• taskSucceeded(result: TaskResult<T>): void

  Parameters

  • result: TaskResult<T>

  Returns void

StaticgetInstance

• getInstance<T extends TaskType>(
      taskId: string,
      taskType: T,
      data: TaskData<T>,
  ): TaskContext<T>

  Type Parameters

  • T extends TaskType

  Parameters

  • taskId: string
  • taskType: T
  • data: TaskData<T>

  Returns TaskContext<T>