Class DatapackDeploymentEvent

constructor

• new DatapackDeploymentEvent(
      deployment: DatapackDeployment,
      recordGroups: DatapackDeploymentRecordGroup[],
  ): DatapackDeploymentEvent

  Parameters

  • deployment: DatapackDeployment

    Deployment that triggered the current event

  • recordGroups: DatapackDeploymentRecordGroup[]

    Record groups for which the event triggered

  Returns DatapackDeploymentEvent

Readonlydeployment

ReadonlyrecordGroups

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?: string | RegExp,
  ): Iterable<DeployedDatapackDeploymentRecord>

  Parameters

  • Optionaltype: 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: string): undefined | DatapackDeploymentRecord

  Parameters

  • id: string

  Returns undefined | DatapackDeploymentRecord

getRecords

• getRecords(type?: string | RegExp): Iterable<DatapackDeploymentRecord>

  Parameters

  • Optionaltype: string | RegExp

  Returns Iterable<DatapackDeploymentRecord>