Interface ImmediateActions

This interface gives access to the immediate actions available to the current user. Those are long running tasks on the server. Internal use only.

Hierarchy

ImmediateActions

Index

Methods

Cancel ExecuteExternalTool

Methods

Cancel

Cancel(identifier, callback): void
Cancels a running process by id.
Parameters
- identifier: string
  
  The id to cancel.
- callback: (() => void)
  
  Is triggered once the cancel request has been sent.
  - - (): void
    - Returns void
Returns void

ExecuteExternalTool

ExecuteExternalTool(executableType, executableParameters, callback): void
Starts an internal tool by name.
Parameters
- executableType: string
  
  The name of the internal tool.
- executableParameters: Record<string, object>
  
  The parameters to pass to the tool.
- callback: ((result) => void)
  
  The callback with the information of the process.
  - - (result): void
    - Parameters
      
      result: ImmediateActionResult
      
      Returns void
Returns void

Generated using TypeDoc