Class FlexCardActivator

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

Hierarchy

FlexCardActivator

Index

Constructors

constructor

new FlexCardActivator(salesforceService, lwcCompiler, lookup, 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, options?): 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
- Optional options: 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, options?): Promise<void>
Activate the LWC component for the specified FlexCard regardless of the script is LWC enabled or not.
Parameters
- input: FlexCardIdentifier
- Optional options: Omit<FlexCardActivationOptions, "skipLwc">
Returns Promise<void>
- Defined in packages/vlocity-deploy/src/flexCard/flexCardActivator.ts:100

activateRecord

activateRecord(card): 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, options?): 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
- Optional options: 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, options?): Promise<void>
Parameters
- card: FlexCardDefinition
- Optional options: FlexCardCompileOptions
Returns Promise<void>
- Defined in packages/vlocity-deploy/src/flexCard/flexCardActivator.ts:134

`Private` deployLwcWithToolingApi

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

getMetadataPackage

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

`Private` upsertToolingRecord

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

Class FlexCardActivator

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

salesforceService: SalesforceService

lwcCompiler: FlexCardLwcCompiler

lookup: FlexCardDefinitionAccess

logger: Logger

Returns FlexCardActivator

Properties

Private Readonly logger

Private Readonly lookup

Private Readonly lwcCompiler

Private Readonly salesforceService

Methods

activate

Parameters

input: FlexCardDefinition | FlexCardIdentifier

Optional options: FlexCardActivationOptions

Returns Promise<void>

activateLwc

Parameters

input: FlexCardIdentifier

Optional options: Omit<FlexCardActivationOptions, "skipLwc">

Returns Promise<void>

activateRecord

Parameters

card: FlexCardDefinition

Returns Promise<void>

Throws

Private deployLwc

Parameters

card: FlexCardDefinition

Optional options: Omit<FlexCardActivationOptions, "skipLwc">

Returns Promise<void>

Private deployLwcWithMetadataApi

Parameters

card: FlexCardDefinition

Optional options: FlexCardCompileOptions

Returns Promise<void>

Private deployLwcWithToolingApi

Parameters

card: FlexCardDefinition

Optional options: FlexCardCompileOptions & { toolingApiTimeout?: number; }

Returns Promise<void>

getMetadataPackage

Parameters

input: FlexCardIdentifier

Returns Promise<SalesforcePackage>

Private upsertToolingRecord

Parameters

type: string

toolingRecord: { FullName: string; Id?: string; Metadata: any; }

FullName: string

Optional Id?: string

Metadata: any

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

Settings

Member Visibility

Theme

On This Page

`Private` `Readonly` logger

`Private` `Readonly` lookup

`Private` `Readonly` lwcCompiler

`Private` `Readonly` salesforceService

`Optional` options: FlexCardActivationOptions

`Optional` options: Omit<FlexCardActivationOptions, "skipLwc">

`Private` deployLwc

`Optional` options: Omit<FlexCardActivationOptions, "skipLwc">

`Private` deployLwcWithMetadataApi

`Optional` options: FlexCardCompileOptions

`Private` deployLwcWithToolingApi

`Optional` options: FlexCardCompileOptions & {
toolingApiTimeout?: number;
}

`Private` upsertToolingRecord

toolingRecord: {
FullName: string;
Id?: string;
Metadata: any;
}

`Optional` Id?: string

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