Class FlexCardActivator

Activates an FlexCard creating compiled FlexCardDefinition__c records in Salesforce and sets the script state to active.

Index

Constructors

constructor

new FlexCardActivator(
    salesforceService: SalesforceService,
    lwcCompiler: FlexCardLwcCompiler,
    lookup: FlexCardDefinitionAccess,
    logger: Logger,
): FlexCardActivator
Parameters
- salesforceService: SalesforceService
- lwcCompiler: FlexCardLwcCompiler
- lookup: FlexCardDefinitionAccess
- logger: Logger
Returns FlexCardActivator
- Defined in packages/vlocity-deploy/src/flexCard/flexCardActivator.ts:34

Properties

`Private` `Readonly`logger

logger: Logger

`Private` `Readonly`lookup

lookup: FlexCardDefinitionAccess

`Private` `Readonly`lwcCompiler

lwcCompiler: FlexCardLwcCompiler

`Private` `Readonly`salesforceService

salesforceService: SalesforceService

Methods

activate

activate(
input: FlexCardDefinition | FlexCardIdentifier,
options?: FlexCardActivationOptions,
): Promise<void>
Activates the specified FlexCard, update the status to activated and deploys the LWC component to the org.
Parameters
- input: FlexCardDefinition | FlexCardIdentifier
  FlexCard to activate
- Optionaloptions: FlexCardActivationOptions
  Extra options that control how the script is activated
Returns Promise<void>
- Defined in packages/vlocity-deploy/src/flexCard/flexCardActivator.ts:47

activateLwc

activateLwc(
input: FlexCardIdentifier,
options?: Omit<FlexCardActivationOptions, "skipLwc">,
): Promise<void>
Activate the LWC component for the specified FlexCard regardless of the script is LWC enabled or not.
Parameters
- input: FlexCardIdentifier
  Id or FlexCard descriptor of the FlexCard for which to activate the LWC component
- Optionaloptions: Omit<FlexCardActivationOptions, "skipLwc">
Returns Promise<void>
- Defined in packages/vlocity-deploy/src/flexCard/flexCardActivator.ts:100

activateRecord

activateRecord(card: FlexCardDefinition): Promise<void>
Activates a FlexCard definition in Salesforce.

This method performs the following steps:
1. Finds any currently active cards with the same name as the target card
2. Deactivates those cards to prevent activation conflicts
3. Activates the target card
4. Updates the card's IsActive property to reflect the new state
Parameters
- card: FlexCardDefinition
  The FlexCard definition to activate
Returns Promise<void>
Throws
Error if the activation of the target card fails
- Defined in packages/vlocity-deploy/src/flexCard/flexCardActivator.ts:73

`Private`deployLwc

deployLwc(
card: FlexCardDefinition,
options?: Omit<FlexCardActivationOptions, "skipLwc">,
): Promise<void>
Generate the LWC component bundlen for the specified FlexCard definition and deploy it to the org.
Parameters
- card: FlexCardDefinition
  Definition of the FlexCard to deploy
- Optionaloptions: Omit<FlexCardActivationOptions, "skipLwc">
  Extra options that control how the script is activated
Returns Promise<void>
- Defined in packages/vlocity-deploy/src/flexCard/flexCardActivator.ts:120

`Private`deployLwcWithMetadataApi

deployLwcWithMetadataApi(
card: FlexCardDefinition,
options?: FlexCardCompileOptions,
): Promise<void>
Parameters
- card: FlexCardDefinition
- Optionaloptions: FlexCardCompileOptions
Returns Promise<void>
- Defined in packages/vlocity-deploy/src/flexCard/flexCardActivator.ts:134

`Private`deployLwcWithToolingApi

deployLwcWithToolingApi(
card: FlexCardDefinition,
options?: FlexCardCompileOptions & { toolingApiTimeout?: number },
): Promise<void>
Parameters
- card: FlexCardDefinition
- Optionaloptions: FlexCardCompileOptions & { toolingApiTimeout?: number }
Returns Promise<void>
- Defined in packages/vlocity-deploy/src/flexCard/flexCardActivator.ts:143

getMetadataPackage

getMetadataPackage(input: FlexCardIdentifier): Promise<SalesforcePackage>
Get the LWC component bundle as metadata package for the specified FlexCard
Parameters
- input: FlexCardIdentifier
  Id or FlexCard descriptor of the FlexCard
Returns Promise<SalesforcePackage>
Deployable Metadata package
- Defined in packages/vlocity-deploy/src/flexCard/flexCardActivator.ts:110

`Private`upsertToolingRecord

upsertToolingRecord(
type: string,
toolingRecord: { FullName: string; Id?: string; Metadata: any },
): Promise<{ errors: string[]; success: boolean }>
Parameters
- type: string
- toolingRecord: { FullName: string; Id?: string; Metadata: any }
Returns Promise<{ errors: string[]; success: boolean }>
- Defined in packages/vlocity-deploy/src/flexCard/flexCardActivator.ts:155

Class FlexCardActivator

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlexCardActivator

Properties

Private Readonlylogger

Private Readonlylookup

Private ReadonlylwcCompiler

Private ReadonlysalesforceService

Methods

activate

Parameters

Returns Promise<void>

activateLwc

Parameters

Returns Promise<void>

activateRecord

Parameters

Returns Promise<void>

Throws

PrivatedeployLwc

Parameters

Returns Promise<void>

PrivatedeployLwcWithMetadataApi

Parameters

Returns Promise<void>

PrivatedeployLwcWithToolingApi

Parameters

Returns Promise<void>

getMetadataPackage

Parameters

Returns Promise<SalesforcePackage>

PrivateupsertToolingRecord

Parameters

Returns Promise<{ errors: string[]; success: boolean }>

Settings

On This Page

`Private` `Readonly`logger

`Private` `Readonly`lookup

`Private` `Readonly`lwcCompiler

`Private` `Readonly`salesforceService

`Private`deployLwc

`Private`deployLwcWithMetadataApi

`Private`deployLwcWithToolingApi

`Private`upsertToolingRecord