Interface ISfdmuRunCustomAddonResult

The class returned from the onExecute method. The Add-On can interact with the parent process by returning this object back to the caller.

Export

Interface

ISfdmuRunCustomAddonResult

Hierarchy

  • ISfdmuRunCustomAddonResult

Properties

Properties

cancel: boolean

Set this property to true will abort the current Plugin job. Use this property if you want to interrupt the migration process after finishing the Add-On execution.

Example

async onExecute(context: ISfdmuRunCustomAddonContext, args: any): Promise<ISfdmuRunCustomAddonResult> { 
// Return cancel = true if you want to abort the current miration job.
return { cancel: true };
}

Memberof

ISfdmuRunCustomAddonResult

Generated using TypeDoc  |  SFDMU Help Center  |  View on Github