Class Task

constructor

• new Task(): Task

• Returns Task

Readonlyid

ReadonlynodeId

Readonlyrequest

ReadonlytaskName

addStream

• addStream(name, file): void

• Parameters

  • name: string
  • file: unknown

  Returns void

detailsUpdate

• detailsUpdate(detailsUpdateCallback): Task

• Parameters

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

      • Parameters

        • details: unknown

        Returns void

  Returns Task

error

• error(errorCallback): Task

• Parameters

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

      • Parameters

        • error: unknown
        • response: unknown

        Returns void

  Returns Task

exec

• exec(): void

• Returns void

execAsPromise

• execAsPromise(returnResponse): Promise<unknown>

• Parameters

  • returnResponse: boolean

  Returns Promise<unknown>

log

• log(levels, logCallback): Task

• Parameters

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

      • Parameters

        • level: string
        • log: unknown

        Returns void

  Returns Task

metricDefinitionUpdate

• metricDefinitionUpdate(keys, metricDefinitinUpdateCallback): Task

• Parameters

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

      • Parameters

        • metricDefinition: unknown

        Returns void

  Returns Task

metricUpdate

• metricUpdate(keys, metricUpdateCallback): Task

• Parameters

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

      • Parameters

        • metricUpdate: unknown

        Returns void

  Returns Task

newBinaryData

• newBinaryData(topicIds, dataListener): Task

• Parameters

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

      • Parameters

        • data: unknown

        Returns void

  Returns Task

newData

• newData(topicIds, dataListener): Task

• Parameters

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

      • Parameters

        • data: unknown

        Returns void

  Returns Task

progress

• progress(progressCallback): Task

• Parameters

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

      • Parameters

        • label: string
        • progress: number

        Returns void

  Returns Task

send

• send(topicId, message): void

• Parameters

  • topicId: string
  • message: unknown

  Returns void

setNodeId

• setNodeId(nodeId): Task

• Parameters

  • nodeId: string

  Returns Task

setTimeOut

• setTimeOut(value, unit): Task

• Parameters

  • value: number
  • unit: string

  Returns Task

statusChange

• statusChange(statusses, statusChangeCallback): Task

• Parameters

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

      • Parameters

        • status: string

        Returns void

  Returns Task

success

• success(successCallback): Task

• Parameters

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

      • Parameters

        • result: unknown
        • fullresponse: unknown

        Returns void

  Returns Task

taskInfo

• taskInfo(taskInfoCallback): Task

• Parameters

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

      • Parameters

        • taskInfo: unknown

        Returns void

  Returns Task

terminate

• terminate(): void

• Returns void