Class DatapackImportService

Service to import multipacks stored on the org through the Vlocity DataRaptor API.

Hierarchy

DatapackImportService

Index

Constructors

constructor

new DatapackImportService(remoting): DatapackImportService
Parameters
- remoting: VisualforceRemoting
Returns DatapackImportService
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:68

Properties

`Private` `Readonly` remoting

remoting: VisualforceRemoting

Methods

`Private` activateDatapacks

activateDatapacks(deployResult, progress?, cancelationToken?): Promise<DatapackImportProgress>
Parameters
- deployResult: DatapackData
- Optional progress: ImportProgressDelegate
- Optional cancelationToken: CancellationToken
Returns Promise<DatapackImportProgress>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:161

`Private` cancelImport

cancelImport(id): Promise<VisualforceRemotingResponse>
Parameters
- id: string
Returns Promise<VisualforceRemotingResponse>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:133

`Private` getAllDataPackData

getAllDataPackData(id): Promise<DatapackData>
Parameters
- id: string
Returns Promise<DatapackData>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:206

`Private` getMultipackData

getMultipackData(datapackName): Promise<MultipackResource>
Parameters
- datapackName: string
Returns Promise<MultipackResource>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:211

`Private` importMultipack

importMultipack(datapackData, progress?, cancelationToken?): Promise<DatapackImportProgress>
Parameters
- datapackData: MultipackResource
- Optional progress: ImportProgressDelegate
- Optional cancelationToken: CancellationToken
Returns Promise<DatapackImportProgress>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:137

initialize

initialize(vlocityNamespace?): Promise<DatapackImportService>
Parameters
- vlocityNamespace: string = 'vlocity_cmt'
Returns Promise<DatapackImportService>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:71

installMultipack

installMultipack(multipackName, options?): Promise<DatapackImportProgress>
Installs a multipack by its name, optionally filtering the datapacks to import.

This method retrieves the specified multipack, applies an optional filter to its datapacks, imports the filtered datapacks, activates them, and updates their status to 'Complete'.
Parameters
- multipackName: string
  
  The name of the multipack to install.
- Optional options: {
      cancelationToken?: CancellationToken;
      predicate?: ((datapack) => boolean);
      progress?: ImportProgressDelegate;
      skipActivation?: boolean;
  }
  - Optional cancelationToken?: CancellationToken
  - Optional predicate?: ((datapack) => boolean)
    - (datapack): boolean
      
      Parameters
      
      datapack: DatapackInfo
      
      Returns boolean
  - Optional progress?: ImportProgressDelegate
  - Optional skipActivation?: boolean
Returns Promise<DatapackImportProgress>
A promise that resolves to the import progress status of the datapacks.
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:86

`Private` reportProgress

reportProgress(status, progress?): DatapackImportProgress
Parameters
- status: DatapackImportProgress
- Optional progress: ImportProgressDelegate
Returns DatapackImportProgress
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:186

`Private` runActivate

runActivate(id, datapackKeys): Promise<DatapackImportProgress>
Parameters
- id: string
- datapackKeys: string[]
Returns Promise<DatapackImportProgress>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:196

`Private` runImport

runImport(id): Promise<DatapackImportProgress>
Parameters
- id: string
Returns Promise<DatapackImportProgress>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:122

`Private` startImport

startImport(datapackData): Promise<DatapackImportProgress>
Parameters
- datapackData: MultipackResource
Returns Promise<DatapackImportProgress>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:115

`Private` updateDatapackInfo

updateDatapackInfo(id, status): Promise<VisualforceRemotingResponse>
Parameters
- id: string
- status: string
Returns Promise<VisualforceRemotingResponse>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:129

Class DatapackImportService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

remoting: VisualforceRemoting

Returns DatapackImportService

Properties

Private Readonly remoting

Methods

Private activateDatapacks

Parameters

deployResult: DatapackData

Optional progress: ImportProgressDelegate

Optional cancelationToken: CancellationToken

Returns Promise<DatapackImportProgress>

Private cancelImport

Parameters

id: string

Returns Promise<VisualforceRemotingResponse>

Private getAllDataPackData

Parameters

id: string

Returns Promise<DatapackData>

Private getMultipackData

Parameters

datapackName: string

Returns Promise<MultipackResource>

Private importMultipack

Parameters

datapackData: MultipackResource

Optional progress: ImportProgressDelegate

Optional cancelationToken: CancellationToken

Returns Promise<DatapackImportProgress>

initialize

Parameters

vlocityNamespace: string = 'vlocity_cmt'

Returns Promise<DatapackImportService>

installMultipack

Parameters

multipackName: string

Optional options: { cancelationToken?: CancellationToken; predicate?: ((datapack) => boolean); progress?: ImportProgressDelegate; skipActivation?: boolean; }

Optional cancelationToken?: CancellationToken

Optional predicate?: ((datapack) => boolean)

Parameters

datapack: DatapackInfo

Returns boolean

Optional progress?: ImportProgressDelegate

Optional skipActivation?: boolean

Returns Promise<DatapackImportProgress>

Private reportProgress

Parameters

status: DatapackImportProgress

Optional progress: ImportProgressDelegate

Returns DatapackImportProgress

Private runActivate

Parameters

id: string

datapackKeys: string[]

Returns Promise<DatapackImportProgress>

Private runImport

Parameters

id: string

Returns Promise<DatapackImportProgress>

Private startImport

Parameters

datapackData: MultipackResource

Returns Promise<DatapackImportProgress>

Private updateDatapackInfo

Parameters

id: string

status: string

Returns Promise<VisualforceRemotingResponse>

Settings

Member Visibility

Theme

`Private` `Readonly` remoting

`Private` activateDatapacks

`Optional` progress: ImportProgressDelegate

`Optional` cancelationToken: CancellationToken

`Private` cancelImport

`Private` getAllDataPackData

`Private` getMultipackData

`Private` importMultipack

`Optional` progress: ImportProgressDelegate

`Optional` cancelationToken: CancellationToken

`Optional` options: {
cancelationToken?: CancellationToken;
predicate?: ((datapack) => boolean);
progress?: ImportProgressDelegate;
skipActivation?: boolean;
}

`Optional` cancelationToken?: CancellationToken

`Optional` predicate?: ((datapack) => boolean)

`Optional` progress?: ImportProgressDelegate

`Optional` skipActivation?: boolean

`Private` reportProgress

`Optional` progress: ImportProgressDelegate

`Private` runActivate

`Private` runImport

`Private` startImport

`Private` updateDatapackInfo