Class DatapackDeploymentEvent

constructor

• new DatapackDeploymentEvent(deployment, recordGroups): DatapackDeploymentEvent

• Parameters

  • deployment: DatapackDeployment

    Deployment that triggered the current event

  • recordGroups: DatapackDeploymentRecordGroup[]

    Record groups for which the event triggered

  Returns DatapackDeploymentEvent

Readonly deployment

Readonly recordGroups

deployedRecords

• get deployedRecords(): DeployedDatapackDeploymentRecord[]

• Flat list of all records that have been successfully deployed or skipped due to being up to date

  Returns DeployedDatapackDeploymentRecord[]

records

• get records(): DatapackDeploymentRecord[]

• Flat list of all records across all record groups for which this event triggered

  Returns DatapackDeploymentRecord[]

getDeployedRecords

• getDeployedRecords(type?): Iterable<DeployedDatapackDeploymentRecord>

• Parameters

  • Optional type: string | RegExp

  Returns Iterable<DeployedDatapackDeploymentRecord>

getDeployedRecordsBySObjectType

• getDeployedRecordsBySObjectType(): [string, DeployedDatapackDeploymentRecord[]][]

• Get deployed records grouped by the record SObject type

  Returns [string, DeployedDatapackDeploymentRecord[]][]

  an iterable array where index 0 is the SObjectType

getRecordById

• getRecordById(id): undefined | DatapackDeploymentRecord

• Parameters

  • id: string

  Returns undefined | DatapackDeploymentRecord

getRecords

• getRecords(type?): Iterable<DatapackDeploymentRecord>

• Parameters

  • Optional type: string | RegExp

  Returns Iterable<DatapackDeploymentRecord>