Class Task

constructor

• new Task(): Task

  Returns Task

Readonlyid

Readonlyrequest

ReadonlytaskName

addStream

• addStream(name: string, file: unknown): void

  Parameters

  • name: string
  • file: unknown

  Returns void

detailsUpdate

• detailsUpdate(detailsUpdateCallback: (details: unknown) => void): Task

  Parameters

  • detailsUpdateCallback: (details: unknown) => void

  Returns Task

error

• error(errorCallback: (error: unknown, response: unknown) => void): Task

  Parameters

  • errorCallback: (error: unknown, response: unknown) => void

  Returns Task

exec

• exec(): void

  Returns void

execAsPromise

• execAsPromise(returnResponse?: boolean): Promise<unknown>

  Parameters

  • OptionalreturnResponse: boolean

    true: resolve with the whole response instead of its result

  Returns Promise<unknown>

live

• live(key?: string): Task

  A never-finishing subscription: issued again (new id, same input and handlers) after every reconnect. key: for a subscription the server allows once per session; a later live task with the same key replaces it.

  Parameters

  • Optionalkey: string

  Returns Task

log

• log(levels: string[], logCallback: (level: string, log: unknown) => void): Task

  Parameters

  • levels: string[]
  • logCallback: (level: string, log: unknown) => void

  Returns Task

metricDefinitionUpdate

• metricDefinitionUpdate(
      keys: string[],
      metricDefinitinUpdateCallback: (metricDefinition: unknown) => void,
  ): Task

  Parameters

  • keys: string[]
  • metricDefinitinUpdateCallback: (metricDefinition: unknown) => void

  Returns Task

metricUpdate

• metricUpdate(
      keys: string[],
      metricUpdateCallback: (metricUpdate: unknown) => void,
  ): Task

  Parameters

  • keys: string[]
  • metricUpdateCallback: (metricUpdate: unknown) => void

  Returns Task

newBinaryData

• newBinaryData(topicIds: string[], dataListener: (data: unknown) => void): Task

  Parameters

  • topicIds: string[]
  • dataListener: (data: unknown) => void

  Returns Task

newData

• newData(topicIds: string[], dataListener: (data: unknown) => void): Task

  Parameters

  • topicIds: string[]
  • dataListener: (data: unknown) => void

  Returns Task

progress

• progress(progressCallback: (label: string, progress: number) => void): Task

  Parameters

  • progressCallback: (label: string, progress: number) => void

  Returns Task

reissued

• reissued(callback: (task: Task) => void): Task

  Called just before a live task is issued again: clear what the previous snapshot filled.

  Parameters

  • callback: (task: Task) => void

  Returns Task

send

• send(topicId: string, message: unknown): void

  Parameters

  • topicId: string
  • message: unknown

  Returns void

setNodeId

• setNodeId(nodeId: string): Task

  Parameters

  • nodeId: string

  Returns Task

setTimeOut

• setTimeOut(value: number, unit: string): Task

  Parameters

  • value: number
  • unit: string

  Returns Task

statusChange

• statusChange(
      statusses: string[],
      statusChangeCallback: (status: string) => void,
  ): Task

  Parameters

  • statusses: string[]
  • statusChangeCallback: (status: string) => void

  Returns Task

success

• success(successCallback: (result: unknown, fullresponse: unknown) => void): Task

  Parameters

  • successCallback: (result: unknown, fullresponse: unknown) => void

  Returns Task

taskInfo

• taskInfo(taskInfoCallback: (taskInfo: unknown) => void): Task

  Parameters

  • taskInfoCallback: (taskInfo: unknown) => void

  Returns Task

terminate

• terminate(): void

  Returns void