ISfdmuRunCustomAddonContext | The SFDMU Custom Add-On API

The Custom Add-On module runtime context.

export
interface: ISfdmuRunCustomAddonContext

Hierarchy

ISfdmuRunCustomAddonContext

Index

Properties

description

description: string

The description of the current Add-On module. Defined in the object/[addons] section of the Script, as in the example below:

example

 {      
"description": "This test AddOn manipulates with the source Json string right before the target update. It extracts the Json value from the LongText__c, then stores the extracted string into the TEST1__c." 
}

memberof

ISfdmuRunCustomAddonContext

eventName

eventName: string

The name of the triggered Add-On event.

example

async onExecute(context: ISfdmuRunCustomAddonContext, args: any): Promise<ISfdmuRunCustomAddonResult> { 
     console.log(context.eventName); // For the BeforeUpdate event, outputs 'onBeforeUpdate'
}

memberof

ISfdmuRunCustomAddonContext

moduleDisplayName

moduleDisplayName: string

The name of the current Add-On module, including it's type (core or custom)

example: custom:CustomSfdmuRunAddonTemplate, core:ExportFile
memberof: ISfdmuRunCustomAddonContext

objectDisplayName

objectDisplayName: string

The display name of the processed SF object (typically it's the object label).

example: Account Team Member
memberof: ISfdmuRunCustomAddonContext

objectName

objectName: string

The Api name of the SF object which is being currently processed by the Plugin.

example: AccountTeamMember
memberof: ISfdmuRunCustomAddonContext